Interface CfnDBProxyProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnDBProxyProps.Jsii$Proxy
CfnDBProxy
.
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") .clientPasswordAuthType("clientPasswordAuthType") .description("description") .iamAuth("iamAuth") .secretArn("secretArn") .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();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnDBProxyProps
static final class
An implementation forCfnDBProxyProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnDBProxyProps.Builder
builder()
getAuth()
The authorization mechanism that the proxy uses.The identifier for the proxy.default Object
Specifies whether the proxy includes detailed information about SQL statements in its logs.The kinds of databases that the proxy can connect to.default Number
The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it.default Object
Specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.default List<CfnDBProxy.TagFormatProperty>
getTags()
An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.One or more VPC security group IDs to associate with the new proxy.One or more VPC subnet IDs to associate with the new proxy.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getAuth
The authorization mechanism that the proxy uses.- See Also:
-
getDbProxyName
The identifier for the proxy.This name must be unique for all proxies owned by your AWS account in the specified AWS Region . An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.
- See Also:
-
getEngineFamily
The kinds of databases that the proxy can connect to.This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. For Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases, specify
MYSQL
. For Aurora PostgreSQL and RDS for PostgreSQL databases, specifyPOSTGRESQL
. For RDS for Microsoft SQL Server, specifySQLSERVER
.- See Also:
-
getRoleArn
The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.- See Also:
-
getVpcSubnetIds
One or more VPC subnet IDs to associate with the new proxy.- See Also:
-
getDebugLogging
Specifies whether the proxy includes detailed information about SQL statements in its logs.This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.
- See Also:
-
getIdleClientTimeout
The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it.You can set this value higher or lower than the connection timeout limit for the associated database.
- See Also:
-
getRequireTls
Specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.By enabling this setting, you can enforce encrypted TLS connections to the proxy.
- See Also:
-
getTags
An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.- See Also:
-
getVpcSecurityGroupIds
One or more VPC security group IDs to associate with the new proxy.If you plan to update the resource, don't specify VPC security groups in a shared VPC.
- See Also:
-
builder
- Returns:
- a
CfnDBProxyProps.Builder
ofCfnDBProxyProps
-