software.amazon.awscdk.services.rds

Interface SnapshotCredentialsFromGeneratedPasswordOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

SnapshotCredentialsFromGeneratedPasswordOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.57.0 (build f614666)",
           date="2022-04-22T22:36:24.517Z")
 @Stability(value=Stable)
public interface SnapshotCredentialsFromGeneratedPasswordOptions
extends software.amazon.jsii.JsiiSerializable

Options used in the SnapshotCredentials.fromGeneratedPassword method.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.kms.*;
 import software.amazon.awscdk.services.rds.*;
 Key key;
 SnapshotCredentialsFromGeneratedPasswordOptions snapshotCredentialsFromGeneratedPasswordOptions = SnapshotCredentialsFromGeneratedPasswordOptions.builder()
         .encryptionKey(key)
         .excludeCharacters("excludeCharacters")
         .replicaRegions(List.of(ReplicaRegion.builder()
                 .region("region")
                 // the properties below are optional
                 .encryptionKey(key)
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SnapshotCredentialsFromGeneratedPasswordOptions.Builder A builder for SnapshotCredentialsFromGeneratedPasswordOptions
static class	SnapshotCredentialsFromGeneratedPasswordOptions.Jsii$Proxy An implementation for SnapshotCredentialsFromGeneratedPasswordOptions

Method Summary

Modifier and Type	Method and Description
static SnapshotCredentialsFromGeneratedPasswordOptions.Builder	builder()
default IKey	getEncryptionKey() KMS encryption key to encrypt the generated secret.
default String	getExcludeCharacters() The characters to exclude from the generated password.
default List<ReplicaRegion>	getReplicaRegions() A list of regions where to replicate this secret.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getEncryptionKey

@Stability(value=Stable)
 @Nullable
default IKey getEncryptionKey()

KMS encryption key to encrypt the generated secret.

Default: - default master key

getExcludeCharacters

@Stability(value=Stable)
 @Nullable
default String getExcludeCharacters()

The characters to exclude from the generated password.

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

getReplicaRegions

@Stability(value=Stable)
 @Nullable
default List<ReplicaRegion> getReplicaRegions()

A list of regions where to replicate this secret.

Default: - Secret is not replicated

builder

@Stability(value=Stable)
static SnapshotCredentialsFromGeneratedPasswordOptions.Builder builder()

Returns:

a SnapshotCredentialsFromGeneratedPasswordOptions.Builder of SnapshotCredentialsFromGeneratedPasswordOptions