AWS CDK Reference

Appearance

v2.274.0

CredentialsBaseOptions Struct ​

Base options for creating Credentials.

Source
aws-rds/lib/props.ts
Type last changed
v2.72.0 · 29 Mar 2023

Example ​

ts
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 ​

encryptionKeyIKeyencryption_keyIKeyencryptionKeyIKeyEncryptionKeyIKeyEncryptionKeyIKey= default master key#
KMS encryption key to encrypt the generated secret.
excludeCharactersstringexclude_charactersstrexcludeCharactersStringExcludeCharactersstringExcludeCharacters*string= the DatabaseSecret default exclu…#
The characters to exclude from the generated password.

Has no effect if password has been provided.

default

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

replicaRegionsReplicaRegion[]replica_regionstyping.List[ReplicaRegion]replicaRegionsList<ReplicaRegion>ReplicaRegionsReplicaRegion[]ReplicaRegions*[]ReplicaRegion= Secret is not replicated#
A list of regions where to replicate this secret.
secretNamestringsecret_namestrsecretNameStringSecretNamestringSecretName*string= A name is generated by CloudForm…#
The name of the secret.
default

Default: A name is generated by CloudFormation.