Package software.amazon.awscdk.services.rds

Class CfnDBProxy.AuthFormatProperty.Builder

java.lang.Object

software.amazon.awscdk.services.rds.CfnDBProxy.AuthFormatProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDBProxy.AuthFormatProperty>

Enclosing interface:

CfnDBProxy.AuthFormatProperty

@Stability(Stable)
public static final class CfnDBProxy.AuthFormatProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDBProxy.AuthFormatProperty>

A builder for CfnDBProxy.AuthFormatProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnDBProxy.AuthFormatProperty.Builder	authScheme(String authScheme)	Sets the value of CfnDBProxy.AuthFormatProperty.getAuthScheme()
CfnDBProxy.AuthFormatProperty	build()	Builds the configured instance.
CfnDBProxy.AuthFormatProperty.Builder	clientPasswordAuthType(String clientPasswordAuthType)	Sets the value of CfnDBProxy.AuthFormatProperty.getClientPasswordAuthType()
CfnDBProxy.AuthFormatProperty.Builder	description(String description)	Sets the value of CfnDBProxy.AuthFormatProperty.getDescription()
CfnDBProxy.AuthFormatProperty.Builder	iamAuth(String iamAuth)	Sets the value of CfnDBProxy.AuthFormatProperty.getIamAuth()
CfnDBProxy.AuthFormatProperty.Builder	secretArn(String secretArn)	Sets the value of CfnDBProxy.AuthFormatProperty.getSecretArn()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

authScheme

@Stability(Stable)
public CfnDBProxy.AuthFormatProperty.Builder authScheme(String authScheme)

Sets the value of CfnDBProxy.AuthFormatProperty.getAuthScheme()

Parameters:

authScheme - The type of authentication that the proxy uses for connections from the proxy to the underlying database. Valid Values: SECRETS

Returns:

this

clientPasswordAuthType

@Stability(Stable)
public CfnDBProxy.AuthFormatProperty.Builder clientPasswordAuthType(String clientPasswordAuthType)

Sets the value of CfnDBProxy.AuthFormatProperty.getClientPasswordAuthType()

Parameters:

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

Returns:

this

description

@Stability(Stable)
public CfnDBProxy.AuthFormatProperty.Builder description(String description)

Sets the value of CfnDBProxy.AuthFormatProperty.getDescription()

Parameters:

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

Returns:

this

iamAuth

@Stability(Stable)
public CfnDBProxy.AuthFormatProperty.Builder iamAuth(String iamAuth)

Sets the value of CfnDBProxy.AuthFormatProperty.getIamAuth()

Parameters:

iamAuth - 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

Returns:

this

secretArn

@Stability(Stable)
public CfnDBProxy.AuthFormatProperty.Builder secretArn(String secretArn)

Sets the value of CfnDBProxy.AuthFormatProperty.getSecretArn()

Parameters:

secretArn - 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.

Returns:

this

build

@Stability(Stable)
public CfnDBProxy.AuthFormatProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnDBProxy.AuthFormatProperty>

Returns:

a new instance of CfnDBProxy.AuthFormatProperty

Throws:

NullPointerException - if any required attribute was not provided