Package 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(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")
         .clientPasswordAuthType("clientPasswordAuthType")
         .description("description")
         .iamAuth("iamAuth")
         .secretArn("secretArn")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxy-authformat.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	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	getClientPasswordAuthType()	Specifies the details of authentication used by a proxy to log in as a specific database user.
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.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAuthScheme

@Stability(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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxy-authformat.html#cfn-rds-dbproxy-authformat-authscheme

getClientPasswordAuthType

@Stability(Stable)
@Nullable
default String getClientPasswordAuthType()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxy-authformat.html#cfn-rds-dbproxy-authformat-clientpasswordauthtype

getDescription

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxy-authformat.html#cfn-rds-dbproxy-authformat-description

getIamAuth

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

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

The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.

Valid Values: ENABLED | DISABLED | REQUIRED

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxy-authformat.html#cfn-rds-dbproxy-authformat-iamauth

getSecretArn

@Stability(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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxy-authformat.html#cfn-rds-dbproxy-authformat-secretarn

builder

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

Returns:

a CfnDBProxy.AuthFormatProperty.Builder of CfnDBProxy.AuthFormatProperty