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	Creates a new DB shard group for Aurora Limitless Database. You must enable Aurora Limitless Database to create a DB shard group. Valid for: Aurora DB clusters only
Id	awscc.rds.db_shard_groups

Fields

Name	Datatype	Description
db_shard_group_resource_id	string
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 standby DB data access shard for the DB shard group. Valid values are the following:<br />+ 0 - Creates a DB shard group without a standby DB data access shard. This is the default value.<br />+ 1 - Creates a DB shard group with a standby DB data access shard in a different Availability Zone (AZ).<br />+ 2 - Creates a DB shard group with two standby DB data access shard in two different AZs.
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	Specifies whether the DB shard group is publicly accessible.<br />When the DB shard group is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB shard group's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB shard group's VPC. Access to the DB shard group is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB shard group doesn't permit it.<br />When the DB shard group isn't publicly accessible, it is an internal DB shard group with a DNS name that resolves to a private IP address.<br />Default: The default behavior varies depending on whether &#96;&#96;DBSubnetGroupName&#96;&#96; is specified.<br />If &#96;&#96;DBSubnetGroupName&#96;&#96; isn't specified, and &#96;&#96;PubliclyAccessible&#96;&#96; isn't specified, the following applies:<br />+ If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB shard group is private.<br />+ If the default VPC in the target Region has an internet gateway attached to it, the DB shard group is public.<br /><br />If &#96;&#96;DBSubnetGroupName&#96;&#96; is specified, and &#96;&#96;PubliclyAccessible&#96;&#96; isn't specified, the following applies:<br />+ If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB shard group is private.<br />+ If the subnets are part of a VPC that has an internet gateway attached to it, the DB shard group is public.
endpoint	string
▶tags	array	An optional set of key-value pairs to associate arbitrary data of your choosing with the DB shard group.
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 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 awscc.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 awscc.rds.db_shard_groups (
 DBClusterIdentifier,
 MaxACU,
 region
)
SELECT 
'{{ DBClusterIdentifier }}',
 '{{ MaxACU }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.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 awscc.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