db_shard_groups

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

Overview

Name	`db_shard_groups`
Type	Resource
Id	`aws.rds.db_shard_groups`

Fields

The following fields are returned by SELECT queries:

describe_db_shard_groups

Name	Datatype	Description
`compute_redundancy`	`integer`	Specifies whether to create standby DB shard groups for the DB shard group. Valid values are the following: 0 - Creates a DB shard group without a standby DB shard group. This is the default value. 1 - Creates a DB shard group with a standby DB shard group in a different Availability Zone (AZ). 2 - Creates a DB shard group with two standby DB shard groups in two different AZs.
`db_cluster_identifier`	`string`	The name of the primary DB cluster for the DB shard group.
`db_shard_group_arn`	`string`	The Amazon Resource Name (ARN) for the DB shard group.
`db_shard_group_identifier`	`string`	The name of the DB shard group.
`db_shard_group_resource_id`	`string`	The Amazon Web Services Region-unique, immutable identifier for the DB shard group.
`endpoint`	`string`	The connection endpoint for the DB shard group.
`max_acu`	`number`	The maximum capacity of the DB shard group in Aurora capacity units (ACUs).
`min_acu`	`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. 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 isn't permitted if the security group assigned to the DB shard group doesn't permit it. 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. For more information, see CreateDBShardGroup. This setting is only for Aurora Limitless Database.
`status`	`string`	The status of the DB shard group.
`tag_list`	`string`	A list of tags. For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`describe_db_shard_groups`	`select`	`region`	`DBShardGroupIdentifier`, `Filters`, `Marker`, `MaxRecords`	Describes existing Aurora Limitless Database DB shard groups.
`create_db_shard_group`	`insert`	`DBShardGroupIdentifier`, `DBClusterIdentifier`, `MaxACU`, `region`	`ComputeRedundancy`, `MinACU`, `PubliclyAccessible`, `Tags`	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
`modify_db_shard_group`	`update`	`DBShardGroupIdentifier`, `region`	`MaxACU`, `MinACU`, `ComputeRedundancy`	Modifies the settings of an Aurora Limitless Database DB shard group. You can change one or more settings by specifying these parameters and the new values in the request.
`delete_db_shard_group`	`delete`	`DBShardGroupIdentifier`, `region`		Deletes an Aurora Limitless Database DB shard group.
`reboot_db_shard_group`	`exec`	`DBShardGroupIdentifier`, `region`		You might need to reboot your DB shard group, usually for maintenance reasons. For example, if you make certain modifications, reboot the DB shard group for the changes to take effect. This operation applies only to Aurora Limitless Database DBb shard groups.

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
`DBClusterIdentifier`	`string`	The name of the primary DB cluster for the DB shard group.
`DBShardGroupIdentifier`	`string`	The name of the DB shard group to reboot.
`MaxACU`	`number (double)`	The maximum capacity of the DB shard group in Aurora capacity units (ACUs).
`region`	`string`	AWS region (default: us-east-1)
`ComputeRedundancy`	`integer`	Specifies whether to create standby DB shard groups for the DB shard group. Valid values are the following: 0 - Creates a DB shard group without a standby DB shard group. This is the default value. 1 - Creates a DB shard group with a standby DB shard group in a different Availability Zone (AZ). 2 - Creates a DB shard group with two standby DB shard groups in two different AZs.
`DBShardGroupIdentifier`	`string`	The user-supplied DB shard group identifier. If this parameter is specified, information for only the specific DB shard group is returned. This parameter isn't case-sensitive. Constraints: If supplied, must match an existing DB shard group identifier.
`Filters`	`array`	A filter that specifies one or more DB shard groups to describe.
`Marker`	`string`	An optional pagination token provided by a previous DescribeDBShardGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
`MaxACU`	`number (double)`	The maximum capacity of the DB shard group in Aurora capacity units (ACUs).
`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 you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100
`MinACU`	`number (double)`	The minimum capacity of the DB shard group in Aurora capacity units (ACUs).
`PubliclyAccessible`	`boolean`	Specifies whether the DB shard group is publicly accessible. 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. 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. Default: The default behavior varies depending on whether DBSubnetGroupName is specified. If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies: If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB shard group is private. If the default VPC in the target Region has an internet gateway attached to it, the DB shard group is public. If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies: If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB shard group is private. If the subnets are part of a VPC that has an internet gateway attached to it, the DB shard group is public.
`Tags`	`array`

`SELECT` examples

describe_db_shard_groups

Describes existing Aurora Limitless Database DB shard groups.

SELECT
compute_redundancy,
db_cluster_identifier,
db_shard_group_arn,
db_shard_group_identifier,
db_shard_group_resource_id,
endpoint,
max_acu,
min_acu,
publicly_accessible,
status,
tag_list
FROM aws.rds.db_shard_groups
WHERE region = '{{ region }}' -- required
AND DBShardGroupIdentifier = '{{ DBShardGroupIdentifier }}'
AND Filters = '{{ Filters }}'
AND Marker = '{{ Marker }}'
AND MaxRecords = '{{ MaxRecords }}'
;

