Class: Aws::RDS::Types::CreateDBProxyRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb

Overview

Note:

When making an API call, you may pass CreateDBProxyRequest data as a hash:

{
  db_proxy_name: "String", # required
  engine_family: "MYSQL", # required, accepts MYSQL, POSTGRESQL
  auth: [ # required
    {
      description: "String",
      user_name: "String",
      auth_scheme: "SECRETS", # accepts SECRETS
      secret_arn: "String",
      iam_auth: "DISABLED", # accepts DISABLED, REQUIRED
    },
  ],
  role_arn: "String", # required
  vpc_subnet_ids: ["String"], # required
  vpc_security_group_ids: ["String"],
  require_tls: false,
  idle_client_timeout: 1,
  debug_logging: false,
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#authArray<Types::UserAuthConfig>

The authorization mechanism that the proxy uses.

Returns:



4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4185

class CreateDBProxyRequest < Struct.new(
  :db_proxy_name,
  :engine_family,
  :auth,
  :role_arn,
  :vpc_subnet_ids,
  :vpc_security_group_ids,
  :require_tls,
  :idle_client_timeout,
  :debug_logging,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#db_proxy_nameString

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.

Returns:

  • (String)


4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4185

class CreateDBProxyRequest < Struct.new(
  :db_proxy_name,
  :engine_family,
  :auth,
  :role_arn,
  :vpc_subnet_ids,
  :vpc_security_group_ids,
  :require_tls,
  :idle_client_timeout,
  :debug_logging,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#debug_loggingBoolean

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.

Returns:

  • (Boolean)


4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4185

class CreateDBProxyRequest < Struct.new(
  :db_proxy_name,
  :engine_family,
  :auth,
  :role_arn,
  :vpc_subnet_ids,
  :vpc_security_group_ids,
  :require_tls,
  :idle_client_timeout,
  :debug_logging,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#engine_familyString

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. The engine family applies to MySQL and PostgreSQL for both RDS and Aurora.

Returns:

  • (String)


4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4185

class CreateDBProxyRequest < Struct.new(
  :db_proxy_name,
  :engine_family,
  :auth,
  :role_arn,
  :vpc_subnet_ids,
  :vpc_security_group_ids,
  :require_tls,
  :idle_client_timeout,
  :debug_logging,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#idle_client_timeoutInteger

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.

Returns:

  • (Integer)


4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4185

class CreateDBProxyRequest < Struct.new(
  :db_proxy_name,
  :engine_family,
  :auth,
  :role_arn,
  :vpc_subnet_ids,
  :vpc_security_group_ids,
  :require_tls,
  :idle_client_timeout,
  :debug_logging,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#require_tlsBoolean

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.

Returns:

  • (Boolean)


4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4185

class CreateDBProxyRequest < Struct.new(
  :db_proxy_name,
  :engine_family,
  :auth,
  :role_arn,
  :vpc_subnet_ids,
  :vpc_security_group_ids,
  :require_tls,
  :idle_client_timeout,
  :debug_logging,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#role_arnString

The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.

Returns:

  • (String)


4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4185

class CreateDBProxyRequest < Struct.new(
  :db_proxy_name,
  :engine_family,
  :auth,
  :role_arn,
  :vpc_subnet_ids,
  :vpc_security_group_ids,
  :require_tls,
  :idle_client_timeout,
  :debug_logging,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.

Returns:



4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4185

class CreateDBProxyRequest < Struct.new(
  :db_proxy_name,
  :engine_family,
  :auth,
  :role_arn,
  :vpc_subnet_ids,
  :vpc_security_group_ids,
  :require_tls,
  :idle_client_timeout,
  :debug_logging,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_security_group_idsArray<String>

One or more VPC security group IDs to associate with the new proxy.

Returns:

  • (Array<String>)


4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4185

class CreateDBProxyRequest < Struct.new(
  :db_proxy_name,
  :engine_family,
  :auth,
  :role_arn,
  :vpc_subnet_ids,
  :vpc_security_group_ids,
  :require_tls,
  :idle_client_timeout,
  :debug_logging,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_subnet_idsArray<String>

One or more VPC subnet IDs to associate with the new proxy.

Returns:

  • (Array<String>)


4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4185

class CreateDBProxyRequest < Struct.new(
  :db_proxy_name,
  :engine_family,
  :auth,
  :role_arn,
  :vpc_subnet_ids,
  :vpc_security_group_ids,
  :require_tls,
  :idle_client_timeout,
  :debug_logging,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end