Package software.amazon.awscdk.services.secretsmanager

Class CfnSecret

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.secretsmanager.CfnSecret
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:41.260Z") @Stability(Stable) public class CfnSecret extends CfnResource implements IInspectable
A CloudFormation AWS::SecretsManager::Secret.

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 Amazon RDS master user credentials, see AWS::RDS::DBCluster MasterUserSecret .

To retrieve a secret in a CloudFormation template, use a dynamic reference . For more information, see Retrieve a secret in an AWS CloudFormation 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. Follow these steps, as shown in the examples below:

  • Define the secret without referencing the service or database. You can't reference the service or database because it doesn't exist yet. The secret must contain a username and password.
  • Next, define the service or database. Include the reference to the secret to use stored credentials to define the database admin user and password.
  • Finally, define a SecretTargetAttachment resource type to finish configuring the secret with the required database engine type and the connection details of the service or database. The rotation function requires the details, if you attach one later by defining a AWS::SecretsManager::RotationSchedule resource type.

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 .

Do not create a dynamic reference using a backslash (\) as the final value. AWS CloudFormation cannot resolve those references, which causes a resource failure.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.secretsmanager.*;
 CfnSecret cfnSecret = CfnSecret.Builder.create(this, "MyCfnSecret")
         .description("description")
         .generateSecretString(GenerateSecretStringProperty.builder()
                 .excludeCharacters("excludeCharacters")
                 .excludeLowercase(false)
                 .excludeNumbers(false)
                 .excludePunctuation(false)
                 .excludeUppercase(false)
                 .generateStringKey("generateStringKey")
                 .includeSpace(false)
                 .passwordLength(123)
                 .requireEachIncludedType(false)
                 .secretStringTemplate("secretStringTemplate")
                 .build())
         .kmsKeyId("kmsKeyId")
         .name("name")
         .replicaRegions(List.of(ReplicaRegionProperty.builder()
                 .region("region")
                 // the properties below are optional
                 .kmsKeyId("kmsKeyId")
                 .build()))
         .secretString("secretString")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnSecret

      protected CfnSecret(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnSecret

      protected CfnSecret(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnSecret

      @Stability(Stable) public CfnSecret(@NotNull Construct scope, @NotNull String id, @Nullable CfnSecretProps props)
      Create a new AWS::SecretsManager::Secret.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.

    • CfnSecret

      @Stability(Stable) public CfnSecret(@NotNull Construct scope, @NotNull String id)
      Create a new AWS::SecretsManager::Secret.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The ARN of the secret.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      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".

      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:

      • 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: + - = . _ : / @.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the secret.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the secret.

    • getGenerateSecretString

      @Stability(Stable) @Nullable public Object getGenerateSecretString()
      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.

    • setGenerateSecretString

      @Stability(Stable) public void setGenerateSecretString(@Nullable IResolvable 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.

    • setGenerateSecretString

      @Stability(Stable) public void setGenerateSecretString(@Nullable CfnSecret.GenerateSecretStringProperty 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.

    • getKmsKeyId

      @Stability(Stable) @Nullable public String getKmsKeyId()
      The ARN, key ID, or alias of the AWS 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 AWS 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 AWS KMS key.

    • setKmsKeyId

      @Stability(Stable) public void setKmsKeyId(@Nullable String value)
      The ARN, key ID, or alias of the AWS 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 AWS 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 AWS KMS key.

    • getName

      @Stability(Stable) @Nullable public String getName()
      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.

    • setName

      @Stability(Stable) public void setName(@Nullable String 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.

    • getReplicaRegions

      @Stability(Stable) @Nullable public Object getReplicaRegions()
      A custom type that specifies a Region and the KmsKeyId for a replica secret.

    • setReplicaRegions

      @Stability(Stable) public void setReplicaRegions(@Nullable IResolvable value)
      A custom type that specifies a Region and the KmsKeyId for a replica secret.

    • setReplicaRegions

      @Stability(Stable) public void setReplicaRegions(@Nullable List<Object> value)
      A custom type that specifies a Region and the KmsKeyId for a replica secret.

    • getSecretString

      @Stability(Stable) @Nullable public String getSecretString()
      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.

    • setSecretString

      @Stability(Stable) public void setSecretString(@Nullable String 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.