Class CredentialsBaseOptions

Base options for creating Credentials.

Inheritance
System.Object
CredentialsBaseOptions
Namespace: Amazon.CDK.AWS.RDS
Assembly: Amazon.CDK.AWS.RDS.dll
Syntax (csharp)
public class CredentialsBaseOptions : Object, ICredentialsBaseOptions
Syntax (vb)
Public Class CredentialsBaseOptions
    Inherits Object
    Implements ICredentialsBaseOptions
Remarks

ExampleMetadata: infused

Examples
Vpc vpc;

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

new DatabaseInstance(this, "InstanceWithCustomizedSecret", new DatabaseInstanceProps {
    Engine = engine,
    Vpc = vpc,
    Credentials = Credentials.FromGeneratedSecret("postgres", new CredentialsBaseOptions {
        SecretName = "my-cool-name",
        EncryptionKey = myKey,
        ExcludeCharacters = "!&*^#@()",
        ReplicaRegions = new [] { new ReplicaRegion { Region = "eu-west-1" }, new ReplicaRegion { Region = "eu-west-2" } }
    })
});

Synopsis

Constructors

CredentialsBaseOptions()

Properties

EncryptionKey

KMS encryption key to encrypt the generated secret.
ExcludeCharacters
ReplicaRegions

A list of regions where to replicate this secret.
SecretName

The name of the secret.

Constructors

CredentialsBaseOptions()

public CredentialsBaseOptions()

Properties

EncryptionKey

KMS encryption key to encrypt the generated secret.

public IKey EncryptionKey { get; set; }
Property Value

IKey

Remarks

Default: - default master key

ExcludeCharacters

public string ExcludeCharacters { get; set; }
Property Value

System.String

ReplicaRegions

A list of regions where to replicate this secret.

public IReplicaRegion[] ReplicaRegions { get; set; }
Property Value

IReplicaRegion[]

Remarks

Default: - Secret is not replicated

SecretName

The name of the secret.

public string SecretName { get; set; }
Property Value

System.String

Remarks

Default: - A name is generated by CloudFormation.

Implements