EncryptedCredentials¶

class oci.stack_monitoring.models.EncryptedCredentials(**kwargs)¶

Bases: oci.stack_monitoring.models.monitored_resource_credential.MonitoredResourceCredential

Encrypted credentials [indicated by the type property in CredentialStore].

Attributes

`CREDENTIAL_TYPE_ENCRYPTED`	str(object=’’) -> str
`CREDENTIAL_TYPE_EXISTING`	str(object=’’) -> str
`CREDENTIAL_TYPE_PLAINTEXT`	str(object=’’) -> str
`credential_type`	Gets the credential_type of this MonitoredResourceCredential.
`description`	Gets the description of this MonitoredResourceCredential.
`key_id`	[Required] Gets the key_id of this EncryptedCredentials.
`name`	Gets the name of this MonitoredResourceCredential.
`properties`	[Required] Gets the properties of this EncryptedCredentials.
`source`	Gets the source of this MonitoredResourceCredential.
`type`	Gets the type of this MonitoredResourceCredential.

Methods

`__init__`(**kwargs)	Initializes a new EncryptedCredentials 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_ENCRYPTED = 'ENCRYPTED'¶

CREDENTIAL_TYPE_EXISTING = 'EXISTING'¶

CREDENTIAL_TYPE_PLAINTEXT = 'PLAINTEXT'¶

__init__(**kwargs)¶

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

Parameters:

source (str) – The value to assign to the source property of this EncryptedCredentials.
name (str) – The value to assign to the name property of this EncryptedCredentials.
type (str) – The value to assign to the type property of this EncryptedCredentials.
description (str) – The value to assign to the description property of this EncryptedCredentials.
credential_type (str) – The value to assign to the credential_type property of this EncryptedCredentials. Allowed values for this property are: “EXISTING”, “PLAINTEXT”, “ENCRYPTED”
key_id (str) – The value to assign to the key_id property of this EncryptedCredentials.
properties (list[oci.stack_monitoring.models.CredentialProperty]) – The value to assign to the properties property of this EncryptedCredentials.

credential_type¶

Gets the credential_type of this MonitoredResourceCredential. Type of credentials specified in the credentials element. Three possible values - EXISTING, PLAINTEXT and ENCRYPTED. * EXISTING - Credential is already stored in agent and only credential name need

to be passed for existing credential.

PLAINTEXT - The credential properties will have credentials in plain text format.
ENCRYPTED - The credential properties will have credentials stored in vault in

encrypted format using KMS client which uses master key for encryption. The same master key will be used to decrypt the credentials before passing on to the management agent.

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

Returns:	The credential_type of this MonitoredResourceCredential.
Return type:	str

description¶

Gets the description of this MonitoredResourceCredential. The user-specified textual description of the credential.

Returns:	The description of this MonitoredResourceCredential.
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.

key_id¶

[Required] Gets the key_id of this EncryptedCredentials. The master key should be created in OCI Vault owned by the client of this API. The user should have permission to access the vault key.

Returns:	The key_id of this EncryptedCredentials.
Return type:	str

name¶

Gets the name of this MonitoredResourceCredential. The name of the credential, within the context of the source.

Returns:	The name of this MonitoredResourceCredential.
Return type:	str

properties¶

[Required] Gets the properties of this EncryptedCredentials. The credential properties list. Credential property values will be encrypted format.

Returns:	The properties of this EncryptedCredentials.
Return type:	list[oci.stack_monitoring.models.CredentialProperty]

source¶

Gets the source of this MonitoredResourceCredential. The source type and source name combination, delimited with (.) separator. {source type}.{source name} and source type max char limit is 63.

Returns:	The source of this MonitoredResourceCredential.
Return type:	str

type¶

Gets the type of this MonitoredResourceCredential. The type of the credential ( ex. JMXCreds,DBCreds).

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