Class CfnSecret
A CloudFormation AWS::SecretsManager::Secret
.
Inherited Members
Namespace: Amazon.CDK.AWS.SecretsManager
Assembly: Amazon.CDK.AWS.SecretsManager.dll
Syntax (csharp)
public class CfnSecret : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnSecret
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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:
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 <code>(\)</code> as the final value. AWS CloudFormation cannot resolve those references, which causes a resource failure.
CloudformationResource: AWS::SecretsManager::Secret
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.SecretsManager;
var cfnSecret = new CfnSecret(this, "MyCfnSecret", new CfnSecretProps {
Description = "description",
GenerateSecretString = new GenerateSecretStringProperty {
ExcludeCharacters = "excludeCharacters",
ExcludeLowercase = false,
ExcludeNumbers = false,
ExcludePunctuation = false,
ExcludeUppercase = false,
GenerateStringKey = "generateStringKey",
IncludeSpace = false,
PasswordLength = 123,
RequireEachIncludedType = false,
SecretStringTemplate = "secretStringTemplate"
},
KmsKeyId = "kmsKeyId",
Name = "name",
ReplicaRegions = new [] { new ReplicaRegionProperty {
Region = "region",
// the properties below are optional
KmsKeyId = "kmsKeyId"
} },
SecretString = "secretString",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnSecret(Construct, String, ICfnSecretProps) | Create a new |
CfnSecret(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnSecret(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrId | The ARN of the secret. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Description | The description of the secret. |
GenerateSecretString | A structure that specifies how to generate a password to encrypt and store in the secret. |
KmsKeyId | The ARN, key ID, or alias of the AWS KMS key that Secrets Manager uses to encrypt the secret value in the secret. |
Name | The name of the new secret. |
ReplicaRegions | A custom type that specifies a |
SecretString | The text to encrypt and store in the secret. |
Tags | A list of tags to attach to the secret. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnSecret(Construct, String, ICfnSecretProps)
Create a new AWS::SecretsManager::Secret
.
public CfnSecret(Construct scope, string id, ICfnSecretProps props = null)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnSecretProps
- resource properties.
CfnSecret(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnSecret(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnSecret(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnSecret(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrId
The ARN of the secret.
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Description
The description of the secret.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
GenerateSecretString
A structure that specifies how to generate a password to encrypt and store in the secret.
public virtual object GenerateSecretString { get; set; }
Property Value
System.Object
Remarks
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.
KmsKeyId
The ARN, key ID, or alias of the AWS KMS key that Secrets Manager uses to encrypt the secret value in the secret.
public virtual string KmsKeyId { get; set; }
Property Value
System.String
Remarks
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.
Name
The name of the new secret.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
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.
ReplicaRegions
A custom type that specifies a Region
and the KmsKeyId
for a replica secret.
public virtual object ReplicaRegions { get; set; }
Property Value
System.Object
Remarks
SecretString
The text to encrypt and store in the secret.
public virtual string SecretString { get; set; }
Property Value
System.String
Remarks
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.
Tags
A list of tags to attach to the secret.
public virtual TagManager Tags { get; }
Property Value
Remarks
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:
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>