OracleDbAwsKey¶

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

Bases: object

Oracle DB AWS Key Resource object.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a OracleDbAwsKey.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a OracleDbAwsKey.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a OracleDbAwsKey.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a OracleDbAwsKey.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a OracleDbAwsKey.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a OracleDbAwsKey.
`aws_account_id`	Gets the aws_account_id of this OracleDbAwsKey.
`aws_key_arn`	Gets the aws_key_arn of this OracleDbAwsKey.
`compartment_id`	[Required] Gets the compartment_id of this OracleDbAwsKey.
`defined_tags`	Gets the defined_tags of this OracleDbAwsKey.
`display_name`	Gets the display_name of this OracleDbAwsKey.
`freeform_tags`	Gets the freeform_tags of this OracleDbAwsKey.
`id`	[Required] Gets the id of this OracleDbAwsKey.
`is_aws_key_enabled`	Gets the is_aws_key_enabled of this OracleDbAwsKey.
`lifecycle_state`	Gets the lifecycle_state of this OracleDbAwsKey.
`lifecycle_state_details`	Gets the lifecycle_state_details of this OracleDbAwsKey.
`location`	Gets the location of this OracleDbAwsKey.
`oracle_db_connector_id`	Gets the oracle_db_connector_id of this OracleDbAwsKey.
`properties`	Gets the properties of this OracleDbAwsKey.
`system_tags`	Gets the system_tags of this OracleDbAwsKey.
`time_created`	Gets the time_created of this OracleDbAwsKey.
`time_updated`	Gets the time_updated of this OracleDbAwsKey.
`type`	Gets the type of this OracleDbAwsKey.

Methods

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

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

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

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

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

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

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

__init__(**kwargs)¶

Initializes a new OracleDbAwsKey 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 OracleDbAwsKey.
oracle_db_connector_id (str) – The value to assign to the oracle_db_connector_id property of this OracleDbAwsKey.
display_name (str) – The value to assign to the display_name property of this OracleDbAwsKey.
aws_key_arn (str) – The value to assign to the aws_key_arn property of this OracleDbAwsKey.
aws_account_id (str) – The value to assign to the aws_account_id property of this OracleDbAwsKey.
compartment_id (str) – The value to assign to the compartment_id property of this OracleDbAwsKey.
type (str) – The value to assign to the type property of this OracleDbAwsKey.
is_aws_key_enabled (bool) – The value to assign to the is_aws_key_enabled property of this OracleDbAwsKey.
location (str) – The value to assign to the location property of this OracleDbAwsKey.
properties (dict(str, str)) – The value to assign to the properties property of this OracleDbAwsKey.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this OracleDbAwsKey. 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 OracleDbAwsKey.
time_created (datetime) – The value to assign to the time_created property of this OracleDbAwsKey.
time_updated (datetime) – The value to assign to the time_updated property of this OracleDbAwsKey.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this OracleDbAwsKey.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this OracleDbAwsKey.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this OracleDbAwsKey.

aws_account_id¶

Gets the aws_account_id of this OracleDbAwsKey. AWS Account ID.

Returns:	The aws_account_id of this OracleDbAwsKey.
Return type:	str

aws_key_arn¶

Gets the aws_key_arn of this OracleDbAwsKey. Amazon resource name of AWS Key.

Returns:	The aws_key_arn of this OracleDbAwsKey.
Return type:	str

compartment_id¶

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

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

defined_tags¶

Gets the defined_tags of this OracleDbAwsKey. 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 OracleDbAwsKey.
Return type:	dict(str, dict(str, object))

display_name¶

Gets the display_name of this OracleDbAwsKey. Oracle DB AWS Key Ring resource name.

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

freeform_tags¶

Gets the freeform_tags of this OracleDbAwsKey. 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 OracleDbAwsKey.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this OracleDbAwsKey. The OCID of the DB AWS Key Ring resource.

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

is_aws_key_enabled¶

Gets the is_aws_key_enabled of this OracleDbAwsKey. The Oracle AWS Key resource is enabled or disabled at AWS.

Returns:	The is_aws_key_enabled of this OracleDbAwsKey.
Return type:	bool

lifecycle_state¶

Gets the lifecycle_state of this OracleDbAwsKey. The lifecycle state of the Oracle DB AWS Key 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 OracleDbAwsKey.
Return type:	str

lifecycle_state_details¶

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

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

location¶

Gets the location of this OracleDbAwsKey. AWS Key resource location.

Returns:	The location of this OracleDbAwsKey.
Return type:	str

oracle_db_connector_id¶

Gets the oracle_db_connector_id of this OracleDbAwsKey. The OCID of the Oracle DB Connector resource.

Returns:	The oracle_db_connector_id of this OracleDbAwsKey.
Return type:	str

properties¶

Gets the properties of this OracleDbAwsKey. AWS Key resource’s properties.

Returns:	The properties of this OracleDbAwsKey.
Return type:	dict(str, str)

system_tags¶

Gets the system_tags of this OracleDbAwsKey. 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 OracleDbAwsKey.
Return type:	dict(str, dict(str, object))

time_created¶

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

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

time_updated¶

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

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

type¶

Gets the type of this OracleDbAwsKey. Key resource type.

Returns:	The type of this OracleDbAwsKey.
Return type:	str