Class CfnDBProxyPropsMixin.AuthFormatProperty.Builder
java.lang.Object
software.amazon.awscdk.cfnpropertymixins.services.rds.CfnDBProxyPropsMixin.AuthFormatProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnDBProxyPropsMixin.AuthFormatProperty>
- Enclosing interface:
CfnDBProxyPropsMixin.AuthFormatProperty
@Stability(Stable)
public static final class CfnDBProxyPropsMixin.AuthFormatProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDBProxyPropsMixin.AuthFormatProperty>
A builder for
CfnDBProxyPropsMixin.AuthFormatProperty-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionauthScheme(String authScheme) Sets the value ofCfnDBProxyPropsMixin.AuthFormatProperty.getAuthScheme()build()Builds the configured instance.clientPasswordAuthType(String clientPasswordAuthType) Sets the value ofCfnDBProxyPropsMixin.AuthFormatProperty.getClientPasswordAuthType()description(String description) Sets the value ofCfnDBProxyPropsMixin.AuthFormatProperty.getDescription()Sets the value ofCfnDBProxyPropsMixin.AuthFormatProperty.getIamAuth()Sets the value ofCfnDBProxyPropsMixin.AuthFormatProperty.getSecretArn()secretArn(ISecretRef secretArn) Sets the value ofCfnDBProxyPropsMixin.AuthFormatProperty.getSecretArn()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
authScheme
@Stability(Stable) public CfnDBProxyPropsMixin.AuthFormatProperty.Builder authScheme(String authScheme) Sets the value ofCfnDBProxyPropsMixin.AuthFormatProperty.getAuthScheme()- Parameters:
authScheme- The type of authentication that the proxy uses for connections from the proxy to the underlying database.- Returns:
this
-
clientPasswordAuthType
@Stability(Stable) public CfnDBProxyPropsMixin.AuthFormatProperty.Builder clientPasswordAuthType(String clientPasswordAuthType) Sets the value ofCfnDBProxyPropsMixin.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 CfnDBProxyPropsMixin.AuthFormatProperty.Builder description(String description) Sets the value ofCfnDBProxyPropsMixin.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
Sets the value ofCfnDBProxyPropsMixin.AuthFormatProperty.getIamAuth()- Parameters:
iamAuth- A value that indicates whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy. TheENABLEDvalue is valid only for proxies with RDS for Microsoft SQL Server.- Returns:
this
-
secretArn
@Stability(Stable) public CfnDBProxyPropsMixin.AuthFormatProperty.Builder secretArn(String secretArn) Sets the value ofCfnDBProxyPropsMixin.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
-
secretArn
@Stability(Stable) public CfnDBProxyPropsMixin.AuthFormatProperty.Builder secretArn(ISecretRef secretArn) Sets the value ofCfnDBProxyPropsMixin.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
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnDBProxyPropsMixin.AuthFormatProperty>- Returns:
- a new instance of
CfnDBProxyPropsMixin.AuthFormatProperty - Throws:
NullPointerException- if any required attribute was not provided
-