aws_rds_proxy_target_group

account_id

Type: STRING

connection_pool_config

Type: STRUCT
Provider name: ConnectionPoolConfig
Description: The settings that determine the size and behavior of the connection pool for the target group.

  • connection_borrow_timeout
    Type: INT32
    Provider name: ConnectionBorrowTimeout
    Description: 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.
  • init_query
    Type: STRING
    Provider name: InitQuery
    Description: One or more SQL statements for the proxy to run when opening each new database connection. Typically used with SET statements to make sure that each connection has identical settings such as time zone and character set. This setting is empty by default. For multiple statements, use semicolons as the separator. You can also include multiple variables in a single SET statement, such as SET x=1, y=2.
  • max_connections_percent
    Type: INT32
    Provider name: MaxConnectionsPercent
    Description: The maximum size of the connection pool for each target in a target group. The value is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB cluster used by the target group.
  • max_idle_connections_percent
    Type: INT32
    Provider name: MaxIdleConnectionsPercent
    Description: 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 DB instance or Aurora DB cluster used by the target group. 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.
  • session_pinning_filters
    Type: UNORDERED_LIST_STRING
    Provider name: SessionPinningFilters
    Description: Each item in the list represents a class of SQL operations that normally cause all later statements in a session using a proxy to be pinned to the same underlying database connection. Including an item in the list exempts that class of SQL operations from the pinning behavior. This setting is only supported for MySQL engine family databases. Currently, the only allowed value is EXCLUDE_VARIABLE_SETS.

created_date

Type: TIMESTAMP
Provider name: CreatedDate
Description: The date and time when the target group was first created.

db_proxy_name

Type: STRING
Provider name: DBProxyName
Description: The identifier for the RDS proxy associated with this target group.

is_default

Type: BOOLEAN
Provider name: IsDefault
Description: Indicates whether this target group is the first one used for connection requests by the associated proxy. Because each proxy is currently associated with a single target group, currently this setting is always true.

status

Type: STRING
Provider name: Status
Description: The current status of this target group. A status of available means the target group is correctly associated with a database. Other values indicate that you must wait for the target group to be ready, or take some action to resolve an issue.

tags

Type: UNORDERED_LIST_STRING

target_group_arn

Type: STRING
Provider name: TargetGroupArn
Description: The Amazon Resource Name (ARN) representing the target group.

target_group_name

Type: STRING
Provider name: TargetGroupName
Description: The identifier for the target group. This name must be unique for all target groups owned by your Amazon Web Services account in the specified Amazon Web Services Region.

targets

Type: UNORDERED_LIST_STRUCT
Provider name: Targets
Description: An arbitrary number of DBProxyTarget objects, containing details of the corresponding targets.

  • endpoint
    Type: STRING
    Provider name: Endpoint
    Description: The writer endpoint for the RDS DB instance or Aurora DB cluster.
  • port
    Type: INT32
    Provider name: Port
    Description: The port that the RDS Proxy uses to connect to the target RDS DB instance or Aurora DB cluster.
  • rds_resource_id
    Type: STRING
    Provider name: RdsResourceId
    Description: The identifier representing the target. It can be the instance identifier for an RDS DB instance, or the cluster identifier for an Aurora DB cluster.
  • role
    Type: STRING
    Provider name: Role
    Description: A value that indicates whether the target of the proxy can be used for read/write or read-only operations.
  • target_arn
    Type: STRING
    Provider name: TargetArn
    Description: The Amazon Resource Name (ARN) for the RDS DB instance or Aurora DB cluster.
  • target_health
    Type: STRUCT
    Provider name: TargetHealth
    Description: Information about the connection health of the RDS Proxy target.
    • description
      Type: STRING
      Provider name: Description
      Description: A description of the health of the RDS Proxy target. If the State is AVAILABLE, a description is not included.
    • reason
      Type: STRING
      Provider name: Reason
      Description: The reason for the current health State of the RDS Proxy target.
    • state
      Type: STRING
      Provider name: State
      Description: The current state of the connection health lifecycle for the RDS Proxy target. The following is a typical lifecycle example for the states of an RDS Proxy target: registering > unavailable > available > unavailable > available
  • tracked_cluster_id
    Type: STRING
    Provider name: TrackedClusterId
    Description: The DB cluster identifier when the target represents an Aurora DB cluster. This field is blank when the target represents an RDS DB instance.
  • type
    Type: STRING
    Provider name: Type
    Description: Specifies the kind of database, such as an RDS DB instance or an Aurora DB cluster, that the target represents.

updated_date

Type: TIMESTAMP
Provider name: UpdatedDate
Description: The date and time when the target group was last updated.