Skip to content

RDS  >  Operations  >  modify_db_shard_group

modify_db_shard_group

Operation

modify_db_shard_group async

modify_db_shard_group(request: ModifyDBShardGroupInput | ModifyDBShardGroupInputDict, /, *, plugins: list[Plugin] | None = None) -> ModifyDBShardGroupOutput
modify_db_shard_group(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[ModifyDBShardGroupInputDict]) -> ModifyDBShardGroupOutput

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.

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
ModifyDBShardGroupOutput

An instance of ModifyDBShardGroupOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

ModifyDBShardGroupInput dataclass

Bases: _SerdeShape

Dataclass for ModifyDBShardGroupInput structure.

Attributes
compute_redundancy class-attribute instance-attribute
compute_redundancy: int | None = ...

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_shard_group_identifier class-attribute instance-attribute
db_shard_group_identifier: str | None = ...

The name of the DB shard group to modify.

max_acu class-attribute instance-attribute
max_acu: float | None = ...

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

min_acu class-attribute instance-attribute
min_acu: float | None = ...

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

Dictionaries

ModifyDBShardGroupInputDict

Bases: TypedDict

Dictionary form of ModifyDBShardGroupInput.

Attributes
compute_redundancy instance-attribute
compute_redundancy: int | None

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_shard_group_identifier instance-attribute
db_shard_group_identifier: Required[str]

The name of the DB shard group to modify.

max_acu instance-attribute
max_acu: float | None

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

min_acu instance-attribute
min_acu: float | None

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

Output

ModifyDBShardGroupOutput dataclass

Bases: _SerdeShape

Contains the details for an Amazon RDS DB shard group.

Attributes

compute_redundancy class-attribute instance-attribute
compute_redundancy: int | None = ...

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 class-attribute instance-attribute
db_cluster_identifier: str | None = ...

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

db_shard_group_arn class-attribute instance-attribute
db_shard_group_arn: str | None = ...

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

db_shard_group_identifier class-attribute instance-attribute
db_shard_group_identifier: str | None = ...

The name of the DB shard group.

db_shard_group_resource_id class-attribute instance-attribute
db_shard_group_resource_id: str | None = ...

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

endpoint class-attribute instance-attribute
endpoint: str | None = ...

The connection endpoint for the DB shard group.

max_acu class-attribute instance-attribute
max_acu: float | None = ...

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

min_acu class-attribute instance-attribute
min_acu: float | None = ...

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

publicly_accessible class-attribute instance-attribute
publicly_accessible: bool | None = ...

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.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

status class-attribute instance-attribute
status: str | None = ...

The status of the DB shard group.

tag_list class-attribute instance-attribute
tag_list: list[Tag] | None = ...

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.