Interface ISnapshotCredentialsFromGeneratedPasswordOptions

Options used in the SnapshotCredentials.fromGeneratedPassword method.

Namespace: Amazon.CDK.AWS.RDS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ISnapshotCredentialsFromGeneratedPasswordOptions

Syntax (vb)

Public Interface ISnapshotCredentialsFromGeneratedPasswordOptions

Remarks

ExampleMetadata: infused

Examples

Vpc vpc;

            var engine = DatabaseInstanceEngine.Postgres(new PostgresInstanceEngineProps { Version = PostgresEngineVersion.VER_16_3 });
            var myKey = new Key(this, "MyKey");

            new DatabaseInstanceFromSnapshot(this, "InstanceFromSnapshotWithCustomizedSecret", new DatabaseInstanceFromSnapshotProps {
                Engine = engine,
                Vpc = vpc,
                SnapshotIdentifier = "mySnapshot",
                Credentials = SnapshotCredentials.FromGeneratedSecret("username", new SnapshotCredentialsFromGeneratedPasswordOptions {
                    EncryptionKey = myKey,
                    ExcludeCharacters = "!&*^#@()",
                    ReplicaRegions = new [] { new ReplicaRegion { Region = "eu-west-1" }, new ReplicaRegion { Region = "eu-west-2" } }
                })
            });

Synopsis

Properties

EncryptionKey	KMS encryption key to encrypt the generated secret.
ExcludeCharacters	Options used in the SnapshotCredentials.fromGeneratedPassword method.
ReplicaRegions	A list of regions where to replicate this secret.

Properties

EncryptionKey

KMS encryption key to encrypt the generated secret.

IKey? EncryptionKey { get; }

Property Value

IKey

Remarks

Default: - default master key

ExcludeCharacters

Options used in the SnapshotCredentials.fromGeneratedPassword method.

string? ExcludeCharacters { get; }

Property Value

string

Remarks

ExampleMetadata: infused

Examples

Vpc vpc;

            var engine = DatabaseInstanceEngine.Postgres(new PostgresInstanceEngineProps { Version = PostgresEngineVersion.VER_16_3 });
            var myKey = new Key(this, "MyKey");

            new DatabaseInstanceFromSnapshot(this, "InstanceFromSnapshotWithCustomizedSecret", new DatabaseInstanceFromSnapshotProps {
                Engine = engine,
                Vpc = vpc,
                SnapshotIdentifier = "mySnapshot",
                Credentials = SnapshotCredentials.FromGeneratedSecret("username", new SnapshotCredentialsFromGeneratedPasswordOptions {
                    EncryptionKey = myKey,
                    ExcludeCharacters = "!&*^#@()",
                    ReplicaRegions = new [] { new ReplicaRegion { Region = "eu-west-1" }, new ReplicaRegion { Region = "eu-west-2" } }
                })
            });

ReplicaRegions

A list of regions where to replicate this secret.

IReplicaRegion[]? ReplicaRegions { get; }

Property Value

IReplicaRegion[]

Remarks

Default: - Secret is not replicated