Skip to content

Create Db Proxy

rds_create_db_proxy R Documentation

Creates a new DB proxy

Description

Creates a new DB proxy.

Usage

rds_create_db_proxy(DBProxyName, EngineFamily, DefaultAuthScheme, Auth,
  RoleArn, VpcSubnetIds, VpcSecurityGroupIds, RequireTLS,
  IdleClientTimeout, DebugLogging, Tags, EndpointNetworkType,
  TargetConnectionNetworkType)

Arguments

DBProxyName

[required] 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.
EngineFamily

[required] 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.
DefaultAuthScheme

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.
Auth

The authorization mechanism that the proxy uses.
RoleArn

[required] The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in Amazon Web Services Secrets Manager.
VpcSubnetIds

[required] One or more VPC subnet IDs to associate with the new proxy.
VpcSecurityGroupIds

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

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.
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.
DebugLogging

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.
Tags

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

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 or DUAL, the VPC and all subnets must have an IPv6 CIDR block.

  • If you specify IPV6 or DUAL, the VPC tenancy cannot be dedicated.
TargetConnectionNetworkType

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.

Value

A list with the following syntax:

list(
  DBProxy = list(
    DBProxyName = "string",
    DBProxyArn = "string",
    Status = "available"|"modifying"|"incompatible-network"|"insufficient-resource-limits"|"creating"|"deleting"|"suspended"|"suspending"|"reactivating",
    EngineFamily = "string",
    VpcId = "string",
    VpcSecurityGroupIds = list(
      "string"
    ),
    VpcSubnetIds = list(
      "string"
    ),
    DefaultAuthScheme = "string",
    Auth = list(
      list(
        Description = "string",
        UserName = "string",
        AuthScheme = "SECRETS",
        SecretArn = "string",
        IAMAuth = "DISABLED"|"REQUIRED"|"ENABLED",
        ClientPasswordAuthType = "MYSQL_NATIVE_PASSWORD"|"MYSQL_CACHING_SHA2_PASSWORD"|"POSTGRES_SCRAM_SHA_256"|"POSTGRES_MD5"|"SQL_SERVER_AUTHENTICATION"
      )
    ),
    RoleArn = "string",
    Endpoint = "string",
    RequireTLS = TRUE|FALSE,
    IdleClientTimeout = 123,
    DebugLogging = TRUE|FALSE,
    CreatedDate = as.POSIXct(
      "2015-01-01"
    ),
    UpdatedDate = as.POSIXct(
      "2015-01-01"
    ),
    EndpointNetworkType = "IPV4"|"IPV6"|"DUAL",
    TargetConnectionNetworkType = "IPV4"|"IPV6"
  )
)

Request syntax

svc$create_db_proxy(
  DBProxyName = "string",
  EngineFamily = "MYSQL"|"POSTGRESQL"|"SQLSERVER",
  DefaultAuthScheme = "IAM_AUTH"|"NONE",
  Auth = list(
    list(
      Description = "string",
      UserName = "string",
      AuthScheme = "SECRETS",
      SecretArn = "string",
      IAMAuth = "DISABLED"|"REQUIRED"|"ENABLED",
      ClientPasswordAuthType = "MYSQL_NATIVE_PASSWORD"|"MYSQL_CACHING_SHA2_PASSWORD"|"POSTGRES_SCRAM_SHA_256"|"POSTGRES_MD5"|"SQL_SERVER_AUTHENTICATION"
    )
  ),
  RoleArn = "string",
  VpcSubnetIds = list(
    "string"
  ),
  VpcSecurityGroupIds = list(
    "string"
  ),
  RequireTLS = TRUE|FALSE,
  IdleClientTimeout = 123,
  DebugLogging = TRUE|FALSE,
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  EndpointNetworkType = "IPV4"|"IPV6"|"DUAL",
  TargetConnectionNetworkType = "IPV4"|"IPV6"
)