RDS / Client / create_db_shard_group

create_db_shard_group

RDS.Client.create_db_shard_group(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.create_db_shard_group(
    DBShardGroupIdentifier='string',
    DBClusterIdentifier='string',
    ComputeRedundancy=123,
    MaxACU=123.0,
    MinACU=123.0,
    PubliclyAccessible=True|False,
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters:

• DBShardGroupIdentifier (string) –

  [REQUIRED]

  The name of the DB shard group.

• DBClusterIdentifier (string) –

  [REQUIRED]

  The name of the primary DB cluster for the DB shard group.

• 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.

• MaxACU (float) –

  [REQUIRED]

  The maximum capacity of the DB shard group in Aurora capacity units (ACUs).

• MinACU (float) – 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 (list) –

  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.

  • (dict) –

    Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

    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.

    • Key (string) –

      A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can’t be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘:’, ‘/’, ‘=’, ‘+’, ‘-’, ‘@’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$”).

    • Value (string) –

      A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can’t be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘:’, ‘/’, ‘=’, ‘+’, ‘-’, ‘@’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$”).

Return type:

dict

Returns:

Response Syntax

{
    'DBShardGroupResourceId': 'string',
    'DBShardGroupIdentifier': 'string',
    'DBClusterIdentifier': 'string',
    'MaxACU': 123.0,
    'MinACU': 123.0,
    'ComputeRedundancy': 123,
    'Status': 'string',
    'PubliclyAccessible': True|False,
    'Endpoint': 'string',
    'DBShardGroupArn': 'string',
    'TagList': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • DBShardGroupResourceId (string) –

    The Amazon Web Services Region-unique, immutable identifier for the DB shard group.

  • DBShardGroupIdentifier (string) –

    The name of the DB shard group.

  • DBClusterIdentifier (string) –

    The name of the primary DB cluster for the DB shard group.

  • MaxACU (float) –

    The maximum capacity of the DB shard group in Aurora capacity units (ACUs).

  • MinACU (float) –

    The minimum capacity of the DB shard group in Aurora capacity units (ACUs).

  • 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.

  • Status (string) –

    The status of the DB shard group.

  • PubliclyAccessible (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.

  • Endpoint (string) –

    The connection endpoint for the DB shard group.

  • DBShardGroupArn (string) –

    The Amazon Resource Name (ARN) for the DB shard group.

  • TagList (list) –

    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.

    • (dict) –

      Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

      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.

      • Key (string) –

        A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can’t be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘:’, ‘/’, ‘=’, ‘+’, ‘-’, ‘@’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$”).

      • Value (string) –

        A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can’t be prefixed with aws: or rds:. The string can only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘:’, ‘/’, ‘=’, ‘+’, ‘-’, ‘@’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$”).

Exceptions

• RDS.Client.exceptions.DBShardGroupAlreadyExistsFault

• RDS.Client.exceptions.DBClusterNotFoundFault

• RDS.Client.exceptions.MaxDBShardGroupLimitReached

• RDS.Client.exceptions.InvalidDBClusterStateFault

• RDS.Client.exceptions.UnsupportedDBEngineVersionFault

• RDS.Client.exceptions.InvalidVPCNetworkStateFault

• RDS.Client.exceptions.NetworkTypeNotSupported