Skip to content

stop_db_cluster

Operation

stop_db_cluster

stop_db_cluster(request: StopDBClusterInput | StopDBClusterInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[StopDBClusterInputDict]) -> StopDBClusterOutput

Stops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster's metadata, including its endpoints and DB parameter groups. Aurora also retains the transaction logs so you can do a point-in-time restore if necessary.

For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.

Note

This operation only applies to Aurora DB clusters.

Parameters:

Name Type Description Default
request StopDBClusterInput | StopDBClusterInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[StopDBClusterInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
StopDBClusterOutput

An instance of StopDBClusterOutput.

stop_db_cluster async

stop_db_cluster(request: StopDBClusterInput | StopDBClusterInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[StopDBClusterInputDict]) -> StopDBClusterOutput

Stops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster's metadata, including its endpoints and DB parameter groups. Aurora also retains the transaction logs so you can do a point-in-time restore if necessary.

For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.

Note

This operation only applies to Aurora DB clusters.

Parameters:

Name Type Description Default
request StopDBClusterInput | StopDBClusterInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[StopDBClusterInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
StopDBClusterOutput

An instance of StopDBClusterOutput.

Input

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

StopDBClusterInputDict

Bases: TypedDict

Dictionary form of StopDBClusterInput.

Attributes

db_cluster_identifier instance-attribute
db_cluster_identifier: Required[str]

The DB cluster identifier of the Amazon Aurora DB cluster to be stopped. This parameter is stored as a lowercase string.

StopDBClusterInput dataclass

Bases: _SerdeShape

Dataclass for StopDBClusterInput structure.

Attributes

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

The DB cluster identifier of the Amazon Aurora DB cluster to be stopped. This parameter is stored as a lowercase string.

Output

StopDBClusterOutput dataclass

Bases: _SerdeShape

Dataclass for StopDBClusterOutput structure.

Attributes

db_cluster class-attribute instance-attribute
db_cluster: DBCluster | None = ...

Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.

For an Amazon Aurora DB cluster, this data type is used as a response element in the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster, ModifyDBCluster, PromoteReadReplicaDBCluster, RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot, RestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster.

For a Multi-AZ DB cluster, this data type is used as a response element in the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster, ModifyDBCluster, RebootDBCluster, RestoreDBClusterFromSnapshot, and RestoreDBClusterToPointInTime.

For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

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.