oci.Kms.Key

AutoKeyRotationDetails KeyAutoKeyRotationDetails

The service endpoint to perform management operations against. Management operations include 'Create,' 'Update,' 'List,' 'Get,' and 'Delete' operations. See Vault Management endpoint.

(Updatable) The details of auto rotation schedule for the Key being create updated or imported.

DefinedTags Dictionary<string, string>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

DesiredState string

(Updatable) Desired state of the key. Possible values : ENABLED or DISABLED

ExternalKeyReference KeyExternalKeyReference

A reference to the key on external key manager.

FreeformTags Dictionary<string, string>

(Updatable) 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"}

RestoreFromFile KeyRestoreFromFile

(Updatable) A parameter specifying whether the auto key rotation is enabled or not.

ProtectionMode string

The key's protection mode indicates how the key persists and where cryptographic operations that use the key are performed. A protection mode of HSM means that the key persists on a hardware security module (HSM) and all cryptographic operations are performed inside the HSM. A protection mode of SOFTWARE means that the key persists on the server, protected by the vault's RSA wrapping key which persists on the HSM. All cryptographic operations that use a key with a protection mode of SOFTWARE are performed on the server. By default, a key's protection mode is set to HSM. You can't change a key's protection mode after the key is created or imported. A protection mode of EXTERNAL mean that the key persists on the customer's external key manager which is hosted externally outside of oracle. Oracle only hold a reference to that key. All cryptographic operations that use a key with a protection mode of EXTERNAL are performed by external key manager.

(Updatable) Details where key was backed up.

RestoreFromObjectStore KeyRestoreFromObjectStore

(Updatable) Details where key was backed up

KeyShape KeyKeyShapeArgs

(Updatable) An optional property when flipped triggers restore from restore option provided in config file.

TimeOfDeletion string

(Updatable) An optional property for the deletion time of the key, expressed in RFC 3339 timestamp format. Example: 2019-04-03T21:10:29.600Z

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

CompartmentId string

(Updatable) The OCID of the compartment where you want to create the master encryption key.

DisplayName string

(Updatable) A user-friendly name for the key. It does not have to be unique, and it is changeable. Avoid entering confidential information.

The cryptographic properties of a key.

AutoKeyRotationDetails KeyAutoKeyRotationDetailsArgs

The service endpoint to perform management operations against. Management operations include 'Create,' 'Update,' 'List,' 'Get,' and 'Delete' operations. See Vault Management endpoint.

(Updatable) The details of auto rotation schedule for the Key being create updated or imported.

DefinedTags map[string]string

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

DesiredState string

(Updatable) Desired state of the key. Possible values : ENABLED or DISABLED

ExternalKeyReference KeyExternalKeyReferenceArgs

A reference to the key on external key manager.

FreeformTags map[string]string

RestoreFromFile KeyRestoreFromFileArgs

(Updatable) A parameter specifying whether the auto key rotation is enabled or not.

ProtectionMode string

(Updatable) Details where key was backed up.

RestoreFromObjectStore KeyRestoreFromObjectStoreArgs

(Updatable) Details where key was backed up

(Updatable) An optional property when flipped triggers restore from restore option provided in config file.

TimeOfDeletion string

(Updatable) An optional property for the deletion time of the key, expressed in RFC 3339 timestamp format. Example: 2019-04-03T21:10:29.600Z

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

compartmentId String

(Updatable) The OCID of the compartment where you want to create the master encryption key.

displayName String

(Updatable) A user-friendly name for the key. It does not have to be unique, and it is changeable. Avoid entering confidential information.

The cryptographic properties of a key.

autoKeyRotationDetails KeyAutoKeyRotationDetails

The service endpoint to perform management operations against. Management operations include 'Create,' 'Update,' 'List,' 'Get,' and 'Delete' operations. See Vault Management endpoint.

(Updatable) The details of auto rotation schedule for the Key being create updated or imported.

definedTags Map<String,String>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

desiredState String

(Updatable) Desired state of the key. Possible values : ENABLED or DISABLED

A reference to the key on external key manager.

freeformTags Map<String,String>

(Updatable) A parameter specifying whether the auto key rotation is enabled or not.

protectionMode String

restoreFromObjectStore KeyRestoreFromObjectStore

(Updatable) Details where key was backed up.

(Updatable) Details where key was backed up

restoreTrigger Boolean

