KeyEncryptionCredentialDetails

class oci.fleet_apps_management.models.KeyEncryptionCredentialDetails(**kwargs)

Bases: CredentialDetails

Details for the Credentials that use key encryption.

Attributes:

CREDENTIAL_TYPE_KEY_ENCRYPTION

A constant which can be used with the credential_type property of a CredentialDetails.

CREDENTIAL_TYPE_PLAIN_TEXT

A constant which can be used with the credential_type property of a CredentialDetails.

CREDENTIAL_TYPE_VAULT_SECRET

A constant which can be used with the credential_type property of a CredentialDetails.

credential_type

[Required] Gets the credential_type of this CredentialDetails.

key_id

[Required] Gets the key_id of this KeyEncryptionCredentialDetails.

key_version

Gets the key_version of this KeyEncryptionCredentialDetails.

value

[Required] Gets the value of this KeyEncryptionCredentialDetails.

vault_id

[Required] Gets the vault_id of this KeyEncryptionCredentialDetails.

Methods:

__init__(**kwargs)

Initializes a new KeyEncryptionCredentialDetails object with values from keyword arguments.

get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

CREDENTIAL_TYPE_KEY_ENCRYPTION = 'KEY_ENCRYPTION'

A constant which can be used with the credential_type property of a CredentialDetails. This constant has a value of “KEY_ENCRYPTION”

CREDENTIAL_TYPE_PLAIN_TEXT = 'PLAIN_TEXT'

A constant which can be used with the credential_type property of a CredentialDetails. This constant has a value of “PLAIN_TEXT”

CREDENTIAL_TYPE_VAULT_SECRET = 'VAULT_SECRET'

A constant which can be used with the credential_type property of a CredentialDetails. This constant has a value of “VAULT_SECRET”

__init__(**kwargs)

Initializes a new KeyEncryptionCredentialDetails object with values from keyword arguments. The default value of the credential_type attribute of this class is KEY_ENCRYPTION and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • credential_type (str) – The value to assign to the credential_type property of this KeyEncryptionCredentialDetails. Allowed values for this property are: “PLAIN_TEXT”, “VAULT_SECRET”, “KEY_ENCRYPTION”

  • value (str) – The value to assign to the value property of this KeyEncryptionCredentialDetails.

  • key_id (str) – The value to assign to the key_id property of this KeyEncryptionCredentialDetails.

  • key_version (str) – The value to assign to the key_version property of this KeyEncryptionCredentialDetails.

  • vault_id (str) – The value to assign to the vault_id property of this KeyEncryptionCredentialDetails.

property credential_type

[Required] Gets the credential_type of this CredentialDetails. Credential Type.

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

Returns

The credential_type of this CredentialDetails.

Return type

str

static get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

property key_id

[Required] Gets the key_id of this KeyEncryptionCredentialDetails. OCID for the Vault Key that will be used to encrypt/decrypt the value given.

Returns

The key_id of this KeyEncryptionCredentialDetails.

Return type

str

property key_version

Gets the key_version of this KeyEncryptionCredentialDetails. The Vault Key version.

Returns

The key_version of this KeyEncryptionCredentialDetails.

Return type

str

property value

[Required] Gets the value of this KeyEncryptionCredentialDetails. The value corresponding to the credential.

Returns

The value of this KeyEncryptionCredentialDetails.

Return type

str

property vault_id

[Required] Gets the vault_id of this KeyEncryptionCredentialDetails. OCID for the Vault that will be used to fetch the key to encrypt/decrypt the value given.

Returns

The vault_id of this KeyEncryptionCredentialDetails.

Return type

str