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:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnDBProxy.AuthFormatProperty
static final class
An implementation forCfnDBProxy.AuthFormatProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default String
The type of authentication that the proxy uses for connections from the proxy to the underlying database.default String
Specifies the details of authentication used by a proxy to log in as a specific database user.default String
A user-specified description about the authentication used by a proxy to log in as a specific database user.default String
A value that indicates whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.default String
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
The type of authentication that the proxy uses for connections from the proxy to the underlying database.- See Also:
-
getClientPasswordAuthType
Specifies the details of authentication used by a proxy to log in as a specific database user.- See Also:
-
getDescription
A user-specified description about the authentication used by a proxy to log in as a specific database user.- See Also:
-
getIamAuth
A value that indicates 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.- See Also:
-
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:
-
builder
-