(Updatable) An optional property when flipped triggers restore from restore option provided in config file.

timeOfDeletion String

(Updatable) An optional property for the deletion time of the key, expressed in RFC 3339 timestamp format. Example: 2019-04-03T21:10:29.600Z

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

compartmentId string

(Updatable) The OCID of the compartment where you want to create the master encryption key.

displayName string

(Updatable) A user-friendly name for the key. It does not have to be unique, and it is changeable. Avoid entering confidential information.

autoKeyRotationDetails KeyAutoKeyRotationDetails

The cryptographic properties of a key.

managementEndpoint string

The service endpoint to perform management operations against. Management operations include 'Create,' 'Update,' 'List,' 'Get,' and 'Delete' operations. See Vault Management endpoint.

(Updatable) The details of auto rotation schedule for the Key being create updated or imported.

definedTags {[key: string]: string}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

desiredState string

(Updatable) Desired state of the key. Possible values : ENABLED or DISABLED

A reference to the key on external key manager.

freeformTags {[key: string]: string}

isAutoRotationEnabled boolean

(Updatable) A parameter specifying whether the auto key rotation is enabled or not.

protectionMode string

restoreFromObjectStore KeyRestoreFromObjectStore

(Updatable) Details where key was backed up.

(Updatable) Details where key was backed up

restoreTrigger boolean

(Updatable) An optional property when flipped triggers restore from restore option provided in config file.

timeOfDeletion string

(Updatable) An optional property for the deletion time of the key, expressed in RFC 3339 timestamp format. Example: 2019-04-03T21:10:29.600Z

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

compartment_id str

(Updatable) The OCID of the compartment where you want to create the master encryption key.

display_name str

(Updatable) A user-friendly name for the key. It does not have to be unique, and it is changeable. Avoid entering confidential information.

key_shape KeyKeyShapeArgs

The cryptographic properties of a key.

management_endpoint str

The service endpoint to perform management operations against. Management operations include 'Create,' 'Update,' 'List,' 'Get,' and 'Delete' operations. See Vault Management endpoint.

auto_key_rotation_details KeyAutoKeyRotationDetailsArgs

(Updatable) The details of auto rotation schedule for the Key being create updated or imported.

defined_tags Mapping[str, str]

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

desired_state str

(Updatable) Desired state of the key. Possible values : ENABLED or DISABLED

external_key_reference KeyExternalKeyReferenceArgs

A reference to the key on external key manager.

freeform_tags Mapping[str, str]

is_auto_rotation_enabled bool

(Updatable) A parameter specifying whether the auto key rotation is enabled or not.

protection_mode str

restore_from_file KeyRestoreFromFileArgs

(Updatable) Details where key was backed up.

restore_from_object_store KeyRestoreFromObjectStoreArgs

(Updatable) Details where key was backed up

restore_trigger bool

(Updatable) An optional property when flipped triggers restore from restore option provided in config file.

time_of_deletion str

(Updatable) An optional property for the deletion time of the key, expressed in RFC 3339 timestamp format. Example: 2019-04-03T21:10:29.600Z

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

compartmentId String

(Updatable) The OCID of the compartment where you want to create the master encryption key.

displayName String

(Updatable) A user-friendly name for the key. It does not have to be unique, and it is changeable. Avoid entering confidential information.

keyShape Property Map

The cryptographic properties of a key.

autoKeyRotationDetails Property Map

The service endpoint to perform management operations against. Management operations include 'Create,' 'Update,' 'List,' 'Get,' and 'Delete' operations. See Vault Management endpoint.

(Updatable) The details of auto rotation schedule for the Key being create updated or imported.

definedTags Map<String>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

desiredState String

(Updatable) Desired state of the key. Possible values : ENABLED or DISABLED

externalKeyReference Property Map

A reference to the key on external key manager.

freeformTags Map<String>

restoreFromFile Property Map

(Updatable) A parameter specifying whether the auto key rotation is enabled or not.

protectionMode String

(Updatable) Details where key was backed up.

restoreFromObjectStore Property Map

(Updatable) Details where key was backed up

restoreTrigger Boolean

(Updatable) An optional property when flipped triggers restore from restore option provided in config file.

timeOfDeletion String

(Updatable) An optional property for the deletion time of the key, expressed in RFC 3339 timestamp format. Example: 2019-04-03T21:10:29.600Z

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

Outputs

