software.amazon.awscdk.services.rds

Interface CfnDBProxyProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDBProxyProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:18.824Z")
 @Stability(value=Stable)
public interface CfnDBProxyProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::RDS::DBProxy`.

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.*;
 CfnDBProxyProps cfnDBProxyProps = CfnDBProxyProps.builder()
         .auth(List.of(AuthFormatProperty.builder()
                 .authScheme("authScheme")
                 .description("description")
                 .iamAuth("iamAuth")
                 .secretArn("secretArn")
                 .userName("userName")
                 .build()))
         .dbProxyName("dbProxyName")
         .engineFamily("engineFamily")
         .roleArn("roleArn")
         .vpcSubnetIds(List.of("vpcSubnetIds"))
         // the properties below are optional
         .debugLogging(false)
         .idleClientTimeout(123)
         .requireTls(false)
         .tags(List.of(TagFormatProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .vpcSecurityGroupIds(List.of("vpcSecurityGroupIds"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnDBProxyProps.Builder A builder for CfnDBProxyProps
static class	CfnDBProxyProps.Jsii$Proxy An implementation for CfnDBProxyProps

Method Summary

Modifier and Type	Method and Description
static CfnDBProxyProps.Builder	builder()
Object	getAuth() `AWS::RDS::DBProxy.Auth`.
String	getDbProxyName() `AWS::RDS::DBProxy.DBProxyName`.
default Object	getDebugLogging() `AWS::RDS::DBProxy.DebugLogging`.
String	getEngineFamily() `AWS::RDS::DBProxy.EngineFamily`.
default Number	getIdleClientTimeout() `AWS::RDS::DBProxy.IdleClientTimeout`.
default Object	getRequireTls() `AWS::RDS::DBProxy.RequireTLS`.
String	getRoleArn() `AWS::RDS::DBProxy.RoleArn`.
default List<CfnDBProxy.TagFormatProperty>	getTags() `AWS::RDS::DBProxy.Tags`.
default List<String>	getVpcSecurityGroupIds() `AWS::RDS::DBProxy.VpcSecurityGroupIds`.
List<String>	getVpcSubnetIds() `AWS::RDS::DBProxy.VpcSubnetIds`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAuth

@Stability(value=Stable)
 @NotNull
Object getAuth()

`AWS::RDS::DBProxy.Auth`.

getDbProxyName

@Stability(value=Stable)
 @NotNull
String getDbProxyName()

`AWS::RDS::DBProxy.DBProxyName`.

getDebugLogging

@Stability(value=Stable)
 @Nullable
default Object getDebugLogging()

`AWS::RDS::DBProxy.DebugLogging`.

getEngineFamily

@Stability(value=Stable)
 @NotNull
String getEngineFamily()

`AWS::RDS::DBProxy.EngineFamily`.

getIdleClientTimeout

@Stability(value=Stable)
 @Nullable
default Number getIdleClientTimeout()

`AWS::RDS::DBProxy.IdleClientTimeout`.

getRequireTls

@Stability(value=Stable)
 @Nullable
default Object getRequireTls()

`AWS::RDS::DBProxy.RequireTLS`.

getRoleArn

@Stability(value=Stable)
 @NotNull
String getRoleArn()

`AWS::RDS::DBProxy.RoleArn`.

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnDBProxy.TagFormatProperty> getTags()

`AWS::RDS::DBProxy.Tags`.

getVpcSecurityGroupIds

@Stability(value=Stable)
 @Nullable
default List<String> getVpcSecurityGroupIds()

`AWS::RDS::DBProxy.VpcSecurityGroupIds`.

getVpcSubnetIds

@Stability(value=Stable)
 @NotNull
List<String> getVpcSubnetIds()

`AWS::RDS::DBProxy.VpcSubnetIds`.

builder

@Stability(value=Stable)
static CfnDBProxyProps.Builder builder()

Returns:

a CfnDBProxyProps.Builder of CfnDBProxyProps