Create Db Proxy Endpoint

rds_create_db_proxy_endpoint

R Documentation

Creates a DBProxyEndpoint¶

Description¶

Creates a DBProxyEndpoint. Only applies to proxies that are associated with Aurora DB clusters. You can use DB proxy endpoints to specify read/write or read-only access to the DB cluster. You can also use DB proxy endpoints to access a DB proxy through a different VPC than the proxy's default VPC.

Usage¶

rds_create_db_proxy_endpoint(DBProxyName, DBProxyEndpointName,
  VpcSubnetIds, VpcSecurityGroupIds, TargetRole, Tags)

Arguments¶

DBProxyName

[required] The name of the DB proxy associated with the DB proxy endpoint that you create.

DBProxyEndpointName

[required] The name of the DB proxy endpoint to create.

VpcSubnetIds

[required] The VPC subnet IDs for the DB proxy endpoint that you create. You can specify a different set of subnet IDs than for the original DB proxy.

VpcSecurityGroupIds

The VPC security group IDs for the DB proxy endpoint that you create. You can specify a different set of security group IDs than for the original DB proxy. The default is the default security group for the VPC.

TargetRole

The role of the DB proxy endpoint. The role determines whether the endpoint can be used for read/write or only read operations. The default is READ_WRITE. The only role that proxies for RDS for Microsoft SQL Server support is READ_WRITE.

Tags

Value¶

A list with the following syntax:

list(
  DBProxyEndpoint = list(
    DBProxyEndpointName = "string",
    DBProxyEndpointArn = "string",
    DBProxyName = "string",
    Status = "available"|"modifying"|"incompatible-network"|"insufficient-resource-limits"|"creating"|"deleting",
    VpcId = "string",
    VpcSecurityGroupIds = list(
      "string"
    ),
    VpcSubnetIds = list(
      "string"
    ),
    Endpoint = "string",
    CreatedDate = as.POSIXct(
      "2015-01-01"
    ),
    TargetRole = "READ_WRITE"|"READ_ONLY",
    IsDefault = TRUE|FALSE
  )
)

Request syntax¶

svc$create_db_proxy_endpoint(
  DBProxyName = "string",
  DBProxyEndpointName = "string",
  VpcSubnetIds = list(
    "string"
  ),
  VpcSecurityGroupIds = list(
    "string"
  ),
  TargetRole = "READ_WRITE"|"READ_ONLY",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)