CustomEncryptionKey¶

class oci.streaming.models.CustomEncryptionKey(**kwargs)¶

Bases: object

Custom Encryption Key which will be used for encryption by all the streams in the pool.

Attributes

`KEY_STATE_ACTIVE`	A constant which can be used with the key_state property of a CustomEncryptionKey.
`KEY_STATE_CREATING`	A constant which can be used with the key_state property of a CustomEncryptionKey.
`KEY_STATE_DELETING`	A constant which can be used with the key_state property of a CustomEncryptionKey.
`KEY_STATE_FAILED`	A constant which can be used with the key_state property of a CustomEncryptionKey.
`KEY_STATE_NONE`	A constant which can be used with the key_state property of a CustomEncryptionKey.
`KEY_STATE_UPDATING`	A constant which can be used with the key_state property of a CustomEncryptionKey.
`key_state`	Gets the key_state of this CustomEncryptionKey.
`kms_key_id`	Gets the kms_key_id of this CustomEncryptionKey.

Methods

__init__(**kwargs) Initializes a new CustomEncryptionKey object with values from keyword arguments.

KEY_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the key_state property of a CustomEncryptionKey. This constant has a value of “ACTIVE”

KEY_STATE_CREATING = 'CREATING'¶: A constant which can be used with the key_state property of a CustomEncryptionKey. This constant has a value of “CREATING”

KEY_STATE_DELETING = 'DELETING'¶: A constant which can be used with the key_state property of a CustomEncryptionKey. This constant has a value of “DELETING”

KEY_STATE_FAILED = 'FAILED'¶: A constant which can be used with the key_state property of a CustomEncryptionKey. This constant has a value of “FAILED”

KEY_STATE_NONE = 'NONE'¶: A constant which can be used with the key_state property of a CustomEncryptionKey. This constant has a value of “NONE”

KEY_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the key_state property of a CustomEncryptionKey. This constant has a value of “UPDATING”

__init__(**kwargs)¶

Initializes a new CustomEncryptionKey object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

kms_key_id (str) – The value to assign to the kms_key_id property of this CustomEncryptionKey.
key_state (str) – The value to assign to the key_state property of this CustomEncryptionKey. Allowed values for this property are: “ACTIVE”, “CREATING”, “DELETING”, “NONE”, “FAILED”, “UPDATING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

key_state¶

Gets the key_state of this CustomEncryptionKey. Life cycle State of the custom key

Allowed values for this property are: “ACTIVE”, “CREATING”, “DELETING”, “NONE”, “FAILED”, “UPDATING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The key_state of this CustomEncryptionKey.
Return type:	str

kms_key_id¶

Gets the kms_key_id of this CustomEncryptionKey. Custom Encryption Key (Master Key) ocid.

Returns:	The kms_key_id of this CustomEncryptionKey.
Return type:	str