rds_create_db_proxy: Creates a new DB proxy

Description

Creates a new DB proxy.

Usage

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

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",
    VpcSecurityGroupIds = list(
      "string"
    ),
    VpcSubnetIds = list(
      "string"
    ),
    Auth = list(
      list(
        Description = "string",
        UserName = "string",
        AuthScheme = "SECRETS",
        SecretArn = "string",
        IAMAuth = "DISABLED"|"REQUIRED"
      )
    ),
    RoleArn = "string",
    Endpoint = "string",
    RequireTLS = TRUE|FALSE,
    IdleClientTimeout = 123,
    DebugLogging = TRUE|FALSE,
    CreatedDate = as.POSIXct(
      "2015-01-01"
    ),
    UpdatedDate = as.POSIXct(
      "2015-01-01"
    )
  )
)

Arguments

DBProxyName: [required] 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.
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. The engine family applies to MySQL and PostgreSQL for both RDS and Aurora.
Auth: [required] 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 AWS 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: 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.
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: 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.
Tags: An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.

Request syntax

svc$create_db_proxy(
  DBProxyName = "string",
  EngineFamily = "MYSQL"|"POSTGRESQL",
  Auth = list(
    list(
      Description = "string",
      UserName = "string",
      AuthScheme = "SECRETS",
      SecretArn = "string",
      IAMAuth = "DISABLED"|"REQUIRED"
    )
  ),
  RoleArn = "string",
  VpcSubnetIds = list(
    "string"
  ),
  VpcSecurityGroupIds = list(
    "string"
  ),
  RequireTLS = TRUE|FALSE,
  IdleClientTimeout = 123,
  DebugLogging = TRUE|FALSE,
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)