software.amazon.awscdk.services.rds

Interface CfnDBProxy.AuthFormatProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDBProxy.AuthFormatProperty.Jsii$Proxy

Enclosing class:

CfnDBProxy

@Stability(value=Stable)
public static interface CfnDBProxy.AuthFormatProperty
extends software.amazon.jsii.JsiiSerializable

Specifies the details of authentication used by a proxy to log in as a specific database user.

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.rds.*;
 AuthFormatProperty authFormatProperty = AuthFormatProperty.builder()
         .authScheme("authScheme")
         .description("description")
         .iamAuth("iamAuth")
         .secretArn("secretArn")
         .userName("userName")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnDBProxy.AuthFormatProperty.Builder	builder()
default String	getAuthScheme() The type of authentication that the proxy uses for connections from the proxy to the underlying database.
default String	getDescription() A user-specified description about the authentication used by a proxy to log in as a specific database user.
default String	getIamAuth() Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.
default String	getSecretArn() The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster.
default String	getUserName() The name of the database user to which the proxy connects.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAuthScheme

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

The type of authentication that the proxy uses for connections from the proxy to the underlying database.

Valid Values: SECRETS

getDescription

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

A user-specified description about the authentication used by a proxy to log in as a specific database user.

getIamAuth

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

Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.

Valid Values: DISABLED | REQUIRED

getSecretArn

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

The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster.

These secrets are stored within Amazon Secrets Manager.

getUserName

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

The name of the database user to which the proxy connects.

builder

@Stability(value=Stable)
static CfnDBProxy.AuthFormatProperty.Builder builder()

Returns:

a CfnDBProxy.AuthFormatProperty.Builder of CfnDBProxy.AuthFormatProperty