GetSecretResult

data class GetSecretResult(val description: String? = null, val id: String? = null, val kmsKeyId: String? = null, val replicaRegions: List<SecretReplicaRegion>? = null, val tags: List<Tag>? = null)

Constructors

Link copied to clipboard
constructor(description: String? = null, id: String? = null, kmsKeyId: String? = null, replicaRegions: List<SecretReplicaRegion>? = null, tags: List<Tag>? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val description: String? = null

The description of the secret.

Link copied to clipboard
val id: String? = null

The ARN of the secret.

Link copied to clipboard
val kmsKeyId: String? = null

The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt the secret value in the secret. An alias is always prefixed by `alias/`, for example `alias/aws/secretsmanager`. For more information, see About aliases. To use a KMS key in a different account, use the key ARN or the alias ARN. If you don't specify this value, then Secrets Manager uses the key `aws/secretsmanager`. If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value. If the secret is in a different AWS account from the credentials calling the API, then you can't use `aws/secretsmanager` to encrypt the secret, and you must create and use a customer managed KMS key.

Link copied to clipboard

A custom type that specifies a `Region` and the `KmsKeyId` for a replica secret.

Link copied to clipboard
val tags: List<Tag>? = null

A list of tags to attach to the secret. Each tag is a key and value pair of strings in a JSON text string, for example: `[{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}]` Secrets Manager tag key names are case sensitive. A tag with the key "ABC" is a different tag from one with key "abc". Stack-level tags, tags you apply to the CloudFormation stack, are also attached to the secret. If you check tags in permissions policies as part of your security strategy, then adding or removing a tag can change permissions. If the completion of this operation would result in you losing your permissions for this secret, then Secrets Manager blocks the operation and returns an `Access Denied` error. For more information, see Control access to secrets using tags and Limit access to identities with tags that match secrets' tags. For information about how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters. If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text. The following restrictions apply to tags: