com.pulumi.awsnative.secretsmanager.kotlin.Secret.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.outputs.Tag
import com.pulumi.awsnative.secretsmanager.kotlin.outputs.SecretGenerateSecretString
import com.pulumi.awsnative.secretsmanager.kotlin.outputs.SecretReplicaRegion
import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import com.pulumi.awsnative.kotlin.outputs.Tag.Companion.toKotlin as tagToKotlin
import com.pulumi.awsnative.secretsmanager.kotlin.outputs.SecretGenerateSecretString.Companion.toKotlin as secretGenerateSecretStringToKotlin
import com.pulumi.awsnative.secretsmanager.kotlin.outputs.SecretReplicaRegion.Companion.toKotlin as secretReplicaRegionToKotlin
/**
* Builder for [Secret].
*/
@PulumiTagMarker
public class SecretResourceBuilder internal constructor() {
public var name: String? = null
public var args: SecretArgs = SecretArgs()
public var opts: CustomResourceOptions = CustomResourceOptions()
/**
* @param name The _unique_ name of the resulting resource.
*/
public fun name(`value`: String) {
this.name = value
}
/**
* @param block The arguments to use to populate this resource's properties.
*/
public suspend fun args(block: suspend SecretArgsBuilder.() -> Unit) {
val builder = SecretArgsBuilder()
block(builder)
this.args = builder.build()
}
/**
* @param block A bag of options that control this resource's behavior.
*/
public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
}
internal fun build(): Secret {
val builtJavaResource = com.pulumi.awsnative.secretsmanager.Secret(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return Secret(builtJavaResource)
}
}
/**
* 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).
*/
public class Secret internal constructor(
override val javaResource: com.pulumi.awsnative.secretsmanager.Secret,
) : KotlinCustomResource(javaResource, SecretMapper) {
/**
* The ARN of the secret.
*/
public val awsId: Output
get() = javaResource.awsId().applyValue({ args0 -> args0 })
/**
* The description of the secret.
*/
public val description: Output?
get() = javaResource.description().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* 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.
*/
public val generateSecretString: Output?
get() = javaResource.generateSecretString().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> secretGenerateSecretStringToKotlin(args0) })
}).orElse(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](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.
*/
public val kmsKeyId: Output?
get() = javaResource.kmsKeyId().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* 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.
*/
public val name: Output?
get() = javaResource.name().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* A custom type that specifies a ``Region`` and the ``KmsKeyId`` for a replica secret.
*/
public val replicaRegions: Output>?
get() = javaResource.replicaRegions().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
secretReplicaRegionToKotlin(args0)
})
})
}).orElse(null)
})
/**
* 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.
*/
public val secretString: Output?
get() = javaResource.secretString().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(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](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 val tags: Output>?
get() = javaResource.tags().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> tagToKotlin(args0) })
})
}).orElse(null)
})
}
public object SecretMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.awsnative.secretsmanager.Secret::class == javaResource::class
override fun map(javaResource: Resource): Secret = Secret(
javaResource as
com.pulumi.awsnative.secretsmanager.Secret,
)
}
/**
* @see [Secret].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [Secret].
*/
public suspend fun secret(name: String, block: suspend SecretResourceBuilder.() -> Unit): Secret {
val builder = SecretResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [Secret].
* @param name The _unique_ name of the resulting resource.
*/
public fun secret(name: String): Secret {
val builder = SecretResourceBuilder()
builder.name(name)
return builder.build()
}