All input properties are implicitly available as output properties. Additionally, the Key resource produces the following output properties:

CurrentKeyVersion string: The OCID of the key version used in cryptographic operations. During key rotation, the service might be in a transitional state where this or a newer key version are used intermittently. The currentKeyVersion property is updated when the service is guaranteed to use the new key version for all subsequent encryption operations.
ExternalKeyReferenceDetails List<KeyExternalKeyReferenceDetail>: Key reference data to be returned to the customer as a response.
Id string: The provider-assigned unique ID for this managed resource.
IsPrimary bool: A Boolean value that indicates whether the Key belongs to primary Vault or replica vault.
ReplicaDetails List<KeyReplicaDetail>: Key replica details
RestoredFromKeyId string: The OCID of the key from which this key was restored.
State string: The key's current lifecycle state. Example: ENABLED
TimeCreated string: The date and time the key was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
VaultId string: The OCID of the vault that contains this key.

CurrentKeyVersion string: The OCID of the key version used in cryptographic operations. During key rotation, the service might be in a transitional state where this or a newer key version are used intermittently. The currentKeyVersion property is updated when the service is guaranteed to use the new key version for all subsequent encryption operations.
ExternalKeyReferenceDetails []KeyExternalKeyReferenceDetail: Key reference data to be returned to the customer as a response.
Id string: The provider-assigned unique ID for this managed resource.
IsPrimary bool: A Boolean value that indicates whether the Key belongs to primary Vault or replica vault.
ReplicaDetails []KeyReplicaDetail: Key replica details
RestoredFromKeyId string: The OCID of the key from which this key was restored.
State string: The key's current lifecycle state. Example: ENABLED
TimeCreated string: The date and time the key was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
VaultId string: The OCID of the vault that contains this key.

currentKeyVersion String: The OCID of the key version used in cryptographic operations. During key rotation, the service might be in a transitional state where this or a newer key version are used intermittently. The currentKeyVersion property is updated when the service is guaranteed to use the new key version for all subsequent encryption operations.
externalKeyReferenceDetails List<KeyExternalKeyReferenceDetail>: Key reference data to be returned to the customer as a response.
id String: The provider-assigned unique ID for this managed resource.
isPrimary Boolean: A Boolean value that indicates whether the Key belongs to primary Vault or replica vault.
replicaDetails List<KeyReplicaDetail>: Key replica details
restoredFromKeyId String: The OCID of the key from which this key was restored.
state String: The key's current lifecycle state. Example: ENABLED
timeCreated String: The date and time the key was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
vaultId String: The OCID of the vault that contains this key.

currentKeyVersion string: The OCID of the key version used in cryptographic operations. During key rotation, the service might be in a transitional state where this or a newer key version are used intermittently. The currentKeyVersion property is updated when the service is guaranteed to use the new key version for all subsequent encryption operations.
externalKeyReferenceDetails KeyExternalKeyReferenceDetail[]: Key reference data to be returned to the customer as a response.
id string: The provider-assigned unique ID for this managed resource.
isPrimary boolean: A Boolean value that indicates whether the Key belongs to primary Vault or replica vault.
replicaDetails KeyReplicaDetail[]: Key replica details
restoredFromKeyId string: The OCID of the key from which this key was restored.
state string: The key's current lifecycle state. Example: ENABLED
timeCreated string: The date and time the key was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
vaultId string: The OCID of the vault that contains this key.

current_key_version str: The OCID of the key version used in cryptographic operations. During key rotation, the service might be in a transitional state where this or a newer key version are used intermittently. The currentKeyVersion property is updated when the service is guaranteed to use the new key version for all subsequent encryption operations.
external_key_reference_details Sequence[KeyExternalKeyReferenceDetail]: Key reference data to be returned to the customer as a response.
id str: The provider-assigned unique ID for this managed resource.
is_primary bool: A Boolean value that indicates whether the Key belongs to primary Vault or replica vault.
replica_details Sequence[KeyReplicaDetail]: Key replica details
restored_from_key_id str: The OCID of the key from which this key was restored.
state str: The key's current lifecycle state. Example: ENABLED
time_created str: The date and time the key was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
vault_id str: The OCID of the vault that contains this key.

