Class: Aws::RDS::Types::CreateDBProxyRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::RDS::Types::CreateDBProxyRequest
- Defined in:
- gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#auth ⇒ Array<Types::UserAuthConfig>
The authorization mechanism that the proxy uses.
-
#db_proxy_name ⇒ String
The identifier for the proxy.
-
#debug_logging ⇒ Boolean
Specifies whether the proxy logs detailed connection and query information.
-
#default_auth_scheme ⇒ String
The default authentication scheme that the proxy uses for client connections to the proxy and connections from the proxy to the underlying database.
-
#endpoint_network_type ⇒ String
The network type of the DB proxy endpoint.
-
#engine_family ⇒ String
The kinds of databases that the proxy can connect to.
-
#idle_client_timeout ⇒ Integer
The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it.
-
#require_tls ⇒ Boolean
Specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
-
#role_arn ⇒ String
The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.
-
#tags ⇒ Array<Types::Tag>
An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
-
#target_connection_network_type ⇒ String
The network type that the proxy uses to connect to the target database.
-
#vpc_security_group_ids ⇒ Array<String>
One or more VPC security group IDs to associate with the new proxy.
-
#vpc_subnet_ids ⇒ Array<String>
One or more VPC subnet IDs to associate with the new proxy.
Instance Attribute Details
#auth ⇒ Array<Types::UserAuthConfig>
The authorization mechanism that the proxy uses.
6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6151 class CreateDBProxyRequest < Struct.new( :db_proxy_name, :engine_family, :default_auth_scheme, :auth, :role_arn, :vpc_subnet_ids, :vpc_security_group_ids, :require_tls, :idle_client_timeout, :debug_logging, :tags, :endpoint_network_type, :target_connection_network_type) SENSITIVE = [] include Aws::Structure end |
#db_proxy_name ⇒ String
The identifier for the proxy. This name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services 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.
6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6151 class CreateDBProxyRequest < Struct.new( :db_proxy_name, :engine_family, :default_auth_scheme, :auth, :role_arn, :vpc_subnet_ids, :vpc_security_group_ids, :require_tls, :idle_client_timeout, :debug_logging, :tags, :endpoint_network_type, :target_connection_network_type) SENSITIVE = [] include Aws::Structure end |
#debug_logging ⇒ Boolean
Specifies whether the proxy logs detailed connection and query
information. When you enable DebugLogging
, the proxy captures
connection details and connection pool behavior from your queries.
Debug logging increases CloudWatch costs and can impact proxy
performance. Enable this option only when you need to troubleshoot
connection or performance issues.
6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6151 class CreateDBProxyRequest < Struct.new( :db_proxy_name, :engine_family, :default_auth_scheme, :auth, :role_arn, :vpc_subnet_ids, :vpc_security_group_ids, :require_tls, :idle_client_timeout, :debug_logging, :tags, :endpoint_network_type, :target_connection_network_type) SENSITIVE = [] include Aws::Structure end |
#default_auth_scheme ⇒ String
The 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
. When
set to IAM_AUTH
, the proxy uses end-to-end IAM authentication to
connect to the database. If you don't specify DefaultAuthScheme
or specify this parameter as NONE
, you must specify the Auth
option.
6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6151 class CreateDBProxyRequest < Struct.new( :db_proxy_name, :engine_family, :default_auth_scheme, :auth, :role_arn, :vpc_subnet_ids, :vpc_security_group_ids, :require_tls, :idle_client_timeout, :debug_logging, :tags, :endpoint_network_type, :target_connection_network_type) SENSITIVE = [] include Aws::Structure end |
#endpoint_network_type ⇒ String
The network type of the DB proxy endpoint. The network type determines the IP version that the proxy endpoint supports.
Valid values:
IPV4
- The proxy endpoint supports IPv4 only.IPV6
- The proxy endpoint supports IPv6 only.DUAL
- The proxy endpoint supports both IPv4 and IPv6.
Default: IPV4
Constraints:
If you specify
IPV6
orDUAL
, the VPC and all subnets must have an IPv6 CIDR block.If you specify
IPV6
orDUAL
, the VPC tenancy cannot bededicated
.
6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6151 class CreateDBProxyRequest < Struct.new( :db_proxy_name, :engine_family, :default_auth_scheme, :auth, :role_arn, :vpc_subnet_ids, :vpc_security_group_ids, :require_tls, :idle_client_timeout, :debug_logging, :tags, :endpoint_network_type, :target_connection_network_type) SENSITIVE = [] include Aws::Structure end |
#engine_family ⇒ String
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,
specify POSTGRESQL
. For RDS for Microsoft SQL Server, specify
SQLSERVER
.
6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6151 class CreateDBProxyRequest < Struct.new( :db_proxy_name, :engine_family, :default_auth_scheme, :auth, :role_arn, :vpc_subnet_ids, :vpc_security_group_ids, :require_tls, :idle_client_timeout, :debug_logging, :tags, :endpoint_network_type, :target_connection_network_type) SENSITIVE = [] include Aws::Structure end |
#idle_client_timeout ⇒ Integer
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.
6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6151 class CreateDBProxyRequest < Struct.new( :db_proxy_name, :engine_family, :default_auth_scheme, :auth, :role_arn, :vpc_subnet_ids, :vpc_security_group_ids, :require_tls, :idle_client_timeout, :debug_logging, :tags, :endpoint_network_type, :target_connection_network_type) SENSITIVE = [] include Aws::Structure end |
#require_tls ⇒ Boolean
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.
6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6151 class CreateDBProxyRequest < Struct.new( :db_proxy_name, :engine_family, :default_auth_scheme, :auth, :role_arn, :vpc_subnet_ids, :vpc_security_group_ids, :require_tls, :idle_client_timeout, :debug_logging, :tags, :endpoint_network_type, :target_connection_network_type) SENSITIVE = [] include Aws::Structure end |
#role_arn ⇒ String
The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.
6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6151 class CreateDBProxyRequest < Struct.new( :db_proxy_name, :engine_family, :default_auth_scheme, :auth, :role_arn, :vpc_subnet_ids, :vpc_security_group_ids, :require_tls, :idle_client_timeout, :debug_logging, :tags, :endpoint_network_type, :target_connection_network_type) SENSITIVE = [] include Aws::Structure end |
#tags ⇒ Array<Types::Tag>
An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6151 class CreateDBProxyRequest < Struct.new( :db_proxy_name, :engine_family, :default_auth_scheme, :auth, :role_arn, :vpc_subnet_ids, :vpc_security_group_ids, :require_tls, :idle_client_timeout, :debug_logging, :tags, :endpoint_network_type, :target_connection_network_type) SENSITIVE = [] include Aws::Structure end |
#target_connection_network_type ⇒ String
The network type that the proxy uses to connect to the target database. The network type determines the IP version that the proxy uses for connections to the database.
Valid values:
IPV4
- The proxy connects to the database using IPv4 only.IPV6
- The proxy connects to the database using IPv6 only.
Default: IPV4
Constraints:
If you specify
IPV6
, the database must support dual-stack mode. RDS doesn't support IPv6-only databases.All targets registered with the proxy must be compatible with the specified network type.
6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6151 class CreateDBProxyRequest < Struct.new( :db_proxy_name, :engine_family, :default_auth_scheme, :auth, :role_arn, :vpc_subnet_ids, :vpc_security_group_ids, :require_tls, :idle_client_timeout, :debug_logging, :tags, :endpoint_network_type, :target_connection_network_type) SENSITIVE = [] include Aws::Structure end |
#vpc_security_group_ids ⇒ Array<String>
One or more VPC security group IDs to associate with the new proxy.
6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6151 class CreateDBProxyRequest < Struct.new( :db_proxy_name, :engine_family, :default_auth_scheme, :auth, :role_arn, :vpc_subnet_ids, :vpc_security_group_ids, :require_tls, :idle_client_timeout, :debug_logging, :tags, :endpoint_network_type, :target_connection_network_type) SENSITIVE = [] include Aws::Structure end |
#vpc_subnet_ids ⇒ Array<String>
One or more VPC subnet IDs to associate with the new proxy.
6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 |
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 6151 class CreateDBProxyRequest < Struct.new( :db_proxy_name, :engine_family, :default_auth_scheme, :auth, :role_arn, :vpc_subnet_ids, :vpc_security_group_ids, :require_tls, :idle_client_timeout, :debug_logging, :tags, :endpoint_network_type, :target_connection_network_type) SENSITIVE = [] include Aws::Structure end |