SecretBundle

class oci.secrets.models.SecretBundle(**kwargs)

Bases: object

The contents of the secret, properties of the secret (and secret version), and user-provided contextual metadata for the secret.

Attributes:

STAGES_CURRENT

A constant which can be used with the stages property of a SecretBundle.

STAGES_DEPRECATED

A constant which can be used with the stages property of a SecretBundle.

STAGES_LATEST

A constant which can be used with the stages property of a SecretBundle.

STAGES_PENDING

A constant which can be used with the stages property of a SecretBundle.

STAGES_PREVIOUS

A constant which can be used with the stages property of a SecretBundle.

metadata

Gets the metadata of this SecretBundle.

secret_bundle_content

Gets the secret_bundle_content of this SecretBundle.

secret_id

[Required] Gets the secret_id of this SecretBundle.

stages

Gets the stages of this SecretBundle.

time_created

Gets the time_created of this SecretBundle.

time_of_deletion

Gets the time_of_deletion of this SecretBundle.

time_of_expiry

Gets the time_of_expiry of this SecretBundle.

version_name

Gets the version_name of this SecretBundle.

version_number

[Required] Gets the version_number of this SecretBundle.

Methods:

__init__(**kwargs)

Initializes a new SecretBundle object with values from keyword arguments.

STAGES_CURRENT = 'CURRENT'

A constant which can be used with the stages property of a SecretBundle. This constant has a value of “CURRENT”

STAGES_DEPRECATED = 'DEPRECATED'

A constant which can be used with the stages property of a SecretBundle. This constant has a value of “DEPRECATED”

STAGES_LATEST = 'LATEST'

A constant which can be used with the stages property of a SecretBundle. This constant has a value of “LATEST”

STAGES_PENDING = 'PENDING'

A constant which can be used with the stages property of a SecretBundle. This constant has a value of “PENDING”

STAGES_PREVIOUS = 'PREVIOUS'

A constant which can be used with the stages property of a SecretBundle. This constant has a value of “PREVIOUS”

__init__(**kwargs)

Initializes a new SecretBundle object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • secret_id (str) – The value to assign to the secret_id property of this SecretBundle.

  • time_created (datetime) – The value to assign to the time_created property of this SecretBundle.

  • version_number (int) – The value to assign to the version_number property of this SecretBundle.

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

  • secret_bundle_content (oci.secrets.models.SecretBundleContentDetails) – The value to assign to the secret_bundle_content property of this SecretBundle.

  • time_of_deletion (datetime) – The value to assign to the time_of_deletion property of this SecretBundle.

  • time_of_expiry (datetime) – The value to assign to the time_of_expiry property of this SecretBundle.

  • stages (list[str]) – The value to assign to the stages property of this SecretBundle. Allowed values for items in this list are: “CURRENT”, “PENDING”, “LATEST”, “PREVIOUS”, “DEPRECATED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • metadata (dict(str, object)) – The value to assign to the metadata property of this SecretBundle.

property metadata

Gets the metadata of this SecretBundle. Customer-provided contextual metadata for the secret.

Returns

The metadata of this SecretBundle.

Return type

dict(str, object)

property secret_bundle_content

Gets the secret_bundle_content of this SecretBundle.

Returns

The secret_bundle_content of this SecretBundle.

Return type

oci.secrets.models.SecretBundleContentDetails

property secret_id

[Required] Gets the secret_id of this SecretBundle. The OCID of the secret.

Returns

The secret_id of this SecretBundle.

Return type

str

property stages

Gets the stages of this SecretBundle. A list of possible rotation states for the secret version.

Allowed values for items in this list are: “CURRENT”, “PENDING”, “LATEST”, “PREVIOUS”, “DEPRECATED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The stages of this SecretBundle.

Return type

list[str]

property time_created

Gets the time_created of this SecretBundle. The time when the secret bundle was created.

Returns

The time_created of this SecretBundle.

Return type

datetime

property time_of_deletion

Gets the time_of_deletion of this SecretBundle. An optional property indicating when to delete the secret version, expressed in RFC 3339 timestamp format. Example: 2019-04-03T21:10:29.600Z

Returns

The time_of_deletion of this SecretBundle.

Return type

datetime

property time_of_expiry

Gets the time_of_expiry of this SecretBundle. An optional property indicating when the secret version will expire, expressed in RFC 3339 timestamp format. Example: 2019-04-03T21:10:29.600Z

Returns

The time_of_expiry of this SecretBundle.

Return type

datetime

property version_name

Gets the version_name of this SecretBundle. The name of the secret version. Labels are unique across the different versions of a particular secret.

Returns

The version_name of this SecretBundle.

Return type

str

property version_number

[Required] Gets the version_number of this SecretBundle. The version number of the secret.

Returns

The version_number of this SecretBundle.

Return type

int