promote_read_replica_db_cluster¶
Operation¶
promote_read_replica_db_cluster
¶
promote_read_replica_db_cluster(request: PromoteReadReplicaDBClusterInput | PromoteReadReplicaDBClusterInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[PromoteReadReplicaDBClusterInputDict]) -> PromoteReadReplicaDBClusterOutput
Promotes a read replica DB cluster to a standalone DB cluster.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
PromoteReadReplicaDBClusterInput | PromoteReadReplicaDBClusterInputDict | 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[PromoteReadReplicaDBClusterInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
PromoteReadReplicaDBClusterOutput
|
An instance of |
promote_read_replica_db_cluster
async
¶
promote_read_replica_db_cluster(request: PromoteReadReplicaDBClusterInput | PromoteReadReplicaDBClusterInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[PromoteReadReplicaDBClusterInputDict]) -> PromoteReadReplicaDBClusterOutput
Promotes a read replica DB cluster to a standalone DB cluster.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
PromoteReadReplicaDBClusterInput | PromoteReadReplicaDBClusterInputDict | 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[PromoteReadReplicaDBClusterInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
PromoteReadReplicaDBClusterOutput
|
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.
PromoteReadReplicaDBClusterInput
dataclass
¶
Bases: _SerdeShape
Attributes¶
db_cluster_identifier
class-attribute
instance-attribute
¶
db_cluster_identifier: str | None = ...
The identifier of the DB cluster read replica to promote. This parameter isn't case-sensitive.
Constraints:
- Must match the identifier of an existing DB cluster read replica.
Example: my-cluster-replica1
Output¶
PromoteReadReplicaDBClusterOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for PromoteReadReplicaDBClusterOutput 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
¶
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.