Class CfnSecretPropsMixin

Creates a new secret.

Inheritance

object

Mixin

CfnSecretPropsMixin

Implements

IMixin

Inherited Members

Mixin.IsMixin(object)

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.SecretsManager

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public class CfnSecretPropsMixin : Mixin, IMixin

Syntax (vb)

Public Class CfnSecretPropsMixin Inherits Mixin Implements IMixin

Remarks

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 .

For Amazon Redshift admin user credentials, see AWS::Redshift::Cluster .

To retrieve a secret in a CloudFormation template, use a dynamic reference . For more information, see Retrieve a secret in an CloudFormation resource .

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 .

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

CloudformationResource: AWS::SecretsManager::Secret

Mixin: true

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.CfnPropertyMixins.AWS.SecretsManager;
             using Amazon.CDK;

             IMergeStrategy mergeStrategy;

             var cfnSecretPropsMixin = new CfnSecretPropsMixin(new CfnSecretMixinProps {
                 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 {
                     KmsKeyId = "kmsKeyId",
                     Region = "region"
                 } },
                 SecretString = "secretString",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 Type = "type"
             }, new CfnPropertyMixinOptions {
                 Strategy = mergeStrategy
             });

Synopsis

Constructors

CfnSecretPropsMixin(ICfnSecretMixinProps, ICfnPropertyMixinOptions?)

Create a mixin to apply properties to AWS::SecretsManager::Secret.

Properties

CFN_PROPERTY_KEYS	Creates a new secret.
Props	Creates a new secret.
Strategy	Creates a new secret.

Methods

ApplyTo(IConstruct)	Apply the mixin properties to the construct.
Supports(IConstruct)	Check if this mixin supports the given construct.

Constructors

CfnSecretPropsMixin(ICfnSecretMixinProps, ICfnPropertyMixinOptions?)

Create a mixin to apply properties to AWS::SecretsManager::Secret.

public CfnSecretPropsMixin(ICfnSecretMixinProps props, ICfnPropertyMixinOptions? options = null)

Parameters

props ICfnSecretMixinProps

L1 properties to apply.

options ICfnPropertyMixinOptions

Mixin options.

Remarks

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 .

For Amazon Redshift admin user credentials, see AWS::Redshift::Cluster .

To retrieve a secret in a CloudFormation template, use a dynamic reference . For more information, see Retrieve a secret in an CloudFormation resource .

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 .

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

CloudformationResource: AWS::SecretsManager::Secret

Mixin: true

ExampleMetadata: fixture=_generated

Properties

CFN_PROPERTY_KEYS

Creates a new secret.

protected static string[] CFN_PROPERTY_KEYS { get; }

Property Value

string[]

Remarks

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 .

For Amazon Redshift admin user credentials, see AWS::Redshift::Cluster .

To retrieve a secret in a CloudFormation template, use a dynamic reference . For more information, see Retrieve a secret in an CloudFormation resource .

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 .

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

CloudformationResource: AWS::SecretsManager::Secret

Mixin: true

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.CfnPropertyMixins.AWS.SecretsManager;
             using Amazon.CDK;

             IMergeStrategy mergeStrategy;

             var cfnSecretPropsMixin = new CfnSecretPropsMixin(new CfnSecretMixinProps {
                 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 {
                     KmsKeyId = "kmsKeyId",
                     Region = "region"
                 } },
                 SecretString = "secretString",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 Type = "type"
             }, new CfnPropertyMixinOptions {
                 Strategy = mergeStrategy
             });

Props

Creates a new secret.

protected virtual ICfnSecretMixinProps Props { get; }

Property Value

ICfnSecretMixinProps

Remarks

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 .

For Amazon Redshift admin user credentials, see AWS::Redshift::Cluster .

To retrieve a secret in a CloudFormation template, use a dynamic reference . For more information, see Retrieve a secret in an CloudFormation resource .

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 .

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

CloudformationResource: AWS::SecretsManager::Secret

Mixin: true

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.CfnPropertyMixins.AWS.SecretsManager;
             using Amazon.CDK;

             IMergeStrategy mergeStrategy;

             var cfnSecretPropsMixin = new CfnSecretPropsMixin(new CfnSecretMixinProps {
                 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 {
                     KmsKeyId = "kmsKeyId",
                     Region = "region"
                 } },
                 SecretString = "secretString",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 Type = "type"
             }, new CfnPropertyMixinOptions {
                 Strategy = mergeStrategy
             });

Strategy

Creates a new secret.

protected virtual IMergeStrategy Strategy { get; }

Property Value

IMergeStrategy

Remarks

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 .

For Amazon Redshift admin user credentials, see AWS::Redshift::Cluster .

To retrieve a secret in a CloudFormation template, use a dynamic reference . For more information, see Retrieve a secret in an CloudFormation resource .

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 .

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

CloudformationResource: AWS::SecretsManager::Secret

Mixin: true

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.CfnPropertyMixins.AWS.SecretsManager;
             using Amazon.CDK;

             IMergeStrategy mergeStrategy;

             var cfnSecretPropsMixin = new CfnSecretPropsMixin(new CfnSecretMixinProps {
                 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 {
                     KmsKeyId = "kmsKeyId",
                     Region = "region"
                 } },
                 SecretString = "secretString",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 Type = "type"
             }, new CfnPropertyMixinOptions {
                 Strategy = mergeStrategy
             });

Methods

ApplyTo(IConstruct)

Apply the mixin properties to the construct.

public override void ApplyTo(IConstruct construct)

Parameters

construct IConstruct

Overrides

Mixin.ApplyTo(IConstruct)

Remarks

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 .

For Amazon Redshift admin user credentials, see AWS::Redshift::Cluster .

To retrieve a secret in a CloudFormation template, use a dynamic reference . For more information, see Retrieve a secret in an CloudFormation resource .

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 .

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

CloudformationResource: AWS::SecretsManager::Secret

Mixin: true

ExampleMetadata: fixture=_generated

Supports(IConstruct)

Check if this mixin supports the given construct.

public override bool Supports(IConstruct construct)

Parameters

construct IConstruct

Returns

bool

Overrides

Mixin.Supports(IConstruct)

Remarks

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 .

For Amazon Redshift admin user credentials, see AWS::Redshift::Cluster .

To retrieve a secret in a CloudFormation template, use a dynamic reference . For more information, see Retrieve a secret in an CloudFormation resource .

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 .

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

CloudformationResource: AWS::SecretsManager::Secret

Mixin: true

ExampleMetadata: fixture=_generated

Implements

Constructs.IMixin