OracleDbAwsKeyPool¶

class oci.dbmulticloud.models.OracleDbAwsKeyPool(**kwargs)¶

Bases: object

Oracle DB AWS Key Pool is a resource that represents a collection of AWS KMS keys. These keys are used for Oracle Database Transparent Data Encryption (TDE) operations.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a OracleDbAwsKeyPool.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a OracleDbAwsKeyPool.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a OracleDbAwsKeyPool.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a OracleDbAwsKeyPool.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a OracleDbAwsKeyPool.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a OracleDbAwsKeyPool.
`compartment_id`	[Required] Gets the compartment_id of this OracleDbAwsKeyPool.
`defined_tags`	Gets the defined_tags of this OracleDbAwsKeyPool.
`display_name`	Gets the display_name of this OracleDbAwsKeyPool.
`freeform_tags`	Gets the freeform_tags of this OracleDbAwsKeyPool.
`id`	[Required] Gets the id of this OracleDbAwsKeyPool.
`is_multi_region_key_pool`	Gets the is_multi_region_key_pool of this OracleDbAwsKeyPool.
`is_reuse_allowed`	Gets the is_reuse_allowed of this OracleDbAwsKeyPool.
`lifecycle_state`	Gets the lifecycle_state of this OracleDbAwsKeyPool.
`lifecycle_state_details`	Gets the lifecycle_state_details of this OracleDbAwsKeyPool.
`replication_metadata`	Gets the replication_metadata of this OracleDbAwsKeyPool.
`system_tags`	Gets the system_tags of this OracleDbAwsKeyPool.
`time_created`	Gets the time_created of this OracleDbAwsKeyPool.
`time_updated`	Gets the time_updated of this OracleDbAwsKeyPool.

Methods

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

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a OracleDbAwsKeyPool. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a OracleDbAwsKeyPool. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a OracleDbAwsKeyPool. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a OracleDbAwsKeyPool. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a OracleDbAwsKeyPool. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a OracleDbAwsKeyPool. This constant has a value of “UPDATING”

__init__(**kwargs)¶

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

Parameters:

id (str) – The value to assign to the id property of this OracleDbAwsKeyPool.
display_name (str) – The value to assign to the display_name property of this OracleDbAwsKeyPool.
compartment_id (str) – The value to assign to the compartment_id property of this OracleDbAwsKeyPool.
is_reuse_allowed (bool) – The value to assign to the is_reuse_allowed property of this OracleDbAwsKeyPool.
is_multi_region_key_pool (bool) – The value to assign to the is_multi_region_key_pool property of this OracleDbAwsKeyPool.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this OracleDbAwsKeyPool. Allowed values for this property are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_state_details (str) – The value to assign to the lifecycle_state_details property of this OracleDbAwsKeyPool.
replication_metadata (oci.dbmulticloud.models.ReplicationMetadata) – The value to assign to the replication_metadata property of this OracleDbAwsKeyPool.
time_created (datetime) – The value to assign to the time_created property of this OracleDbAwsKeyPool.
time_updated (datetime) – The value to assign to the time_updated property of this OracleDbAwsKeyPool.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this OracleDbAwsKeyPool.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this OracleDbAwsKeyPool.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this OracleDbAwsKeyPool.

compartment_id¶

[Required] Gets the compartment_id of this OracleDbAwsKeyPool. The Compartment OCID that contains this Oracle DB AWS Pool resource.

Returns:	The compartment_id of this OracleDbAwsKeyPool.
Return type:	str

defined_tags¶

Gets the defined_tags of this OracleDbAwsKeyPool. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {“Operations”: {“CostCenter”: “42”}}

Returns:	The defined_tags of this OracleDbAwsKeyPool.
Return type:	dict(str, dict(str, object))

display_name¶

Gets the display_name of this OracleDbAwsKeyPool. The display name of the Oracle DB AWS key pool resource.

Returns:	The display_name of this OracleDbAwsKeyPool.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this OracleDbAwsKeyPool. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {“Department”: “Finance”}

Returns:	The freeform_tags of this OracleDbAwsKeyPool.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this OracleDbAwsKeyPool. The OCID of the DB AWS Key Pool resource.

Returns:	The id of this OracleDbAwsKeyPool.
Return type:	str

is_multi_region_key_pool¶

Gets the is_multi_region_key_pool of this OracleDbAwsKeyPool. Indicates whether this key pool accepts only multi-region AWS KMS keys. When false, the key pool accepts only single-region AWS KMS keys.

Returns:	The is_multi_region_key_pool of this OracleDbAwsKeyPool.
Return type:	bool

is_reuse_allowed¶

Gets the is_reuse_allowed of this OracleDbAwsKeyPool. Indicates whether AWS KMS keys in this key pool can be reused.

Returns:	The is_reuse_allowed of this OracleDbAwsKeyPool.
Return type:	bool

lifecycle_state¶

Gets the lifecycle_state of this OracleDbAwsKeyPool. The lifecycle state of the Oracle DB AWS Key Pool resource.

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

Returns:	The lifecycle_state of this OracleDbAwsKeyPool.
Return type:	str

lifecycle_state_details¶

Gets the lifecycle_state_details of this OracleDbAwsKeyPool. Description of the current lifecycle state in more detail.

Returns:	The lifecycle_state_details of this OracleDbAwsKeyPool.
Return type:	str

replication_metadata¶

Gets the replication_metadata of this OracleDbAwsKeyPool.

Returns:	The replication_metadata of this OracleDbAwsKeyPool.
Return type:	oci.dbmulticloud.models.ReplicationMetadata

system_tags¶

Gets the system_tags of this OracleDbAwsKeyPool. System tags for this resource. Each key is predefined and scoped to a namespace.

Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:	The system_tags of this OracleDbAwsKeyPool.
Return type:	dict(str, dict(str, object))

time_created¶

Gets the time_created of this OracleDbAwsKeyPool. Time when the DB AWS Key Pool resource was created in RFC 3339 timestamp format, e.g. ‘2020-05-23T21:10:29.600Z’.

Returns:	The time_created of this OracleDbAwsKeyPool.
Return type:	datetime

time_updated¶

Gets the time_updated of this OracleDbAwsKeyPool. Time when the DB AWS Key Pool resource was last modified, expressed in RFC 3339 timestamp format, e.g. ‘2020-05-23T21:10:29.600Z’.

Returns:	The time_updated of this OracleDbAwsKeyPool.
Return type:	datetime