currentKeyVersion String: The OCID of the key version used in cryptographic operations. During key rotation, the service might be in a transitional state where this or a newer key version are used intermittently. The currentKeyVersion property is updated when the service is guaranteed to use the new key version for all subsequent encryption operations.
externalKeyReferenceDetails List<Property Map>: Key reference data to be returned to the customer as a response.
id String: The provider-assigned unique ID for this managed resource.
isPrimary Boolean: A Boolean value that indicates whether the Key belongs to primary Vault or replica vault.
replicaDetails List<Property Map>: Key replica details
restoredFromKeyId String: The OCID of the key from which this key was restored.
state String: The key's current lifecycle state. Example: ENABLED
timeCreated String: The date and time the key was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
vaultId String: The OCID of the vault that contains this key.

Look up Existing Key Resource

Get an existing Key resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: KeyState, opts?: CustomResourceOptions): Key

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auto_key_rotation_details: Optional[KeyAutoKeyRotationDetailsArgs] = None,
        compartment_id: Optional[str] = None,
        current_key_version: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        desired_state: Optional[str] = None,
        display_name: Optional[str] = None,
        external_key_reference: Optional[KeyExternalKeyReferenceArgs] = None,
        external_key_reference_details: Optional[Sequence[KeyExternalKeyReferenceDetailArgs]] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        is_auto_rotation_enabled: Optional[bool] = None,
        is_primary: Optional[bool] = None,
        key_shape: Optional[KeyKeyShapeArgs] = None,
        management_endpoint: Optional[str] = None,
        protection_mode: Optional[str] = None,
        replica_details: Optional[Sequence[KeyReplicaDetailArgs]] = None,
        restore_from_file: Optional[KeyRestoreFromFileArgs] = None,
        restore_from_object_store: Optional[KeyRestoreFromObjectStoreArgs] = None,
        restore_trigger: Optional[bool] = None,
        restored_from_key_id: Optional[str] = None,
        state: Optional[str] = None,
        time_created: Optional[str] = None,
        time_of_deletion: Optional[str] = None,
        vault_id: Optional[str] = None) -> Key

func GetKey(ctx *Context, name string, id IDInput, state *KeyState, opts ...ResourceOption) (*Key, error)

public static Key Get(string name, Input<string> id, KeyState? state, CustomResourceOptions? opts = null)

public static Key get(String name, Output<String> id, KeyState state, CustomResourceOptions options)

resources:  _:    type: oci:Kms:Key    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AutoKeyRotationDetails KeyAutoKeyRotationDetails

(Updatable) The details of auto rotation schedule for the Key being create updated or imported.

CompartmentId string

(Updatable) The OCID of the compartment where you want to create the master encryption key.

CurrentKeyVersion string

The OCID of the key version used in cryptographic operations. During key rotation, the service might be in a transitional state where this or a newer key version are used intermittently. The currentKeyVersion property is updated when the service is guaranteed to use the new key version for all subsequent encryption operations.

DefinedTags Dictionary<string, string>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

DesiredState string

(Updatable) Desired state of the key. Possible values : ENABLED or DISABLED

DisplayName string

(Updatable) A user-friendly name for the key. It does not have to be unique, and it is changeable. Avoid entering confidential information.

ExternalKeyReference KeyExternalKeyReference

A reference to the key on external key manager.

ExternalKeyReferenceDetails List<KeyExternalKeyReferenceDetail>

Key reference data to be returned to the customer as a response.

FreeformTags Dictionary<string, string>

(Updatable) A parameter specifying whether the auto key rotation is enabled or not.

IsPrimary bool

A Boolean value that indicates whether the Key belongs to primary Vault or replica vault.

KeyShape KeyKeyShape

The cryptographic properties of a key.

ReplicaDetails List<KeyReplicaDetail>

The service endpoint to perform management operations against. Management operations include 'Create,' 'Update,' 'List,' 'Get,' and 'Delete' operations. See Vault Management endpoint.

ProtectionMode string

Key replica details

RestoreFromFile KeyRestoreFromFile

(Updatable) Details where key was backed up.

RestoreFromObjectStore KeyRestoreFromObjectStore

(Updatable) Details where key was backed up

AutoKeyRotationDetails KeyAutoKeyRotationDetailsArgs

(Updatable) An optional property when flipped triggers restore from restore option provided in config file.

RestoredFromKeyId string

The OCID of the key from which this key was restored.

State string

The key's current lifecycle state. Example: ENABLED

TimeCreated string

The date and time the key was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

TimeOfDeletion string

