Class CfnDBProxy.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnDBProxy>
- Enclosing class:
CfnDBProxy
CfnDBProxy
.-
Method Summary
Modifier and TypeMethodDescriptionThe authorization mechanism that the proxy uses.auth
(IResolvable auth) The authorization mechanism that the proxy uses.build()
static CfnDBProxy.Builder
dbProxyName
(String dbProxyName) The identifier for the proxy.debugLogging
(Boolean debugLogging) Whether the proxy includes detailed information about SQL statements in its logs.debugLogging
(IResolvable debugLogging) Whether the proxy includes detailed information about SQL statements in its logs.engineFamily
(String engineFamily) The kinds of databases that the proxy can connect to.idleClientTimeout
(Number idleClientTimeout) The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it.requireTls
(Boolean requireTls) A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.requireTls
(IResolvable requireTls) A Boolean parameter that 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.tags
(List<? extends CfnDBProxy.TagFormatProperty> tags) An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.vpcSecurityGroupIds
(List<String> vpcSecurityGroupIds) One or more VPC security group IDs to associate with the new proxy.vpcSubnetIds
(List<String> vpcSubnetIds) One or more VPC subnet IDs to associate with the new proxy.
-
Method Details
-
create
- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
- Returns:
- a new instance of
CfnDBProxy.Builder
.
-
auth
The authorization mechanism that the proxy uses.- Parameters:
auth
- The authorization mechanism that the proxy uses. This parameter is required.- Returns:
this
-
auth
The authorization mechanism that the proxy uses.- Parameters:
auth
- The authorization mechanism that the proxy uses. This parameter is required.- Returns:
this
-
dbProxyName
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.
- Parameters:
dbProxyName
- The identifier for the proxy. This parameter is required.- Returns:
this
-
engineFamily
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
.Valid values :
MYSQL
|POSTGRESQL
|SQLSERVER
- Parameters:
engineFamily
- The kinds of databases that the proxy can connect to. This parameter is required.- Returns:
this
-
roleArn
The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.- Parameters:
roleArn
- The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager. This parameter is required.- Returns:
this
-
vpcSubnetIds
One or more VPC subnet IDs to associate with the new proxy.- Parameters:
vpcSubnetIds
- One or more VPC subnet IDs to associate with the new proxy. This parameter is required.- Returns:
this
-
debugLogging
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.
- Parameters:
debugLogging
- Whether the proxy includes detailed information about SQL statements in its logs. This parameter is required.- Returns:
this
-
debugLogging
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.
- Parameters:
debugLogging
- Whether the proxy includes detailed information about SQL statements in its logs. This parameter is required.- Returns:
this
-
idleClientTimeout
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.
- Parameters:
idleClientTimeout
- The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it. This parameter is required.- Returns:
this
-
requireTls
A Boolean parameter that 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.
- Parameters:
requireTls
- A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy. This parameter is required.- Returns:
this
-
requireTls
A Boolean parameter that 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.
- Parameters:
requireTls
- A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy. This parameter is required.- Returns:
this
-
tags
@Stability(Stable) public CfnDBProxy.Builder tags(List<? extends CfnDBProxy.TagFormatProperty> tags) An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.- Parameters:
tags
- An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy. This parameter is required.- Returns:
this
-
vpcSecurityGroupIds
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.
- Parameters:
vpcSecurityGroupIds
- One or more VPC security group IDs to associate with the new proxy. This parameter is required.- Returns:
this
-
build
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnDBProxy>
- Returns:
- a newly built instance of
CfnDBProxy
.
-