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
-
Method Summary
Modifier and TypeMethodDescriptionauthScheme
(String authScheme) Sets the value ofCfnDBProxy.AuthFormatProperty.getAuthScheme()
build()
Builds the configured instance.clientPasswordAuthType
(String clientPasswordAuthType) Sets the value ofCfnDBProxy.AuthFormatProperty.getClientPasswordAuthType()
description
(String description) Sets the value ofCfnDBProxy.AuthFormatProperty.getDescription()
Sets the value ofCfnDBProxy.AuthFormatProperty.getIamAuth()
Sets the value ofCfnDBProxy.AuthFormatProperty.getSecretArn()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
authScheme
Sets the value ofCfnDBProxy.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 CfnDBProxy.AuthFormatProperty.Builder clientPasswordAuthType(String clientPasswordAuthType) Sets the value ofCfnDBProxy.AuthFormatProperty.getClientPasswordAuthType()
- Parameters:
clientPasswordAuthType
- Specifies the details of authentication used by a proxy to log in as a specific database user.- Returns:
this
-
description
Sets the value ofCfnDBProxy.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 ofCfnDBProxy.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. TheENABLED
value is valid only for proxies with RDS for Microsoft SQL Server.- Returns:
this
-
secretArn
Sets the value ofCfnDBProxy.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:
build
in interfacesoftware.amazon.jsii.Builder<CfnDBProxy.AuthFormatProperty>
- Returns:
- a new instance of
CfnDBProxy.AuthFormatProperty
- Throws:
NullPointerException
- if any required attribute was not provided
-