SnapshotCredentialsFromGeneratedPasswordOptions

class aws_cdk.aws_rds.SnapshotCredentialsFromGeneratedPasswordOptions(*, encryption_key=None, exclude_characters=None, replica_regions=None)

Bases: object

Options used in the {@link SnapshotCredentials.fromGeneratedPassword} method.

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. Default: - the DatabaseSecret default exclude character set (” %+~`#$&*()|[]{}:;<>?!’/

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

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_kms as kms
import aws_cdk.aws_rds as rds

# key: kms.Key

snapshot_credentials_from_generated_password_options = rds.SnapshotCredentialsFromGeneratedPasswordOptions(
    encryption_key=key,
    exclude_characters="excludeCharacters",
    replica_regions=[ReplicaRegion(
        region="region",

        # the properties below are optional
        encryption_key=key
    )]
)

Attributes

encryption_key

KMS encryption key to encrypt the generated secret.

Default
  • default master key

Return type

Optional[IKey]

exclude_characters

The characters to exclude from the generated password.

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

:: “")

Return type

Optional[str]

replica_regions

A list of regions where to replicate this secret.

Default
  • Secret is not replicated

Return type

Optional[List[ReplicaRegion]]