CredentialByVault¶

class oci.opsi.models.CredentialByVault(**kwargs)¶

Bases: oci.opsi.models.credential_details.CredentialDetails

Vault Credential Details to connect to the database.

Attributes

`CREDENTIAL_TYPE_CREDENTIALS_BY_IAM`	str(object=’’) -> str
`CREDENTIAL_TYPE_CREDENTIALS_BY_SOURCE`	str(object=’’) -> str
`CREDENTIAL_TYPE_CREDENTIALS_BY_VAULT`	str(object=’’) -> str
`ROLE_NORMAL`	A constant which can be used with the role property of a CredentialByVault.
`credential_source_name`	[Required] Gets the credential_source_name of this CredentialDetails.
`credential_type`	[Required] Gets the credential_type of this CredentialDetails.
`password_secret_id`	Gets the password_secret_id of this CredentialByVault.
`role`	Gets the role of this CredentialByVault.
`user_name`	Gets the user_name of this CredentialByVault.
`wallet_secret_id`	Gets the wallet_secret_id of this CredentialByVault.

Methods

`__init__`(**kwargs)	Initializes a new CredentialByVault 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_CREDENTIALS_BY_IAM = 'CREDENTIALS_BY_IAM'¶

CREDENTIAL_TYPE_CREDENTIALS_BY_SOURCE = 'CREDENTIALS_BY_SOURCE'¶

CREDENTIAL_TYPE_CREDENTIALS_BY_VAULT = 'CREDENTIALS_BY_VAULT'¶

ROLE_NORMAL = 'NORMAL'¶: A constant which can be used with the role property of a CredentialByVault. This constant has a value of “NORMAL”

__init__(**kwargs)¶

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

Parameters:

credential_source_name (str) – The value to assign to the credential_source_name property of this CredentialByVault.
credential_type (str) – The value to assign to the credential_type property of this CredentialByVault. Allowed values for this property are: “CREDENTIALS_BY_SOURCE”, “CREDENTIALS_BY_VAULT”, “CREDENTIALS_BY_IAM”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
user_name (str) – The value to assign to the user_name property of this CredentialByVault.
password_secret_id (str) – The value to assign to the password_secret_id property of this CredentialByVault.
wallet_secret_id (str) – The value to assign to the wallet_secret_id property of this CredentialByVault.
role (str) – The value to assign to the role property of this CredentialByVault. Allowed values for this property are: “NORMAL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

credential_source_name¶

[Required] Gets the credential_source_name of this CredentialDetails. Credential source name that had been added in Management Agent wallet. This is supplied in the External Database Service.

Returns:	The credential_source_name of this CredentialDetails.
Return type:	str

credential_type¶

[Required] Gets the credential_type of this CredentialDetails. CREDENTIALS_BY_SOURCE is supplied via the External Database Service. CREDENTIALS_BY_VAULT is supplied by secret service to connection PE_COMANAGED_DATABASE and ADB as well. CREDENTIALS_BY_IAM is used db-token to connect only for Autonomous Database.

Allowed values for this property are: “CREDENTIALS_BY_SOURCE”, “CREDENTIALS_BY_VAULT”, “CREDENTIALS_BY_IAM”, ‘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.

password_secret_id¶

Gets the password_secret_id of this CredentialByVault. The secret OCID mapping to the database credentials.

Returns:	The password_secret_id of this CredentialByVault.
Return type:	str

role¶

Gets the role of this CredentialByVault. database user role.

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

Returns:	The role of this CredentialByVault.
Return type:	str

user_name¶

Gets the user_name of this CredentialByVault. database user name.

Returns:	The user_name of this CredentialByVault.
Return type:	str

wallet_secret_id¶

Gets the wallet_secret_id of this CredentialByVault. The OCID of the Secret where the database keystore contents are stored. This is used for TCPS support in BM/VM/ExaCS cases.

Returns:	The wallet_secret_id of this CredentialByVault.
Return type:	str