db_proxy_target_groups

Creates, updates, deletes, gets or lists a db_proxy_target_groups resource.

Overview

Name	db_proxy_target_groups
Type	Resource
Id	aws.rds.db_proxy_target_groups

Fields

The following fields are returned by SELECT queries:

describe_db_proxy_target_groups

Name	Datatype	Description
connection_pool_config	string	The settings that determine the size and behavior of the connection pool for the target group.
created_date	string	The date and time when the target group was first created.
db_proxy_name	string	The identifier for the RDS proxy associated with this target group.
is_default	boolean	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	string	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.
target_group_arn	string	The Amazon Resource Name (ARN) representing the target group.
target_group_name	string	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.
updated_date	string	The date and time when the target group was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_db_proxy_target_groups	select	DBProxyName, region	TargetGroupName, Filters, Marker, MaxRecords	Returns information about DB proxy target groups, represented by DBProxyTargetGroup data structures.
modify_db_proxy_target_group	update	TargetGroupName, DBProxyName, region	ConnectionPoolConfig, NewName	Modifies the properties of a DBProxyTargetGroup.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
DBProxyName	string	The name of the proxy.
TargetGroupName	string	The name of the target group to modify.
region	string	AWS region (default: us-east-1)
ConnectionPoolConfig	object	The settings that determine the size and behavior of the connection pool for the target group.
Filters	array	This parameter is not currently supported.
Marker	string	An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
MaxRecords	integer	The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100.
NewName	string	The new name for the modified DBProxyTarget. 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. You can't rename the default target group.
TargetGroupName	string	The identifier of the DBProxyTargetGroup to describe.

SELECT examples

describe_db_proxy_target_groups

Returns information about DB proxy target groups, represented by DBProxyTargetGroup data structures.

SELECT
connection_pool_config,
created_date,
db_proxy_name,
is_default,
status,
target_group_arn,
target_group_name,
updated_date
FROM aws.rds.db_proxy_target_groups
WHERE DBProxyName = '{{ DBProxyName }}' -- required
AND region = '{{ region }}' -- required
AND TargetGroupName = '{{ TargetGroupName }}'
AND Filters = '{{ Filters }}'
AND Marker = '{{ Marker }}'
AND MaxRecords = '{{ MaxRecords }}'
;

UPDATE examples

modify_db_proxy_target_group

Modifies the properties of a DBProxyTargetGroup.

UPDATE aws.rds.db_proxy_target_groups
SET 
-- No updatable properties
WHERE 
TargetGroupName = '{{ TargetGroupName }}' --required
AND DBProxyName = '{{ DBProxyName }}' --required
AND region = '{{ region }}' --required
AND ConnectionPoolConfig = '{{ ConnectionPoolConfig}}'
AND NewName = '{{ NewName}}'
RETURNING
connection_pool_config,
created_date,
db_proxy_name,
is_default,
status,
target_group_arn,
target_group_name,
updated_date;