create_db_cluster_snapshot¶
Operation¶
create_db_cluster_snapshot
¶
create_db_cluster_snapshot(request: CreateDBClusterSnapshotInput | CreateDBClusterSnapshotInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateDBClusterSnapshotInputDict]) -> CreateDBClusterSnapshotOutput
Creates a snapshot of a DB cluster.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
CreateDBClusterSnapshotInput | CreateDBClusterSnapshotInputDict | 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[CreateDBClusterSnapshotInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
CreateDBClusterSnapshotOutput
|
An instance of |
create_db_cluster_snapshot
async
¶
create_db_cluster_snapshot(request: CreateDBClusterSnapshotInput | CreateDBClusterSnapshotInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateDBClusterSnapshotInputDict]) -> CreateDBClusterSnapshotOutput
Creates a snapshot of a DB cluster.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
CreateDBClusterSnapshotInput | CreateDBClusterSnapshotInputDict | 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[CreateDBClusterSnapshotInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
CreateDBClusterSnapshotOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
CreateDBClusterSnapshotInputDict
¶
Bases: TypedDict
Dictionary form of CreateDBClusterSnapshotInput.
Attributes¶
db_cluster_identifier
instance-attribute
¶
The identifier of the DB cluster to create a snapshot for. This parameter isn't case-sensitive.
Constraints:
- Must match the identifier of an existing DBCluster.
Example: my-cluster1
db_cluster_snapshot_identifier
instance-attribute
¶
The identifier of the DB cluster snapshot. This parameter is stored as a lowercase string.
Constraints:
-
Must contain from 1 to 63 letters, numbers, or hyphens.
-
First character must be a letter.
-
Can't end with a hyphen or contain two consecutive hyphens.
Example: my-cluster1-snapshot1
CreateDBClusterSnapshotInput
dataclass
¶
Bases: _SerdeShape
Attributes¶
db_cluster_identifier
class-attribute
instance-attribute
¶
db_cluster_identifier: str | None = ...
The identifier of the DB cluster to create a snapshot for. This parameter isn't case-sensitive.
Constraints:
- Must match the identifier of an existing DBCluster.
Example: my-cluster1
db_cluster_snapshot_identifier
class-attribute
instance-attribute
¶
db_cluster_snapshot_identifier: str | None = ...
The identifier of the DB cluster snapshot. This parameter is stored as a lowercase string.
Constraints:
-
Must contain from 1 to 63 letters, numbers, or hyphens.
-
First character must be a letter.
-
Can't end with a hyphen or contain two consecutive hyphens.
Example: my-cluster1-snapshot1
Output¶
CreateDBClusterSnapshotOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for CreateDBClusterSnapshotOutput structure.
Attributes¶
db_cluster_snapshot
class-attribute
instance-attribute
¶
db_cluster_snapshot: DBClusterSnapshot | None = ...
Contains the details for an Amazon RDS DB cluster snapshot
This data type is used as a response element in the
DescribeDBClusterSnapshots action.
response_metadata
class-attribute
instance-attribute
¶
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.