ProxyState class
Input properties used for looking up and filtering Proxy resources.
Constructors
-
ProxyState({Input<
String?> ? arn, Input<List< ? auths, Input<ProxyAuth> ?>bool?> ? debugLogging, Input<String?> ? defaultAuthScheme, Input<String?> ? endpoint, Input<String?> ? endpointNetworkType, Input<String?> ? engineFamily, Input<int?> ? idleClientTimeout, Input<String?> ? name, Input<String?> ? region, Input<bool?> ? requireTls, Input<String?> ? roleArn, Input<Map< ? tags, Input<String, String> ?>Map< ? tagsAll, Input<String, String> ?>String?> ? targetConnectionNetworkType, Input<List< ? vpcSecurityGroupIds, Input<String> ?>List< ? vpcSubnetIds})String> ?> -
Creates a new ProxyState.
arnARN for the proxy.authsConfiguration block(s) with authorization mechanisms to connect to the associated instances or clusters. Required whendefaultAuthSchemeisNONEor unspecified. See theauthblock below.debugLoggingWhether 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.defaultAuthSchemeDefault authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database. Valid values areNONEandIAM_AUTH. Defaults toNONE.endpointEndpoint that you can use to connect to the proxy. You include the endpoint value in the connection string for a database client application.endpointNetworkTypeNetwork type of the DB proxy endpoint. Valid values areIPV4,IPV6andDUAL. Defaults toIPV4. IfIPV6is specified, the subnets associated with the proxy must be IPv6-only, andtargetConnectionNetworkTypemust beIPV6.engineFamilyKinds 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, specifyMYSQL. For Aurora PostgreSQL and RDS for PostgreSQL databases, specifyPOSTGRESQL. For RDS for Microsoft SQL Server, specifySQLSERVER. Valid values areMYSQL,POSTGRESQL, andSQLSERVER.idleClientTimeoutNumber 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.nameIdentifier 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.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.requireTlsWhether TLS encryption is required for connections to the proxy. Enabling this setting enforces encrypted TLS connections to the proxy.roleArnARN of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.tagsMap of tags to assign to the resource. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.tagsAllMap of tags assigned to the resource, including those inherited from the providerdefaultTagsconfiguration block.targetConnectionNetworkTypeNetwork type that the proxy uses to connect to the target database. Valid values areIPV4andIPV6. Defaults toIPV4.vpcSecurityGroupIdsOne or more VPC security group IDs to associate with the new proxy.vpcSubnetIdsOne or more VPC subnet IDs to associate with the new proxy.const -
ProxyState.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
arn
→ Input<
String?> ? -
ARN for the proxy.
final
-
auths
→ Input<
List< ?ProxyAuth> ?> -
Configuration block(s) with authorization mechanisms to connect to the associated instances or clusters. Required when
defaultAuthSchemeisNONEor unspecified. See theauthblock 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
NONEandIAM_AUTH. Defaults toNONE.final -
endpoint
→ Input<
String?> ? -
Endpoint that you can use to connect to the proxy. You include the endpoint value in the connection string for a database client application.
final
-
endpointNetworkType
→ Input<
String?> ? -
Network type of the DB proxy endpoint. Valid values are
IPV4,IPV6andDUAL. Defaults toIPV4. IfIPV6is specified, the subnets associated with the proxy must be IPv6-only, andtargetConnectionNetworkTypemust beIPV6.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, specifyPOSTGRESQL. For RDS for Microsoft SQL Server, specifySQLSERVER. Valid values areMYSQL,POSTGRESQL, andSQLSERVER.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
-
Map of tags to assign to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final -
Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.final -
targetConnectionNetworkType
→ Input<
String?> ? -
Network type that the proxy uses to connect to the target database. Valid values are
IPV4andIPV6. Defaults toIPV4.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