(Updatable) An optional property for the deletion time of the key, expressed in RFC 3339 timestamp format. Example: 2019-04-03T21:10:29.600Z

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

VaultId string

The OCID of the vault that contains this key.

(Updatable) The details of auto rotation schedule for the Key being create updated or imported.

CompartmentId string

(Updatable) The OCID of the compartment where you want to create the master encryption key.

CurrentKeyVersion string

DefinedTags map[string]string

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

DesiredState string

(Updatable) Desired state of the key. Possible values : ENABLED or DISABLED

DisplayName string

(Updatable) A user-friendly name for the key. It does not have to be unique, and it is changeable. Avoid entering confidential information.

ExternalKeyReference KeyExternalKeyReferenceArgs

A reference to the key on external key manager.

ExternalKeyReferenceDetails []KeyExternalKeyReferenceDetailArgs

Key reference data to be returned to the customer as a response.

FreeformTags map[string]string

KeyShape KeyKeyShapeArgs

(Updatable) A parameter specifying whether the auto key rotation is enabled or not.

IsPrimary bool

A Boolean value that indicates whether the Key belongs to primary Vault or replica vault.

The cryptographic properties of a key.

ReplicaDetails []KeyReplicaDetailArgs

The service endpoint to perform management operations against. Management operations include 'Create,' 'Update,' 'List,' 'Get,' and 'Delete' operations. See Vault Management endpoint.

ProtectionMode string

Key replica details

RestoreFromFile KeyRestoreFromFileArgs

(Updatable) Details where key was backed up.

RestoreFromObjectStore KeyRestoreFromObjectStoreArgs

(Updatable) Details where key was backed up

autoKeyRotationDetails KeyAutoKeyRotationDetails

(Updatable) An optional property when flipped triggers restore from restore option provided in config file.

RestoredFromKeyId string

The OCID of the key from which this key was restored.

State string

The key's current lifecycle state. Example: ENABLED

TimeCreated string

The date and time the key was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

TimeOfDeletion string

(Updatable) An optional property for the deletion time of the key, expressed in RFC 3339 timestamp format. Example: 2019-04-03T21:10:29.600Z

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

VaultId string

The OCID of the vault that contains this key.

(Updatable) The details of auto rotation schedule for the Key being create updated or imported.

compartmentId String

(Updatable) The OCID of the compartment where you want to create the master encryption key.

currentKeyVersion String

definedTags Map<String,String>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

desiredState String

(Updatable) Desired state of the key. Possible values : ENABLED or DISABLED

displayName String

(Updatable) A user-friendly name for the key. It does not have to be unique, and it is changeable. Avoid entering confidential information.

externalKeyReferenceDetails List<KeyExternalKeyReferenceDetail>

A reference to the key on external key manager.

Key reference data to be returned to the customer as a response.

freeformTags Map<String,String>

(Updatable) A parameter specifying whether the auto key rotation is enabled or not.

isPrimary Boolean

A Boolean value that indicates whether the Key belongs to primary Vault or replica vault.

The cryptographic properties of a key.

replicaDetails List<KeyReplicaDetail>

The service endpoint to perform management operations against. Management operations include 'Create,' 'Update,' 'List,' 'Get,' and 'Delete' operations. See Vault Management endpoint.

protectionMode String

Key replica details

restoreFromObjectStore KeyRestoreFromObjectStore

(Updatable) Details where key was backed up.

(Updatable) Details where key was backed up

restoreTrigger Boolean

(Updatable) An optional property when flipped triggers restore from restore option provided in config file.

restoredFromKeyId String

The OCID of the key from which this key was restored.

state String

The key's current lifecycle state. Example: ENABLED

timeCreated String

The date and time the key was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

timeOfDeletion String

(Updatable) An optional property for the deletion time of the key, expressed in RFC 3339 timestamp format. Example: 2019-04-03T21:10:29.600Z

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

vaultId String

The OCID of the vault that contains this key.

autoKeyRotationDetails KeyAutoKeyRotationDetails

(Updatable) The details of auto rotation schedule for the Key being create updated or imported.

compartmentId string

(Updatable) The OCID of the compartment where you want to create the master encryption key.

currentKeyVersion string

definedTags {[key: string]: string}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

desiredState string

(Updatable) Desired state of the key. Possible values : ENABLED or DISABLED

displayName string

