Package-level declarations

Types

Link copied to clipboard
class Secret : KotlinCustomResource

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. To retrieve a secret in a CFNshort template, use a dynamic reference. For more information, see Retrieve a secret in an resource. 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. For information about creating a secret using the CLI or SDK, see CreateSecret. For information about retrieving a secret in code, see Retrieve secrets from Secrets Manager.

Link copied to clipboard
data class SecretArgs(val description: Output<String>? = null, val generateSecretString: Output<SecretGenerateSecretStringArgs>? = null, val kmsKeyId: Output<String>? = null, val name: Output<String>? = null, val replicaRegions: Output<List<SecretReplicaRegionArgs>>? = null, val secretString: Output<String>? = null, val tags: Output<List<TagArgs>>? = null) : ConvertibleToJava<SecretArgs>

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. To retrieve a secret in a CFNshort template, use a dynamic reference. For more information, see Retrieve a secret in an resource. 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. For information about creating a secret using the CLI or SDK, see CreateSecret. For information about retrieving a secret in code, see Retrieve secrets from Secrets Manager.

Link copied to clipboard

Builder for SecretArgs.

Link copied to clipboard
object SecretMapper : ResourceMapper<Secret>
Link copied to clipboard

Builder for Secret.

Link copied to clipboard

Functions

Link copied to clipboard
fun secret(name: String): Secret
suspend fun secret(name: String, block: suspend SecretResourceBuilder.() -> Unit): Secret