com.pulumi.awsnative.secretsmanager.kotlin.SecretArgs.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-aws-native-kotlin Show documentation
Show all versions of pulumi-aws-native-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.awsnative.secretsmanager.kotlin
import com.pulumi.awsnative.kotlin.inputs.TagArgs
import com.pulumi.awsnative.kotlin.inputs.TagArgsBuilder
import com.pulumi.awsnative.secretsmanager.SecretArgs.builder
import com.pulumi.awsnative.secretsmanager.kotlin.inputs.SecretGenerateSecretStringArgs
import com.pulumi.awsnative.secretsmanager.kotlin.inputs.SecretGenerateSecretStringArgsBuilder
import com.pulumi.awsnative.secretsmanager.kotlin.inputs.SecretReplicaRegionArgs
import com.pulumi.awsnative.secretsmanager.kotlin.inputs.SecretReplicaRegionArgsBuilder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.applySuspend
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.jvm.JvmName
/**
* Creates a new secret. A *secret* can be a password, a set of credentials such as a user name and password, an OAuth token, or other secret information that you store in an encrypted form in Secrets Manager.
* For RDS master user credentials, see [AWS::RDS::DBCluster MasterUserSecret](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-masterusersecret.html).
* To retrieve a secret in a CFNshort template, use a *dynamic reference*. For more information, see [Retrieve a secret in an resource](https://docs.aws.amazon.com/secretsmanager/latest/userguide/cfn-example_reference-secret.html).
* A common scenario is to first create a secret with ``GenerateSecretString``, which generates a password, and then use a dynamic reference to retrieve the username and password from the secret to use as credentials for a new database. See the example *Creating a Redshift cluster and a secret for the admin credentials*.
* For information about creating a secret in the console, see [Create a secret](https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_create-basic-secret.html). For information about creating a secret using the CLI or SDK, see [CreateSecret](https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_CreateSecret.html).
* For information about retrieving a secret in code, see [Retrieve secrets from Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieving-secrets.html).
* @property description The description of the secret.
* @property generateSecretString A structure that specifies how to generate a password to encrypt and store in the secret. To include a specific string in the secret, use ``SecretString`` instead. If you omit both ``GenerateSecretString`` and ``SecretString``, you create an empty secret. When you make a change to this property, a new secret version is created.
* We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support.
* @property kmsKeyId 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](https://docs.aws.amazon.com/kms/latest/developerguide/alias-about.html).
* 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.
* @property name The name of the new secret.
* The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@-
* Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN.
* @property replicaRegions A custom type that specifies a ``Region`` and the ``KmsKeyId`` for a replica secret.
* @property secretString The text to encrypt and store in the secret. We recommend you use a JSON structure of key/value pairs for your secret value. To generate a random password, use ``GenerateSecretString`` instead. If you omit both ``GenerateSecretString`` and ``SecretString``, you create an empty secret. When you make a change to this property, a new secret version is created.
* @property tags 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](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#tag-secrets-abac) and [Limit access to identities with tags that match secrets' tags](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#auth-and-access_tags2).
* For information about how to format a JSON parameter for the various command line tool environments, see [Using JSON for Parameters](https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json). 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:
* + Maximum number of tags per secret: 50
* + Maximum key length: 127 Unicode characters in UTF-8
* + Maximum value length: 255 Unicode characters in UTF-8
* + Tag keys and values are case sensitive.
* + Do not use the ``aws:`` prefix in your tag names or values because AWS reserves it for AWS use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
* + If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
*/
public data class SecretArgs(
public val description: Output? = null,
public val generateSecretString: Output? = null,
public val kmsKeyId: Output? = null,
public val name: Output? = null,
public val replicaRegions: Output>? = null,
public val secretString: Output? = null,
public val tags: Output>? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.awsnative.secretsmanager.SecretArgs =
com.pulumi.awsnative.secretsmanager.SecretArgs.builder()
.description(description?.applyValue({ args0 -> args0 }))
.generateSecretString(
generateSecretString?.applyValue({ args0 ->
args0.let({ args0 ->
args0.toJava()
})
}),
)
.kmsKeyId(kmsKeyId?.applyValue({ args0 -> args0 }))
.name(name?.applyValue({ args0 -> args0 }))
.replicaRegions(
replicaRegions?.applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
args0.toJava()
})
})
}),
)
.secretString(secretString?.applyValue({ args0 -> args0 }))
.tags(
tags?.applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
args0.toJava()
})
})
}),
).build()
}
/**
* Builder for [SecretArgs].
*/
@PulumiTagMarker
public class SecretArgsBuilder internal constructor() {
private var description: Output? = null
private var generateSecretString: Output? = null
private var kmsKeyId: Output? = null
private var name: Output? = null
private var replicaRegions: Output>? = null
private var secretString: Output? = null
private var tags: Output>? = null
/**
* @param value The description of the secret.
*/
@JvmName("uttnmajagciamwcq")
public suspend fun description(`value`: Output) {
this.description = value
}
/**
* @param value A structure that specifies how to generate a password to encrypt and store in the secret. To include a specific string in the secret, use ``SecretString`` instead. If you omit both ``GenerateSecretString`` and ``SecretString``, you create an empty secret. When you make a change to this property, a new secret version is created.
* We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support.
*/
@JvmName("xboifeeqxfsdymid")
public suspend fun generateSecretString(`value`: Output) {
this.generateSecretString = value
}
/**
* @param value 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](https://docs.aws.amazon.com/kms/latest/developerguide/alias-about.html).
* 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.
*/
@JvmName("mqciqabwunnvxopq")
public suspend fun kmsKeyId(`value`: Output) {
this.kmsKeyId = value
}
/**
* @param value The name of the new secret.
* The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@-
* Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN.
*/
@JvmName("rmyoslmfdxbiejvm")
public suspend fun name(`value`: Output) {
this.name = value
}
/**
* @param value A custom type that specifies a ``Region`` and the ``KmsKeyId`` for a replica secret.
*/
@JvmName("cdjtstlekbjeulre")
public suspend fun replicaRegions(`value`: Output>) {
this.replicaRegions = value
}
@JvmName("caicembymnkudrqy")
public suspend fun replicaRegions(vararg values: Output) {
this.replicaRegions = Output.all(values.asList())
}
/**
* @param values A custom type that specifies a ``Region`` and the ``KmsKeyId`` for a replica secret.
*/
@JvmName("oxahcspkvgcyektt")
public suspend fun replicaRegions(values: List>) {
this.replicaRegions = Output.all(values)
}
/**
* @param value The text to encrypt and store in the secret. We recommend you use a JSON structure of key/value pairs for your secret value. To generate a random password, use ``GenerateSecretString`` instead. If you omit both ``GenerateSecretString`` and ``SecretString``, you create an empty secret. When you make a change to this property, a new secret version is created.
*/
@JvmName("ocdloensprovucpj")
public suspend fun secretString(`value`: Output) {
this.secretString = value
}
/**
* @param value 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](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#tag-secrets-abac) and [Limit access to identities with tags that match secrets' tags](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#auth-and-access_tags2).
* For information about how to format a JSON parameter for the various command line tool environments, see [Using JSON for Parameters](https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json). 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:
* + Maximum number of tags per secret: 50
* + Maximum key length: 127 Unicode characters in UTF-8
* + Maximum value length: 255 Unicode characters in UTF-8
* + Tag keys and values are case sensitive.
* + Do not use the ``aws:`` prefix in your tag names or values because AWS reserves it for AWS use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
* + If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
*/
@JvmName("itanvryvhqkmknyf")
public suspend fun tags(`value`: Output>) {
this.tags = value
}
@JvmName("cgdhmgxymnxrxdqg")
public suspend fun tags(vararg values: Output) {
this.tags = Output.all(values.asList())
}
/**
* @param values 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](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#tag-secrets-abac) and [Limit access to identities with tags that match secrets' tags](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#auth-and-access_tags2).
* For information about how to format a JSON parameter for the various command line tool environments, see [Using JSON for Parameters](https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json). 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:
* + Maximum number of tags per secret: 50
* + Maximum key length: 127 Unicode characters in UTF-8
* + Maximum value length: 255 Unicode characters in UTF-8
* + Tag keys and values are case sensitive.
* + Do not use the ``aws:`` prefix in your tag names or values because AWS reserves it for AWS use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
* + If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
*/
@JvmName("rpfrsvfxnwtkhjra")
public suspend fun tags(values: List>) {
this.tags = Output.all(values)
}
/**
* @param value The description of the secret.
*/
@JvmName("djrvnifqqysqeihn")
public suspend fun description(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.description = mapped
}
/**
* @param value A structure that specifies how to generate a password to encrypt and store in the secret. To include a specific string in the secret, use ``SecretString`` instead. If you omit both ``GenerateSecretString`` and ``SecretString``, you create an empty secret. When you make a change to this property, a new secret version is created.
* We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support.
*/
@JvmName("ywrcwhtwhybfryhd")
public suspend fun generateSecretString(`value`: SecretGenerateSecretStringArgs?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.generateSecretString = mapped
}
/**
* @param argument A structure that specifies how to generate a password to encrypt and store in the secret. To include a specific string in the secret, use ``SecretString`` instead. If you omit both ``GenerateSecretString`` and ``SecretString``, you create an empty secret. When you make a change to this property, a new secret version is created.
* We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support.
*/
@JvmName("brhhukdqigflmsya")
public suspend fun generateSecretString(argument: suspend SecretGenerateSecretStringArgsBuilder.() -> Unit) {
val toBeMapped = SecretGenerateSecretStringArgsBuilder().applySuspend { argument() }.build()
val mapped = of(toBeMapped)
this.generateSecretString = mapped
}
/**
* @param value 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](https://docs.aws.amazon.com/kms/latest/developerguide/alias-about.html).
* 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.
*/
@JvmName("tpckpkpuvffuohbt")
public suspend fun kmsKeyId(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.kmsKeyId = mapped
}
/**
* @param value The name of the new secret.
* The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@-
* Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN.
*/
@JvmName("yxavricvwuuaoylo")
public suspend fun name(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.name = mapped
}
/**
* @param value A custom type that specifies a ``Region`` and the ``KmsKeyId`` for a replica secret.
*/
@JvmName("bxbaqqosqvguixhd")
public suspend fun replicaRegions(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.replicaRegions = mapped
}
/**
* @param argument A custom type that specifies a ``Region`` and the ``KmsKeyId`` for a replica secret.
*/
@JvmName("buxcfmfekvmkhajy")
public suspend fun replicaRegions(argument: List Unit>) {
val toBeMapped = argument.toList().map {
SecretReplicaRegionArgsBuilder().applySuspend {
it()
}.build()
}
val mapped = of(toBeMapped)
this.replicaRegions = mapped
}
/**
* @param argument A custom type that specifies a ``Region`` and the ``KmsKeyId`` for a replica secret.
*/
@JvmName("vwdnssdbcgvvbqrm")
public suspend fun replicaRegions(vararg argument: suspend SecretReplicaRegionArgsBuilder.() -> Unit) {
val toBeMapped = argument.toList().map {
SecretReplicaRegionArgsBuilder().applySuspend {
it()
}.build()
}
val mapped = of(toBeMapped)
this.replicaRegions = mapped
}
/**
* @param argument A custom type that specifies a ``Region`` and the ``KmsKeyId`` for a replica secret.
*/
@JvmName("onmldsjixslifhek")
public suspend fun replicaRegions(argument: suspend SecretReplicaRegionArgsBuilder.() -> Unit) {
val toBeMapped = listOf(SecretReplicaRegionArgsBuilder().applySuspend { argument() }.build())
val mapped = of(toBeMapped)
this.replicaRegions = mapped
}
/**
* @param values A custom type that specifies a ``Region`` and the ``KmsKeyId`` for a replica secret.
*/
@JvmName("mqcndqdhcpkcxauu")
public suspend fun replicaRegions(vararg values: SecretReplicaRegionArgs) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.replicaRegions = mapped
}
/**
* @param value The text to encrypt and store in the secret. We recommend you use a JSON structure of key/value pairs for your secret value. To generate a random password, use ``GenerateSecretString`` instead. If you omit both ``GenerateSecretString`` and ``SecretString``, you create an empty secret. When you make a change to this property, a new secret version is created.
*/
@JvmName("pmjydblajqqvwbfv")
public suspend fun secretString(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.secretString = mapped
}
/**
* @param value 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](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#tag-secrets-abac) and [Limit access to identities with tags that match secrets' tags](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#auth-and-access_tags2).
* For information about how to format a JSON parameter for the various command line tool environments, see [Using JSON for Parameters](https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json). 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:
* + Maximum number of tags per secret: 50
* + Maximum key length: 127 Unicode characters in UTF-8
* + Maximum value length: 255 Unicode characters in UTF-8
* + Tag keys and values are case sensitive.
* + Do not use the ``aws:`` prefix in your tag names or values because AWS reserves it for AWS use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
* + If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
*/
@JvmName("fnuewmagwbvneoge")
public suspend fun tags(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.tags = mapped
}
/**
* @param argument 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](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#tag-secrets-abac) and [Limit access to identities with tags that match secrets' tags](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#auth-and-access_tags2).
* For information about how to format a JSON parameter for the various command line tool environments, see [Using JSON for Parameters](https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json). 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:
* + Maximum number of tags per secret: 50
* + Maximum key length: 127 Unicode characters in UTF-8
* + Maximum value length: 255 Unicode characters in UTF-8
* + Tag keys and values are case sensitive.
* + Do not use the ``aws:`` prefix in your tag names or values because AWS reserves it for AWS use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
* + If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
*/
@JvmName("pyrmrbbufxenscna")
public suspend fun tags(argument: List Unit>) {
val toBeMapped = argument.toList().map { TagArgsBuilder().applySuspend { it() }.build() }
val mapped = of(toBeMapped)
this.tags = mapped
}
/**
* @param argument 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](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#tag-secrets-abac) and [Limit access to identities with tags that match secrets' tags](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#auth-and-access_tags2).
* For information about how to format a JSON parameter for the various command line tool environments, see [Using JSON for Parameters](https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json). 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:
* + Maximum number of tags per secret: 50
* + Maximum key length: 127 Unicode characters in UTF-8
* + Maximum value length: 255 Unicode characters in UTF-8
* + Tag keys and values are case sensitive.
* + Do not use the ``aws:`` prefix in your tag names or values because AWS reserves it for AWS use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
* + If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
*/
@JvmName("gjdbmljlkuhmdsqf")
public suspend fun tags(vararg argument: suspend TagArgsBuilder.() -> Unit) {
val toBeMapped = argument.toList().map { TagArgsBuilder().applySuspend { it() }.build() }
val mapped = of(toBeMapped)
this.tags = mapped
}
/**
* @param argument 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](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#tag-secrets-abac) and [Limit access to identities with tags that match secrets' tags](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#auth-and-access_tags2).
* For information about how to format a JSON parameter for the various command line tool environments, see [Using JSON for Parameters](https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json). 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:
* + Maximum number of tags per secret: 50
* + Maximum key length: 127 Unicode characters in UTF-8
* + Maximum value length: 255 Unicode characters in UTF-8
* + Tag keys and values are case sensitive.
* + Do not use the ``aws:`` prefix in your tag names or values because AWS reserves it for AWS use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
* + If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
*/
@JvmName("scxwvbpisgiqkdsn")
public suspend fun tags(argument: suspend TagArgsBuilder.() -> Unit) {
val toBeMapped = listOf(TagArgsBuilder().applySuspend { argument() }.build())
val mapped = of(toBeMapped)
this.tags = mapped
}
/**
* @param values 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](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#tag-secrets-abac) and [Limit access to identities with tags that match secrets' tags](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#auth-and-access_tags2).
* For information about how to format a JSON parameter for the various command line tool environments, see [Using JSON for Parameters](https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json). 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:
* + Maximum number of tags per secret: 50
* + Maximum key length: 127 Unicode characters in UTF-8
* + Maximum value length: 255 Unicode characters in UTF-8
* + Tag keys and values are case sensitive.
* + Do not use the ``aws:`` prefix in your tag names or values because AWS reserves it for AWS use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
* + If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
*/
@JvmName("wpoyqqfmtolqhsuy")
public suspend fun tags(vararg values: TagArgs) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.tags = mapped
}
internal fun build(): SecretArgs = SecretArgs(
description = description,
generateSecretString = generateSecretString,
kmsKeyId = kmsKeyId,
name = name,
replicaRegions = replicaRegions,
secretString = secretString,
tags = tags,
)
}