Class CfnSecret.GenerateSecretStringProperty

Generates a random password.

Inheritance

object

CfnSecret.GenerateSecretStringProperty

Implements

CfnSecret.IGenerateSecretStringProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.SecretsManager

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnSecret.GenerateSecretStringProperty : CfnSecret.IGenerateSecretStringProperty

Syntax (vb)

Public Class CfnSecret.GenerateSecretStringProperty Implements CfnSecret.IGenerateSecretStringProperty

Remarks

We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support.

Required permissions: secretsmanager:GetRandomPassword . For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-generatesecretstring.html

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 generateSecretStringProperty = new GenerateSecretStringProperty {
                 ExcludeCharacters = "excludeCharacters",
                 ExcludeLowercase = false,
                 ExcludeNumbers = false,
                 ExcludePunctuation = false,
                 ExcludeUppercase = false,
                 GenerateStringKey = "generateStringKey",
                 IncludeSpace = false,
                 PasswordLength = 123,
                 RequireEachIncludedType = false,
                 SecretStringTemplate = "secretStringTemplate"
             };

Synopsis

Constructors

GenerateSecretStringProperty()

Generates a random password.

Properties

ExcludeCharacters	A string of the characters that you don't want in the password.
ExcludeLowercase	Specifies whether to exclude lowercase letters from the password.
ExcludeNumbers	Specifies whether to exclude numbers from the password.
ExcludePunctuation	Specifies whether to exclude the following punctuation characters from the password: `!
ExcludeUppercase	Specifies whether to exclude uppercase letters from the password.
GenerateStringKey	The JSON key name for the key/value pair, where the value is the generated password.
IncludeSpace	Specifies whether to include the space character.
PasswordLength	The length of the password.
RequireEachIncludedType	Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation.
SecretStringTemplate	A template that the generated string must match.

Constructors

GenerateSecretStringProperty()

Generates a random password.

public GenerateSecretStringProperty()

Remarks

We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support.

Required permissions: secretsmanager:GetRandomPassword . For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-generatesecretstring.html

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 generateSecretStringProperty = new GenerateSecretStringProperty {
                 ExcludeCharacters = "excludeCharacters",
                 ExcludeLowercase = false,
                 ExcludeNumbers = false,
                 ExcludePunctuation = false,
                 ExcludeUppercase = false,
                 GenerateStringKey = "generateStringKey",
                 IncludeSpace = false,
                 PasswordLength = 123,
                 RequireEachIncludedType = false,
                 SecretStringTemplate = "secretStringTemplate"
             };

Properties

ExcludeCharacters

A string of the characters that you don't want in the password.

public string? ExcludeCharacters { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-generatesecretstring.html#cfn-secretsmanager-secret-generatesecretstring-excludecharacters

ExcludeLowercase

Specifies whether to exclude lowercase letters from the password.

public object? ExcludeLowercase { get; set; }

Property Value

object

Remarks

If you don't include this switch, the password can contain lowercase letters.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-generatesecretstring.html#cfn-secretsmanager-secret-generatesecretstring-excludelowercase

ExcludeNumbers

Specifies whether to exclude numbers from the password.

public object? ExcludeNumbers { get; set; }

Property Value

object

Remarks

If you don't include this switch, the password can contain numbers.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-generatesecretstring.html#cfn-secretsmanager-secret-generatesecretstring-excludenumbers

ExcludePunctuation

Specifies whether to exclude the following punctuation characters from the password: `!

public object? ExcludePunctuation { get; set; }

Property Value

object

Remarks

" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ { | } ~ . If you don't include this switch, the password can contain punctuation.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-generatesecretstring.html#cfn-secretsmanager-secret-generatesecretstring-excludepunctuation

ExcludeUppercase

Specifies whether to exclude uppercase letters from the password.

public object? ExcludeUppercase { get; set; }

Property Value

object

Remarks

If you don't include this switch, the password can contain uppercase letters.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-generatesecretstring.html#cfn-secretsmanager-secret-generatesecretstring-excludeuppercase

GenerateStringKey

The JSON key name for the key/value pair, where the value is the generated password.

public string? GenerateStringKey { get; set; }

Property Value

string

Remarks

This pair is added to the JSON structure specified by the SecretStringTemplate parameter. If you specify this parameter, then you must also specify SecretStringTemplate .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-generatesecretstring.html#cfn-secretsmanager-secret-generatesecretstring-generatestringkey

IncludeSpace

Specifies whether to include the space character.

public object? IncludeSpace { get; set; }

Property Value

object

Remarks

If you include this switch, the password can contain space characters.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-generatesecretstring.html#cfn-secretsmanager-secret-generatesecretstring-includespace

PasswordLength

The length of the password.

public double? PasswordLength { get; set; }

Property Value

double?

Remarks

If you don't include this parameter, the default length is 32 characters.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-generatesecretstring.html#cfn-secretsmanager-secret-generatesecretstring-passwordlength

RequireEachIncludedType

Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation.

public object? RequireEachIncludedType { get; set; }

Property Value

object

Remarks

If you don't include this switch, the password contains at least one of every character type.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-generatesecretstring.html#cfn-secretsmanager-secret-generatesecretstring-requireeachincludedtype

SecretStringTemplate

A template that the generated string must match.

public string? SecretStringTemplate { get; set; }

Property Value

string

Remarks

When you make a change to this property, a new secret version is created.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-secretsmanager-secret-generatesecretstring.html#cfn-secretsmanager-secret-generatesecretstring-secretstringtemplate

Implements

CfnSecret.IGenerateSecretStringProperty