(Updatable) A user-friendly name for the key. It does not have to be unique, and it is changeable. Avoid entering confidential information.

externalKeyReferenceDetails KeyExternalKeyReferenceDetail[]

A reference to the key on external key manager.

Key reference data to be returned to the customer as a response.

freeformTags {[key: string]: string}

isAutoRotationEnabled boolean

(Updatable) A parameter specifying whether the auto key rotation is enabled or not.

isPrimary boolean

A Boolean value that indicates whether the Key belongs to primary Vault or replica vault.

replicaDetails KeyReplicaDetail[]

The cryptographic properties of a key.

managementEndpoint string

The service endpoint to perform management operations against. Management operations include 'Create,' 'Update,' 'List,' 'Get,' and 'Delete' operations. See Vault Management endpoint.

protectionMode string

Key replica details

restoreFromObjectStore KeyRestoreFromObjectStore

(Updatable) Details where key was backed up.

(Updatable) Details where key was backed up

restoreTrigger boolean

(Updatable) An optional property when flipped triggers restore from restore option provided in config file.

restoredFromKeyId string

The OCID of the key from which this key was restored.

state string

The key's current lifecycle state. Example: ENABLED

timeCreated string

The date and time the key was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

timeOfDeletion string

(Updatable) An optional property for the deletion time of the key, expressed in RFC 3339 timestamp format. Example: 2019-04-03T21:10:29.600Z

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

vaultId string

The OCID of the vault that contains this key.

auto_key_rotation_details KeyAutoKeyRotationDetailsArgs

(Updatable) The details of auto rotation schedule for the Key being create updated or imported.

compartment_id str

(Updatable) The OCID of the compartment where you want to create the master encryption key.

current_key_version str

defined_tags Mapping[str, str]

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

desired_state str

(Updatable) Desired state of the key. Possible values : ENABLED or DISABLED

display_name str

(Updatable) A user-friendly name for the key. It does not have to be unique, and it is changeable. Avoid entering confidential information.

external_key_reference KeyExternalKeyReferenceArgs

A reference to the key on external key manager.

external_key_reference_details Sequence[KeyExternalKeyReferenceDetailArgs]

Key reference data to be returned to the customer as a response.

freeform_tags Mapping[str, str]

is_auto_rotation_enabled bool

(Updatable) A parameter specifying whether the auto key rotation is enabled or not.

is_primary bool

A Boolean value that indicates whether the Key belongs to primary Vault or replica vault.

key_shape KeyKeyShapeArgs

The cryptographic properties of a key.

management_endpoint str

The service endpoint to perform management operations against. Management operations include 'Create,' 'Update,' 'List,' 'Get,' and 'Delete' operations. See Vault Management endpoint.

protection_mode str

replica_details Sequence[KeyReplicaDetailArgs]

Key replica details

restore_from_file KeyRestoreFromFileArgs

(Updatable) Details where key was backed up.

restore_from_object_store KeyRestoreFromObjectStoreArgs

(Updatable) Details where key was backed up

restore_trigger bool

(Updatable) An optional property when flipped triggers restore from restore option provided in config file.

restored_from_key_id str

The OCID of the key from which this key was restored.

state str

The key's current lifecycle state. Example: ENABLED

time_created str

The date and time the key was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

time_of_deletion str

(Updatable) An optional property for the deletion time of the key, expressed in RFC 3339 timestamp format. Example: 2019-04-03T21:10:29.600Z

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

vault_id str

The OCID of the vault that contains this key.

autoKeyRotationDetails Property Map

(Updatable) The details of auto rotation schedule for the Key being create updated or imported.

compartmentId String

(Updatable) The OCID of the compartment where you want to create the master encryption key.

currentKeyVersion String

definedTags Map<String>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

desiredState String

(Updatable) Desired state of the key. Possible values : ENABLED or DISABLED

displayName String

(Updatable) A user-friendly name for the key. It does not have to be unique, and it is changeable. Avoid entering confidential information.

externalKeyReference Property Map

A reference to the key on external key manager.

externalKeyReferenceDetails List<Property Map>

Key reference data to be returned to the customer as a response.

freeformTags Map<String>

keyShape Property Map

(Updatable) A parameter specifying whether the auto key rotation is enabled or not.

isPrimary Boolean

A Boolean value that indicates whether the Key belongs to primary Vault or replica vault.

The cryptographic properties of a key.