AWS API Changes

2024/09/23 - Amazon Relational Database Service - 5 updated api methods

Changes Support ComputeRedundancy parameter in ModifyDBShardGroup API. Add DBShardGroupArn in DBShardGroup API response. Remove InvalidMaxAcuFault from CreateDBShardGroup and ModifyDBShardGroup API. Both API will throw InvalidParameterValueException for invalid ACU configuration.

CreateDBShardGroup (updated)

Link ¶
Changes (response)

{'DBShardGroupArn': 'string'}

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

client.create_db_shard_group(
    DBShardGroupIdentifier='string',
    DBClusterIdentifier='string',
    ComputeRedundancy=123,
    MaxACU=123.0,
    MinACU=123.0,
    PubliclyAccessible=True|False
)

type DBShardGroupIdentifier:

string

param DBShardGroupIdentifier:

[REQUIRED]

The name of the DB shard group.

type DBClusterIdentifier:

string

param DBClusterIdentifier:

[REQUIRED]

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

type ComputeRedundancy:

integer

param ComputeRedundancy:

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.

type MaxACU:

float

param MaxACU:

[REQUIRED]

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

type MinACU:

float

param MinACU:

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

type PubliclyAccessible:

boolean

param PubliclyAccessible:

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.

rtype:

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'
}

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.

DeleteDBShardGroup (updated)

Link ¶
Changes (response)

{'DBShardGroupArn': 'string'}

Deletes an Aurora Limitless Database DB shard group.

See also: AWS API Documentation

Request Syntax

client.delete_db_shard_group(
    DBShardGroupIdentifier='string'
)

type DBShardGroupIdentifier:

string

param DBShardGroupIdentifier:

[REQUIRED]

Teh name of the DB shard group to delete.

rtype:

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'
}

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.

DescribeDBShardGroups (updated)

Link ¶
Changes (response)

{'DBShardGroups': {'DBShardGroupArn': 'string'}}

Describes existing Aurora Limitless Database DB shard groups.

See also: AWS API Documentation

Request Syntax

client.describe_db_shard_groups(
    DBShardGroupIdentifier='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    Marker='string',
    MaxRecords=123
)

type DBShardGroupIdentifier:

string

param DBShardGroupIdentifier:

The user-supplied DB shard group identifier or the Amazon Resource Name (ARN) of the DB shard group. 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.

type Filters:

list

param Filters:

A filter that specifies one or more DB shard groups to describe.

(dict) --

A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.

Note

Currently, wildcards are not supported in filters.

The following actions can be filtered:
- DescribeDBClusterBacktracks
- DescribeDBClusterEndpoints
- DescribeDBClusters
- DescribeDBInstances
- DescribeDBRecommendations
- DescribeDBShardGroups
- DescribePendingMaintenanceActions
- Name (string) -- [REQUIRED]
  
  The name of the filter. Filter names are case-sensitive.
- Values (list) -- [REQUIRED]
  
  One or more filter values. Filter values are case-sensitive.
  - (string) --

type Marker:

string

param Marker:

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.

type MaxRecords:

integer

param MaxRecords:

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

rtype:

dict

returns:

Response Syntax

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

Response Structure

(dict) --
- DBShardGroups (list) --
  
  Contains a list of DB shard groups for the user.
  - (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.
- Marker (string) --
  
  A pagination token that can be used in a later DescribeDBClusters request.

ModifyDBShardGroup (updated)

Link ¶
Changes (request, response)
Request

{'ComputeRedundancy': 'integer'}

Response

{'DBShardGroupArn': 'string'}

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.

See also: AWS API Documentation

Request Syntax

client.modify_db_shard_group(
    DBShardGroupIdentifier='string',
    MaxACU=123.0,
    MinACU=123.0,
    ComputeRedundancy=123
)

type DBShardGroupIdentifier:

string

param DBShardGroupIdentifier:

[REQUIRED]

The name of the DB shard group to modify.

type MaxACU:

float

param MaxACU:

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

type MinACU:

float

param MinACU:

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

type ComputeRedundancy:

integer

param ComputeRedundancy:

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.

rtype:

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'
}

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.

RebootDBShardGroup (updated)

Link ¶
Changes (response)

{'DBShardGroupArn': 'string'}

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.

See also: AWS API Documentation

Request Syntax

client.reboot_db_shard_group(
    DBShardGroupIdentifier='string'
)

type DBShardGroupIdentifier:

string

param DBShardGroupIdentifier:

[REQUIRED]

The name of the DB shard group to reboot.

rtype:

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'
}

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.