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();

  • 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

    • getClientPasswordAuthType

      @Stability(Stable) @Nullable default String getClientPasswordAuthType()
      Specifies the details of authentication used by a proxy to log in as a specific database user.

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

    • 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

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

    • builder

      @Stability(Stable) static CfnDBProxy.AuthFormatProperty.Builder builder()
      Returns:
      a CfnDBProxy.AuthFormatProperty.Builder of CfnDBProxy.AuthFormatProperty