`INSERT` examples

create_db_shard_group
Manifest

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

INSERT INTO aws.rds.db_shard_groups (
DBShardGroupIdentifier,
DBClusterIdentifier,
MaxACU,
region,
ComputeRedundancy,
MinACU,
PubliclyAccessible,
Tags
)
SELECT 
'{{ DBShardGroupIdentifier }}',
'{{ DBClusterIdentifier }}',
'{{ MaxACU }}',
'{{ region }}',
'{{ ComputeRedundancy }}',
'{{ MinACU }}',
'{{ PubliclyAccessible }}',
'{{ Tags }}'
RETURNING
compute_redundancy,
db_cluster_identifier,
db_shard_group_arn,
db_shard_group_identifier,
db_shard_group_resource_id,
endpoint,
max_acu,
min_acu,
publicly_accessible,
status,
tag_list
;

# Description fields are for documentation purposes
- name: db_shard_groups
props:
  - name: DBShardGroupIdentifier
    value: "{{ DBShardGroupIdentifier }}"
    description: Required parameter for the db_shard_groups resource.
  - name: DBClusterIdentifier
    value: "{{ DBClusterIdentifier }}"
    description: Required parameter for the db_shard_groups resource.
  - name: MaxACU
    value: "{{ MaxACU }}"
    description: Required parameter for the db_shard_groups resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the db_shard_groups resource.
  - name: ComputeRedundancy
    value: {{ ComputeRedundancy }}
    description: Specifies whether to create standby standby DB data access shard for the DB shard group. Valid values are the following: 0 - Creates a DB shard group without a standby DB data access shard. This is the default value. 1 - Creates a DB shard group with a standby DB data access shard in a different Availability Zone (AZ). 2 - Creates a DB shard group with two standby DB data access shard in two different AZs.
    description: Specifies whether to create standby standby DB data access shard for the DB shard group. Valid values are the following: 0 - Creates a DB shard group without a standby DB data access shard. This is the default value. 1 - Creates a DB shard group with a standby DB data access shard in a different Availability Zone (AZ). 2 - Creates a DB shard group with two standby DB data access shard in two different AZs.
  - name: MinACU
    value: "{{ MinACU }}"
    description: The minimum capacity of the DB shard group in Aurora capacity units (ACUs).
    description: The minimum capacity of the DB shard group in Aurora capacity units (ACUs).
  - name: PubliclyAccessible
    value: {{ PubliclyAccessible }}
    description: Specifies whether the DB shard group is publicly accessible. 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. 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. Default: The default behavior varies depending on whether DBSubnetGroupName is specified. If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies: If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB shard group is private. If the default VPC in the target Region has an internet gateway attached to it, the DB shard group is public. If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies: If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB shard group is private. If the subnets are part of a VPC that has an internet gateway attached to it, the DB shard group is public.
    description: Specifies whether the DB shard group is publicly accessible. 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. 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. Default: The default behavior varies depending on whether DBSubnetGroupName is specified. If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies: If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB shard group is private. If the default VPC in the target Region has an internet gateway attached to it, the DB shard group is public. If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies: If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB shard group is private. If the subnets are part of a VPC that has an internet gateway attached to it, the DB shard group is public.
  - name: Tags
    value: "{{ Tags }}"

`UPDATE` examples

modify_db_shard_group

Modifies the settings of an Aurora Limitless Database DB shard group. You can change one or more settings by specifying these parameters and the new values in the request.

UPDATE aws.rds.db_shard_groups
SET 
-- No updatable properties
WHERE 
DBShardGroupIdentifier = '{{ DBShardGroupIdentifier }}' --required
AND region = '{{ region }}' --required
AND MaxACU = '{{ MaxACU}}'
AND MinACU = '{{ MinACU}}'
AND ComputeRedundancy = '{{ ComputeRedundancy}}'
RETURNING
compute_redundancy,
db_cluster_identifier,
db_shard_group_arn,
db_shard_group_identifier,
db_shard_group_resource_id,
endpoint,
max_acu,
min_acu,
publicly_accessible,
status,
tag_list;

`DELETE` examples

delete_db_shard_group

Deletes an Aurora Limitless Database DB shard group.

DELETE FROM aws.rds.db_shard_groups
WHERE DBShardGroupIdentifier = '{{ DBShardGroupIdentifier }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

reboot_db_shard_group

You might need to reboot your DB shard group, usually for maintenance reasons. For example, if you make certain modifications, reboot the DB shard group for the changes to take effect. This operation applies only to Aurora Limitless Database DBb shard groups.

EXEC aws.rds.db_shard_groups.reboot_db_shard_group 
@DBShardGroupIdentifier='{{ DBShardGroupIdentifier }}' --required, 
@region='{{ region }}' --required
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​

Lifecycle Methods​