ProxyArgs class

The set of arguments for Proxy. The set of arguments for Proxy.

Constructors

ProxyArgs({Input<List<ProxyAuth>?>? auths, Input<bool?>? debugLogging, Input<String?>? defaultAuthScheme, Input<String?>? endpointNetworkType, required Input<String> engineFamily, Input<int?>? idleClientTimeout, Input<String?>? name, Input<String?>? region, Input<bool?>? requireTls, required Input<String> roleArn, Input<Map<String, String>?>? tags, Input<String?>? targetConnectionNetworkType, Input<List<String>?>? vpcSecurityGroupIds, required Input<List<String>> vpcSubnetIds})
Creates a new ProxyArgs. auths Configuration block(s) with authorization mechanisms to connect to the associated instances or clusters. Required when defaultAuthScheme is NONE or unspecified. See the auth block below. 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. defaultAuthScheme Default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database. Valid values are NONE and IAM_AUTH. Defaults to NONE. endpointNetworkType Network type of the DB proxy endpoint. Valid values are IPV4, IPV6 and DUAL. Defaults to IPV4. If IPV6 is specified, the subnets associated with the proxy must be IPv6-only, and targetConnectionNetworkType must be IPV6. engineFamily 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, specify POSTGRESQL. For RDS for Microsoft SQL Server, specify SQLSERVER. Valid values are MYSQL, POSTGRESQL, and SQLSERVER. idleClientTimeout 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. name 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. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. requireTls Whether TLS encryption is required for connections to the proxy. Enabling this setting enforces encrypted TLS connections to the proxy. roleArn ARN of the IAM role that the proxy uses to access secrets in AWS Secrets Manager. tags Map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level. targetConnectionNetworkType Network type that the proxy uses to connect to the target database. Valid values are IPV4 and IPV6. Defaults to IPV4. vpcSecurityGroupIds One or more VPC security group IDs to associate with the new proxy. vpcSubnetIds One or more VPC subnet IDs to associate with the new proxy.
const
ProxyArgs.fromMap(Map<String, dynamic> map)
factory

Properties

auths → Input<List<ProxyAuth>?>?
Configuration block(s) with authorization mechanisms to connect to the associated instances or clusters. Required when defaultAuthScheme is NONE or unspecified. See the auth block below.
final
debugLogging → Input<bool?>?
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.
final
defaultAuthScheme → Input<String?>?
Default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database. Valid values are NONE and IAM_AUTH. Defaults to NONE.
final
endpointNetworkType → Input<String?>?
Network type of the DB proxy endpoint. Valid values are IPV4, IPV6 and DUAL. Defaults to IPV4. If IPV6 is specified, the subnets associated with the proxy must be IPv6-only, and targetConnectionNetworkType must be IPV6.
final
engineFamily → Input<String>
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, specify POSTGRESQL. For RDS for Microsoft SQL Server, specify SQLSERVER. Valid values are MYSQL, POSTGRESQL, and SQLSERVER.
final
hashCode → int
The hash code for this object.
no setterinherited
idleClientTimeout → Input<int?>?
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.
final
name → Input<String?>?
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.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
requireTls → Input<bool?>?
Whether TLS encryption is required for connections to the proxy. Enabling this setting enforces encrypted TLS connections to the proxy.
final
roleArn → Input<String>
ARN of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tags → Input<Map<String, String>?>?
Map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
final
targetConnectionNetworkType → Input<String?>?
Network type that the proxy uses to connect to the target database. Valid values are IPV4 and IPV6. Defaults to IPV4.
final
vpcSecurityGroupIds → Input<List<String>?>?
One or more VPC security group IDs to associate with the new proxy.
final
vpcSubnetIds → Input<List<String>>
One or more VPC subnet IDs to associate with the new proxy.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited