CredentialsFromUsernameOptions

class aws_cdk.aws_rds.CredentialsFromUsernameOptions(*, encryption_key=None, exclude_characters=None, replica_regions=None, secret_name=None, password=None)

Bases: CredentialsBaseOptions

Options for creating Credentials from a username.

Parameters:

  • encryption_key (Optional[IKey]) – KMS encryption key to encrypt the generated secret. Default: - default master key

  • exclude_characters (Optional[str]) – The characters to exclude from the generated password. Has no effect if password has been provided. Default: - the DatabaseSecret default exclude character set (” %+~`#$&*()|[]{}:;<>?!’/@”")

  • replica_regions (Optional[Sequence[Union[ReplicaRegion, Dict[str, Any]]]]) – A list of regions where to replicate this secret. Default: - Secret is not replicated

  • secret_name (Optional[str]) – The name of the secret. Default: - A name is generated by CloudFormation.

  • password (Optional[SecretValue]) – Password. Do not put passwords in your CDK code directly. Default: - a Secrets Manager generated password

ExampleMetadata:

infused

Example:

# vpc: ec2.Vpc

cluster = rds.DatabaseCluster(self, "Database",
    engine=rds.DatabaseClusterEngine.aurora_postgres(version=rds.AuroraPostgresEngineVersion.VER_15_2),
    credentials=rds.Credentials.from_username("adminuser", password=SecretValue.unsafe_plain_text("7959866cacc02c2d243ecfe177464fe6")),
    writer=rds.ClusterInstance.provisioned("writer",
        publicly_accessible=False
    ),
    readers=[
        rds.ClusterInstance.provisioned("reader")
    ],
    storage_type=rds.DBClusterStorageType.AURORA_IOPT1,
    vpc_subnets=ec2.SubnetSelection(
        subnet_type=ec2.SubnetType.PRIVATE_WITH_EGRESS
    ),
    vpc=vpc
)

Attributes

encryption_key

KMS encryption key to encrypt the generated secret.

Default:

  • default master key

exclude_characters

The characters to exclude from the generated password.

Has no effect if password has been provided.

Default:

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

password

Password.

Do not put passwords in your CDK code directly.

Default:

  • a Secrets Manager generated password

replica_regions

A list of regions where to replicate this secret.

Default:

  • Secret is not replicated

secret_name

The name of the secret.

Default:

  • A name is generated by CloudFormation.