software.amazon.awscdk.services.rds

Interface CredentialsFromUsernameOptions

All Superinterfaces:

CredentialsBaseOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CredentialsFromUsernameOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:48.791Z")
 @Stability(value=Stable)
public interface CredentialsFromUsernameOptions
extends software.amazon.jsii.JsiiSerializable, CredentialsBaseOptions

Options for creating Credentials from a username.

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.*;
 import software.amazon.awscdk.core.*;
 Key key;
 SecretValue secretValue;
 CredentialsFromUsernameOptions credentialsFromUsernameOptions = CredentialsFromUsernameOptions.builder()
         .encryptionKey(key)
         .excludeCharacters("excludeCharacters")
         .password(secretValue)
         .replicaRegions(List.of(ReplicaRegion.builder()
                 .region("region")
                 // the properties below are optional
                 .encryptionKey(key)
                 .build()))
         .secretName("secretName")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CredentialsFromUsernameOptions.Builder	builder()
default SecretValue	getPassword() Password.

Methods inherited from interface software.amazon.awscdk.services.rds.CredentialsBaseOptions

getEncryptionKey, getExcludeCharacters, getReplicaRegions, getSecretName

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getPassword

@Stability(value=Stable)
 @Nullable
default SecretValue getPassword()

Password.

Do not put passwords in your CDK code directly.

Default: - a Secrets Manager generated password

builder

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

Specified by:

builder in interface CredentialsBaseOptions

Returns:

a CredentialsFromUsernameOptions.Builder of CredentialsFromUsernameOptions