db_shard_groups

Creates, updates, deletes or gets a db_shard_group resource or lists db_shard_groups in a region

Overview

Name	db_shard_groups
Type	Resource
Description	The AWS::RDS::DBShardGroup resource creates an Amazon Aurora Limitless DB Shard Group.
Id	aws.rds.db_shard_groups

Fields

Name	Datatype	Description
db_shard_group_resource_id	string	The Amazon Web Services Region-unique, immutable identifier for the DB shard group.
db_shard_group_identifier	string	The name of the DB shard group.
db_cluster_identifier	string	The name of the primary DB cluster for the DB shard group.
compute_redundancy	integer	Specifies whether to create standby instances for the DB shard group.
max_ac_u	number	The maximum capacity of the DB shard group in Aurora capacity units (ACUs).
min_ac_u	number	The minimum capacity of the DB shard group in Aurora capacity units (ACUs).
publicly_accessible	boolean	Indicates whether the DB shard group is publicly accessible.
endpoint	string	The connection endpoint for the DB shard group.
tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

For more information, see AWS::RDS::DBShardGroup.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	DBClusterIdentifier, MaxACU, 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_shard_groups in a region.

SELECT
region,
db_shard_group_resource_id,
db_shard_group_identifier,
db_cluster_identifier,
compute_redundancy,
max_ac_u,
min_ac_u,
publicly_accessible,
endpoint,
tags
FROM aws.rds.db_shard_groups
WHERE region = 'us-east-1';

Gets all properties from an individual db_shard_group.

SELECT
region,
db_shard_group_resource_id,
db_shard_group_identifier,
db_cluster_identifier,
compute_redundancy,
max_ac_u,
min_ac_u,
publicly_accessible,
endpoint,
tags
FROM aws.rds.db_shard_groups
WHERE region = 'us-east-1' AND data__Identifier = '<DBShardGroupIdentifier>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.rds.db_shard_groups (
 DBClusterIdentifier,
 MaxACU,
 region
)
SELECT 
'{{ DBClusterIdentifier }}',
 '{{ MaxACU }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.rds.db_shard_groups (
 DBShardGroupIdentifier,
 DBClusterIdentifier,
 ComputeRedundancy,
 MaxACU,
 MinACU,
 PubliclyAccessible,
 Tags,
 region
)
SELECT 
 '{{ DBShardGroupIdentifier }}',
 '{{ DBClusterIdentifier }}',
 '{{ ComputeRedundancy }}',
 '{{ MaxACU }}',
 '{{ MinACU }}',
 '{{ PubliclyAccessible }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: db_shard_group
    props:
      - name: DBShardGroupIdentifier
        value: '{{ DBShardGroupIdentifier }}'
      - name: DBClusterIdentifier
        value: '{{ DBClusterIdentifier }}'
      - name: ComputeRedundancy
        value: '{{ ComputeRedundancy }}'
      - name: MaxACU
        value: null
      - name: MinACU
        value: null
      - name: PubliclyAccessible
        value: '{{ PubliclyAccessible }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

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

Permissions

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

Create

rds:AddTagsToResource,
rds:CreateDBShardGroup,
rds:DescribeDBClusters,
rds:DescribeDBShardGroups,
rds:ListTagsForResource

Read

rds:DescribeDBShardGroups,
rds:ListTagsForResource

Update

rds:AddTagsToResource,
rds:DescribeDBShardGroups,
rds:DescribeDBClusters,
rds:RemoveTagsFromResource,
rds:ModifyDBShardGroup,
rds:ListTagsForResource

Delete

rds:DeleteDBShardGroup,
rds:DescribeDBClusters,
rds:DescribeDbShardGroups

List

rds:DescribeDBShardGroups,
rds:ListTagsForResource