Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace UpdateSecretDetails

Details for updating a secret.

Properties

Optional currentVersionNumber

currentVersionNumber: undefined | number

Details to update the secret version of the specified secret. The secret contents, version number, and rules can't be specified at the same time. Updating the secret contents automatically creates a new secret version. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional definedTags

definedTags: undefined | object

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

Optional description

description: undefined | string

A brief description of the secret. Avoid entering confidential information.

Optional enableAutoGeneration

enableAutoGeneration: undefined | false | true

The value of this flag determines whether or not secret content will be generated automatically.

Optional freeformTags

freeformTags: undefined | object

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: {@code {"Department": "Finance"}}

Optional metadata

metadata: undefined | object

Additional metadata that you can use to provide context about how to use the secret or during rotation or other administrative tasks. For example, for a secret that you use to connect to a database, the additional metadata might specify the connection endpoint and the connection string. Provide additional metadata as key-value pairs.

Optional rotationConfig

rotationConfig: model.RotationConfig

Optional secretContent

secretContent: model.Base64SecretContentDetails

Optional secretGenerationContext

Optional secretRules

secretRules: Array<SecretRule>

A list of rules to control how the secret is used and managed.

Functions

getDeserializedJsonObj

getJsonObj