interface CredentialsBaseOptions

Language	Type name
.NET	Amazon.CDK.AWS.RDS.CredentialsBaseOptions
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsrds#CredentialsBaseOptions
Java	software.amazon.awscdk.services.rds.CredentialsBaseOptions
Python	aws_cdk.aws_rds.CredentialsBaseOptions
TypeScript (source)	aws-cdk-lib » aws_rds » CredentialsBaseOptions

Base options for creating Credentials.

Example

declare const vpc: ec2.Vpc;
const engine = rds.DatabaseInstanceEngine.postgres({ version: rds.PostgresEngineVersion.VER_16_3 });
const myKey = new kms.Key(this, 'MyKey');

new rds.DatabaseInstance(this, 'InstanceWithCustomizedSecret', {
  engine,
  vpc,
  credentials: rds.Credentials.fromGeneratedSecret('postgres', {
    secretName: 'my-cool-name',
    encryptionKey: myKey,
    excludeCharacters: '!&*^#@()',
    replicaRegions: [{ region: 'eu-west-1' }, { region: 'eu-west-2' }],
  }),
});

Properties

Name	Type	Description
encryptionKey?	IKey	KMS encryption key to encrypt the generated secret.
excludeCharacters?	string	The characters to exclude from the generated password.
replicaRegions?	ReplicaRegion[]	A list of regions where to replicate this secret.
secretName?	string	The name of the secret.

---

encryptionKey?

Type: IKey (optional, default: default master key)

KMS encryption key to encrypt the generated secret.

---

excludeCharacters?

Type: string (optional, default: the DatabaseSecret default exclude character set (" %+~`#$&()|[]{}:;<>?!'/@"\"))*

The characters to exclude from the generated password.

Has no effect if password has been provided.

---

replicaRegions?

Type: ReplicaRegion[] (optional, default: Secret is not replicated)

A list of regions where to replicate this secret.

---

secretName?

Type: string (optional, default: A name is generated by CloudFormation.)

The name of the secret.