@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)", date="2022-09-19T20:26:42.025Z") @Stability(value=Stable) public class CfnSecret extends CfnResource implements IInspectable
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.
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:
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();
| Modifier and Type | Class and Description |
|---|---|
static class |
CfnSecret.Builder
A fluent builder for
CfnSecret. |
static interface |
CfnSecret.GenerateSecretStringProperty
Generates a random password.
|
static interface |
CfnSecret.ReplicaRegionProperty
Specifies a `Region` and the `KmsKeyId` for a replica secret.
|
software.amazon.jsii.JsiiObject.InitializationModeIInspectable.Jsii$Default, IInspectable.Jsii$Proxy| Modifier and Type | Field and Description |
|---|---|
static String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
| Modifier | Constructor and Description |
|---|---|
|
CfnSecret(software.constructs.Construct scope,
String id)
Create a new `AWS::SecretsManager::Secret`.
|
|
CfnSecret(software.constructs.Construct scope,
String id,
CfnSecretProps props)
Create a new `AWS::SecretsManager::Secret`.
|
protected |
CfnSecret(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnSecret(software.amazon.jsii.JsiiObjectRef objRef) |
| Modifier and Type | Method and Description |
|---|---|
protected Map<String,Object> |
getCfnProperties() |
String |
getDescription()
The description of the secret.
|
Object |
getGenerateSecretString()
A structure that specifies how to generate a password to encrypt and store in the secret.
|
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.
|
String |
getName()
The name of the new secret.
|
Object |
getReplicaRegions()
A custom type that specifies a `Region` and the `KmsKeyId` for a replica secret.
|
String |
getSecretString()
The text to encrypt and store in the secret.
|
TagManager |
getTags()
A list of tags to attach to the secret.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected Map<String,Object> |
renderProperties(Map<String,Object> props) |
void |
setDescription(String value)
The description of the secret.
|
void |
setGenerateSecretString(CfnSecret.GenerateSecretStringProperty value)
A structure that specifies how to generate a password to encrypt and store in the secret.
|
void |
setGenerateSecretString(IResolvable value)
A structure that specifies how to generate a password to encrypt and store in the secret.
|
void |
setKmsKeyId(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.
|
void |
setName(String value)
The name of the new secret.
|
void |
setReplicaRegions(IResolvable value)
A custom type that specifies a `Region` and the `KmsKeyId` for a replica secret.
|
void |
setReplicaRegions(List<Object> value)
A custom type that specifies a `Region` and the `KmsKeyId` for a replica secret.
|
void |
setSecretString(String value)
The text to encrypt and store in the secret.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validatePropertiesgetRefgetCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdjsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet@Stability(value=Stable) public static final String CFN_RESOURCE_TYPE_NAME
protected CfnSecret(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnSecret(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
@Stability(value=Stable)
public CfnSecret(@NotNull
software.constructs.Construct scope,
@NotNull
String id,
@Nullable
CfnSecretProps props)
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.@Stability(value=Stable)
public CfnSecret(@NotNull
software.constructs.Construct scope,
@NotNull
String id)
scope - - scope in which this resource is defined. This parameter is required.id - - scoped id of the resource. This parameter is required.@Stability(value=Stable)
public void inspect(@NotNull
TreeInspector inspector)
inspect in interface IInspectableinspector - - tree inspector to collect and process attributes. This parameter is required.@Stability(value=Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
renderProperties in class CfnResourceprops - This parameter is required.@Stability(value=Stable) @NotNull protected Map<String,Object> getCfnProperties()
getCfnProperties in class CfnResource@Stability(value=Stable) @NotNull public TagManager getTags()
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:
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.@Stability(value=Stable) @Nullable public String getDescription()
@Stability(value=Stable)
public void setDescription(@Nullable
String value)
@Stability(value=Stable) @Nullable public Object getGenerateSecretString()
Either GenerateSecretString or SecretString must have a value, but not both. They cannot both be empty.
We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support.
@Stability(value=Stable)
public void setGenerateSecretString(@Nullable
CfnSecret.GenerateSecretStringProperty value)
Either GenerateSecretString or SecretString must have a value, but not both. They cannot both be empty.
We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support.
@Stability(value=Stable)
public void setGenerateSecretString(@Nullable
IResolvable value)
Either GenerateSecretString or SecretString must have a value, but not both. They cannot both be empty.
We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support.
@Stability(value=Stable) @Nullable public String getKmsKeyId()
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.
@Stability(value=Stable)
public void setKmsKeyId(@Nullable
String value)
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.
@Stability(value=Stable) @Nullable public String getName()
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.
@Stability(value=Stable)
public void setName(@Nullable
String value)
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.
@Stability(value=Stable) @Nullable public Object getReplicaRegions()
@Stability(value=Stable)
public void setReplicaRegions(@Nullable
IResolvable value)
@Stability(value=Stable)
public void setReplicaRegions(@Nullable
List<Object> value)
@Stability(value=Stable) @Nullable public String getSecretString()
We recommend you use a JSON structure of key/value pairs for your secret value.
Either GenerateSecretString or SecretString must have a value, but not both. They cannot both be empty. We recommend that you use the GenerateSecretString property to generate a random password.
@Stability(value=Stable)
public void setSecretString(@Nullable
String value)
We recommend you use a JSON structure of key/value pairs for your secret value.
Either GenerateSecretString or SecretString must have a value, but not both. They cannot both be empty. We recommend that you use the GenerateSecretString property to generate a random password.
Copyright © 2022. All rights reserved.