KeyStore

class oci.database.models.KeyStore(**kwargs)

Bases: object

A key store to connect to an on-premise encryption key appliance like Oracle Key Vault.

Attributes

LIFECYCLE_STATE_ACTIVE A constant which can be used with the lifecycle_state property of a KeyStore.
LIFECYCLE_STATE_DELETED A constant which can be used with the lifecycle_state property of a KeyStore.
LIFECYCLE_STATE_NEEDS_ATTENTION A constant which can be used with the lifecycle_state property of a KeyStore.
associated_databases Gets the associated_databases of this KeyStore.
compartment_id [Required] Gets the compartment_id of this KeyStore.
defined_tags Gets the defined_tags of this KeyStore.
display_name [Required] Gets the display_name of this KeyStore.
freeform_tags Gets the freeform_tags of this KeyStore.
id [Required] Gets the id of this KeyStore.
lifecycle_details Gets the lifecycle_details of this KeyStore.
lifecycle_state [Required] Gets the lifecycle_state of this KeyStore.
time_created Gets the time_created of this KeyStore.
type_details [Required] Gets the type_details of this KeyStore.

Methods

__init__(**kwargs) Initializes a new KeyStore object with values from keyword arguments.
LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a KeyStore. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a KeyStore. This constant has a value of “DELETED”

LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'

A constant which can be used with the lifecycle_state property of a KeyStore. This constant has a value of “NEEDS_ATTENTION”

__init__(**kwargs)

Initializes a new KeyStore 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 KeyStore.
  • compartment_id (str) – The value to assign to the compartment_id property of this KeyStore.
  • display_name (str) – The value to assign to the display_name property of this KeyStore.
  • time_created (datetime) – The value to assign to the time_created property of this KeyStore.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this KeyStore. Allowed values for this property are: “ACTIVE”, “DELETED”, “NEEDS_ATTENTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • lifecycle_details (str) – The value to assign to the lifecycle_details property of this KeyStore.
  • type_details (oci.database.models.KeyStoreTypeDetails) – The value to assign to the type_details property of this KeyStore.
  • associated_databases (list[oci.database.models.KeyStoreAssociatedDatabaseDetails]) – The value to assign to the associated_databases property of this KeyStore.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this KeyStore.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this KeyStore.
associated_databases

Gets the associated_databases of this KeyStore. List of databases associated with the key store.

Returns:The associated_databases of this KeyStore.
Return type:list[oci.database.models.KeyStoreAssociatedDatabaseDetails]
compartment_id

[Required] Gets the compartment_id of this KeyStore. The OCID of the compartment.

Returns:The compartment_id of this KeyStore.
Return type:str
defined_tags

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

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

[Required] Gets the display_name of this KeyStore. The user-friendly name for the key store. The name does not need to be unique.

Returns:The display_name of this KeyStore.
Return type:str
freeform_tags

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

[Required] Gets the id of this KeyStore. The OCID of the key store.

Returns:The id of this KeyStore.
Return type:str
lifecycle_details

Gets the lifecycle_details of this KeyStore. Additional information about the current lifecycle state.

Returns:The lifecycle_details of this KeyStore.
Return type:str
lifecycle_state

[Required] Gets the lifecycle_state of this KeyStore. The current state of the key store.

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

Returns:The lifecycle_state of this KeyStore.
Return type:str
time_created

Gets the time_created of this KeyStore. The date and time that the key store was created.

Returns:The time_created of this KeyStore.
Return type:datetime
type_details

[Required] Gets the type_details of this KeyStore.

Returns:The type_details of this KeyStore.
Return type:oci.database.models.KeyStoreTypeDetails