Package software.amazon.awscdk.services.rds

Enum DefaultAuthScheme

java.lang.Object

java.lang.Enum<DefaultAuthScheme>

software.amazon.awscdk.services.rds.DefaultAuthScheme

All Implemented Interfaces:

Serializable, Comparable<DefaultAuthScheme>, java.lang.constant.Constable

@Generated(value="jsii-pacmak/1.125.0 (build fdbe357)",
           date="2026-01-19T12:04:00.869Z")
@Stability(Stable)
public enum DefaultAuthScheme
extends Enum<DefaultAuthScheme>

The default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database.

Example:

 Vpc vpc;
 DatabaseInstance instance = DatabaseInstance.Builder.create(this, "Database")
         .engine(DatabaseInstanceEngine.postgres(PostgresInstanceEngineProps.builder()
                 .version(PostgresEngineVersion.VER_17_7)
                 .build()))
         .vpc(vpc)
         .iamAuthentication(true)
         .build();
 DatabaseProxy proxy = DatabaseProxy.Builder.create(this, "Proxy")
         .proxyTarget(ProxyTarget.fromInstance(instance))
         .vpc(vpc)
         .defaultAuthScheme(DefaultAuthScheme.IAM_AUTH)
         .build();
 // Grant IAM permissions for database connection
 Role role = Role.Builder.create(this, "DBRole").assumedBy(new AccountPrincipal(this.account)).build();
 proxy.grantConnect(role, "database-user");
 

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
IAM_AUTH	IAM authentication.
NONE	No default authentication.

Method Summary

Modifier and Type	Method	Description
static DefaultAuthScheme	valueOf(String name)	Returns the enum constant of this type with the specified name.
static DefaultAuthScheme[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

IAM_AUTH

@Stability(Stable)
public static final DefaultAuthScheme IAM_AUTH

IAM authentication.

NONE

@Stability(Stable)
public static final DefaultAuthScheme NONE

No default authentication.

Method Details

values

public static DefaultAuthScheme[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DefaultAuthScheme valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null