db_proxy_target_groups

Creates, updates, deletes or gets a db_proxy_target_group resource or lists db_proxy_target_groups in a region

Overview

Name	db_proxy_target_groups
Type	Resource
Description	Resource schema for AWS::RDS::DBProxyTargetGroup
Id	aws.rds.db_proxy_target_groups

Fields

Name	Datatype	Description
db_proxy_name	string	The identifier for the proxy.
target_group_arn	string	The Amazon Resource Name (ARN) representing the target group.
target_group_name	string	The identifier for the DBProxyTargetGroup
connection_pool_configuration_info	object
db_instance_identifiers	array
db_cluster_identifiers	array
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	DBProxyName, TargetGroupName, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all db_proxy_target_groups in a region.

SELECT
region,
db_proxy_name,
target_group_arn,
target_group_name,
connection_pool_configuration_info,
db_instance_identifiers,
db_cluster_identifiers
FROM aws.rds.db_proxy_target_groups
WHERE region = 'us-east-1';

Gets all properties from an individual db_proxy_target_group.

SELECT
region,
db_proxy_name,
target_group_arn,
target_group_name,
connection_pool_configuration_info,
db_instance_identifiers,
db_cluster_identifiers
FROM aws.rds.db_proxy_target_groups
WHERE region = 'us-east-1' AND data__Identifier = '<TargetGroupArn>';

INSERT example

Use the following StackQL query and manifest file to create a new db_proxy_target_group resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.rds.db_proxy_target_groups (
 DBProxyName,
 TargetGroupName,
 region
)
SELECT 
'{{ DBProxyName }}',
 '{{ TargetGroupName }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.rds.db_proxy_target_groups (
 DBProxyName,
 TargetGroupName,
 ConnectionPoolConfigurationInfo,
 DBInstanceIdentifiers,
 DBClusterIdentifiers,
 region
)
SELECT 
 '{{ DBProxyName }}',
 '{{ TargetGroupName }}',
 '{{ ConnectionPoolConfigurationInfo }}',
 '{{ DBInstanceIdentifiers }}',
 '{{ DBClusterIdentifiers }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: db_proxy_target_group
    props:
      - name: DBProxyName
        value: '{{ DBProxyName }}'
      - name: TargetGroupName
        value: '{{ TargetGroupName }}'
      - name: ConnectionPoolConfigurationInfo
        value:
          MaxConnectionsPercent: '{{ MaxConnectionsPercent }}'
          MaxIdleConnectionsPercent: '{{ MaxIdleConnectionsPercent }}'
          ConnectionBorrowTimeout: '{{ ConnectionBorrowTimeout }}'
          SessionPinningFilters:
            - '{{ SessionPinningFilters[0] }}'
          InitQuery: '{{ InitQuery }}'
      - name: DBInstanceIdentifiers
        value:
          - '{{ DBInstanceIdentifiers[0] }}'
      - name: DBClusterIdentifiers
        value:
          - '{{ DBClusterIdentifiers[0] }}'

DELETE example

/*+ delete */
DELETE FROM aws.rds.db_proxy_target_groups
WHERE data__Identifier = '<TargetGroupArn>'
AND region = 'us-east-1';

Permissions

To operate on the db_proxy_target_groups resource, the following permissions are required:

Create

rds:DescribeDBProxies,
rds:DescribeDBProxyTargetGroups,
rds:ModifyDBProxyTargetGroup,
rds:RegisterDBProxyTargets

Read

rds:DescribeDBProxyTargetGroups,
rds:DescribeDBProxyTargets

Update

rds:DescribeDBProxyTargetGroups,
rds:ModifyDBProxyTargetGroup,
rds:RegisterDBProxyTargets,
rds:DeregisterDBProxyTargets

Delete

rds:DeregisterDBProxyTargets

List

rds:DescribeDBProxyTargetGroups