Class CredentialsFromUsernameOptions

Options for creating Credentials from a username.

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

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.KMS;
using Amazon.CDK.AWS.RDS;
using Amazon.CDK;

Key key;
SecretValue secretValue;
var credentialsFromUsernameOptions = new CredentialsFromUsernameOptions {
    EncryptionKey = key,
    ExcludeCharacters = "excludeCharacters",
    Password = secretValue,
    ReplicaRegions = new [] { new ReplicaRegion {
        Region = "region",

        // the properties below are optional
        EncryptionKey = key
    } },
    SecretName = "secretName"
};

Synopsis

Constructors

CredentialsFromUsernameOptions()

Properties

EncryptionKey

KMS encryption key to encrypt the generated secret.
ExcludeCharacters
Password

Password.
ReplicaRegions

A list of regions where to replicate this secret.
SecretName

The name of the secret.

Constructors

CredentialsFromUsernameOptions()

public CredentialsFromUsernameOptions()

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

Password

Password.

public SecretValue Password { get; set; }
Property Value

SecretValue

Remarks

Do not put passwords in your CDK code directly.

Default: - a Secrets Manager generated password

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