Skip to main content

RDS Proxy

Add an RDS Proxy resource to your Altostra project

The RDS Proxy resource creates an AWS RDS Proxy.
To add an RDS Proxy resource in the designer, go to the "Database" section and select the "RDS Proxy" resource, or search "proxy" in the search box:

RDS Proxy Resource

RDS Proxy properties

RDS Proxy parameters

Name:

type: string | required

  • Altostra will use Name property for generating a logical ID:
    • Only strict alpha-numeric characters will be used (by the restrictions of CFN)
    • If non alpha-numeric characters were used in the name, the logical ID will be generated by the resource type
    • Up to 64 characters

Security Group IDs:

type: string | required

  • A comma separated list of the VPC security group IDs to associate to the RDS Proxy.

Subnet IDs:

type: string | required

  • A comma separated list of at least two VPC subnet IDs to associate to the RDS Proxy.

Advanced Parameters:

Advanced
Idle Client Connection Timeout:

type: integer | optional

  • 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.
Connection Borrow Timeout:

type: integer | allowed values: 0-3,600 | default: 120 | optional

  • The number of seconds for a proxy to wait for a connection to become available in the connection pool. Only applies when the proxy has opened its maximum number of connections and all connections are busy with client sessions.
Max Connections Percent:

type: integer | allowed values: 1-100 | default: 100 | required if Max Idle Connections Percent is set

  • The maximum size of the connection pool for the RDS Proxy target. The value is expressed as a percentage of the max_connections setting for the RDS Instance or Aurora Cluster targeted by the proxy.

    If you specify Max Idle Connections Percent, then you must also include a value for this parameter.
Max Idle Connections Percent:

type: integer | allowed values: 1-100 | default: 50 | optional

  • Controls how actively the proxy closes idle database connections in the connection pool. The value is expressed as a percentage of the max_connections setting for the RDS Instance or Aurora Cluster targeted by the proxy. With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database.

    If you specify this parameter, then you must also include a value for Max Connections Percent.

RDS Proxy connections:

RDS Proxy resource connections

The RDS Proxy can connect to the following resources:

  • Database
    • Aurora Cluster
    • RDS Instance

Ready to Get Started?

Get Started for Free
© 2023 Altostra, Inc.