Interface ICfnSecretProps
Properties for defining a CfnSecret.
Namespace: Amazon.CDK.AWS.SecretsManager
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnSecretPropsSyntax (vb)
Public Interface ICfnSecretPropsRemarks
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 cfnSecretProps = 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
Properties
| 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. |
Properties
Description
The description of the secret.
string? Description { get; }Property Value
Remarks
GenerateSecretString
A structure that specifies how to generate a password to encrypt and store in the secret.
object? GenerateSecretString { get; }Property Value
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.
string? KmsKeyId { get; }Property Value
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.
string? Name { get; }Property Value
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.
object? ReplicaRegions { get; }Property Value
Remarks
SecretString
The text to encrypt and store in the secret.
string? SecretString { get; }Property Value
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.
ICfnTag[]? Tags { get; }Property Value
ICfnTag[]
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".
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 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:
: .