Skip to content

delete_global_cluster

Operation

delete_global_cluster

delete_global_cluster(request: DeleteGlobalClusterInput | DeleteGlobalClusterInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteGlobalClusterInputDict]) -> DeleteGlobalClusterOutput

Deletes a global database cluster. The primary and secondary clusters must already be detached or destroyed first.

Note

This action only applies to Aurora DB clusters.

Parameters:

Name Type Description Default
request DeleteGlobalClusterInput | DeleteGlobalClusterInputDict | 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[DeleteGlobalClusterInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteGlobalClusterOutput

An instance of DeleteGlobalClusterOutput.

delete_global_cluster async

delete_global_cluster(request: DeleteGlobalClusterInput | DeleteGlobalClusterInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteGlobalClusterInputDict]) -> DeleteGlobalClusterOutput

Deletes a global database cluster. The primary and secondary clusters must already be detached or destroyed first.

Note

This action only applies to Aurora DB clusters.

Parameters:

Name Type Description Default
request DeleteGlobalClusterInput | DeleteGlobalClusterInputDict | 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[DeleteGlobalClusterInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteGlobalClusterOutput

An instance of DeleteGlobalClusterOutput.

Input

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

DeleteGlobalClusterInputDict

Bases: TypedDict

Dictionary form of DeleteGlobalClusterInput.

Attributes

global_cluster_identifier instance-attribute
global_cluster_identifier: Required[str]

The cluster identifier of the global database cluster being deleted.

DeleteGlobalClusterInput dataclass

Bases: _SerdeShape

Dataclass for DeleteGlobalClusterInput structure.

Attributes

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

The cluster identifier of the global database cluster being deleted.

Output

DeleteGlobalClusterOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteGlobalClusterOutput structure.

Attributes

global_cluster class-attribute instance-attribute
global_cluster: GlobalCluster | None = ...

A data type representing an Aurora global 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.