Deleting a Multi-AZ DB cluster

Sample Response

<Engine>aurora5.6</Engine>

<Status>available</Status>

<DBSubnetGroup>my-subgroup</DBSubnetGroup>

<Endpoint>sample-cluster2.cluster-cbfvmgb0y5fy.us-east-1.rds.amazonaws.com</Endpoint>

<DBClusterIdentifier>sample-cluster2</DBClusterIdentifier>

<MasterUsername>awsuser</MasterUsername>

</DBCluster>

</DeleteDBClusterResult>

</ResponseMetadata>

</DeleteDBClusterResponse>

This example illustrates one usage of DeleteDBCluster.

Sample Request

https://rds.us-west-2.amazonaws.com/

?Action=DeleteDBCluster

&DBClusterIdentifier=my-multi-az-cluster &SkipFinalSnapshot=true

Examples

&SignatureMethod=HmacSHA256 &SignatureVersion=4

&Version=2014-10-31

&X-Amz-Algorithm=AWS4-HMAC-SHA256

&X-Amz-Credential=AKIADQKE4SARGYLE/20140725/us-west-2/rds/aws4_request &X-Amz-Date=20211027T000821Z

&X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date &X-Amz-Signature=815910f78c5a9813e1c15300fcf206e04da071b3586770169765292dc6aa2ed4

Sample Response

<CrossAccountClone>false</CrossAccountClone>

<MasterUsername>admin</MasterUsername>

<HttpEndpointEnabled>false</HttpEndpointEnabled>

<DBClusterIdentifier>my-multi-az-cluster</DBClusterIdentifier>

<DbClusterResourceId>cluster-XDHARXDLDCRL2VZZXKBCFN3RQI</DbClusterResourceId>

<Status>available</Status>

<DeletionProtection>false</DeletionProtection>

<Endpoint>my-multi-az-cluster.cluster-123456789012.us-west-2.rds.amazonaws.com</

Endpoint>

<EngineMode>provisioned</EngineMode>

<Engine>mysql</Engine>

<ReaderEndpoint>my-multi-az-cluster.cluster-ro-123456789012.us-west-2.rds.amazonaws.com</ReaderEndpoint>

<IAMDatabaseAuthenticationEnabled>false</IAMDatabaseAuthenticationEnabled>

<PerformanceInsightsEnabled>false</PerformanceInsightsEnabled>

<MultiAZ>false</MultiAZ>

<StorageEncrypted>false</StorageEncrypted>

<DBSubnetGroup>subnetgroup1</DBSubnetGroup>

<Status>active</Status>

</VpcSecurityGroupMembership>

</VpcSecurityGroups>

<HostedZoneId>Z3GZ3VYA3PGHTQ</HostedZoneId>

<DBClusterParameterGroup>default.mysql8.0</DBClusterParameterGroup>

<DBClusterInstanceClass>db.r6gd.xlarge</DBClusterInstanceClass>

<CopyTagsToSnapshot>false</CopyTagsToSnapshot>

<DBClusterArn>arn:aws:rds:us-west-2:123456789012:cluster:my-multi-az-cluster</

DBClusterArn>

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 743).

DBClusterEndpointIdentiﬁer

The identiﬁer associated with the custom endpoint. This parameter is stored as a lowercase string.

Type: String Required: Yes

Response Elements

The following elements are returned by the service.

CustomEndpointType

The type associated with a custom endpoint. One of: READER, WRITER, ANY.

Type: String DBClusterEndpointArn

The Amazon Resource Name (ARN) for the endpoint.

Type: String

DBClusterEndpointIdentiﬁer

The identiﬁer associated with the endpoint. This parameter is stored as a lowercase string.

Type: String

DBClusterEndpointResourceIdentiﬁer

A unique system-generated identiﬁer for an endpoint. It remains the same for the whole life of the endpoint.

Type: String DBClusterIdentiﬁer

The DB cluster identiﬁer of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

Type: String Endpoint

The DNS address of the endpoint.

Type: String

Errors

EndpointType

The type of the endpoint. One of: READER, WRITER, CUSTOM.

Type: String

ExcludedMembers.member.N

List of DB instance identiﬁers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.

Type: Array of strings StaticMembers.member.N

List of DB instance identiﬁers that are part of the custom endpoint group.

Type: Array of strings Status

The current status of the endpoint. One of: creating, available, deleting, inactive, modifying. The inactive state applies to an endpoint that can't be used for a certain kind of cluster, such as a writer endpoint for a read-only secondary cluster in a global database.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors (p. 745).

DBClusterEndpointNotFoundFault

The speciﬁed custom endpoint doesn't exist.

HTTP Status Code: 400

InvalidDBClusterEndpointStateFault

The requested operation can't be performed on the endpoint while the endpoint is in this state.

HTTP Status Code: 400 InvalidDBClusterStateFault

The requested operation can't be performed while the cluster is in this state.

HTTP Status Code: 400

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 743).

DBClusterParameterGroupName

The name of the DB cluster parameter group.

Constraints:

• Must be the name of an existing DB cluster parameter group.

• You can't delete a default DB cluster parameter group.

• Can't be associated with any DB clusters.

Type: String Required: Yes

Errors

For information about the errors that are common to all actions, see Common Errors (p. 745).

DBParameterGroupNotFound

DBParameterGroupName doesn't refer to an existing DB parameter group.

HTTP Status Code: 404 InvalidDBParameterGroupState

The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you can't delete it when the parameter group is in this state.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of DeleteDBClusterParameterGroup.

Sample Request

https://rds.us-west-2.amazonaws.com/

Sample Response

</ResponseMetadata>

</DeleteDBClusterParameterGroupResponse>

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 743).

DBClusterSnapshotIdentiﬁer

The identiﬁer of the DB cluster snapshot to delete.

Constraints: Must be the name of an existing DB cluster snapshot in the available state.

Type: String Required: Yes

Response Elements

The following element is returned by the service.

DBClusterSnapshot

Contains the details for an Amazon RDS DB cluster snapshot

This data type is used as a response element in the DescribeDBClusterSnapshots action.

Type: DBClusterSnapshot (p. 609) object

Errors

For information about the errors that are common to all actions, see Common Errors (p. 745).

DBClusterSnapshotNotFoundFault

DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.

HTTP Status Code: 404

InvalidDBClusterSnapshotStateFault

The supplied value isn't a valid DB cluster snapshot state.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of DeleteDBClusterSnapshot.

Sample Request

https://rds.us-east-1.amazonaws.com/

?Action=DeleteDBClusterSnapshot

&DBClusterSnapshotIdentifier=sample-cluster-snapshot &SignatureMethod=HmacSHA256

&SignatureVersion=4 &Version=2014-10-31

&X-Amz-Algorithm=AWS4-HMAC-SHA256

&X-Amz-Credential=AKIADQKE4SARGYLE/20150318/us-east-1/rds/aws4_request &X-Amz-Date=20150318T215614Z

&X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date &X-Amz-Signature=7aaab0a295151051bc4723f5b1f7b6b535615b8db9256bd56993c4dc6df4c2c4

Sample Response

<Status>available</Status>

<Engine>aurora</Engine>

<SnapshotType>manual</SnapshotType>

<LicenseModel>aurora</LicenseModel>

<DBClusterSnapshotIdentifier>sample-cluster-snapshot</DBClusterSnapshotIdentifier>

<DBClusterIdentifier>sample-cluster</DBClusterIdentifier>

<VpcId>vpc-3fabee54</VpcId>

<MasterUsername>awsuser</MasterUsername>

</DBClusterSnapshot>

</DeleteDBClusterSnapshotResult>

</ResponseMetadata>

</DeleteDBClusterSnapshotResponse>

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 743).

DBInstanceIdentiﬁer

The DB instance identiﬁer for the DB instance to be deleted. This parameter isn't case-sensitive.

Constraints:

• Must match the name of an existing DB instance.

Type: String Required: Yes

DeleteAutomatedBackups

A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted.

Type: Boolean Required: No

FinalDBSnapshotIdentiﬁer

The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot parameter is disabled.

NoteIf you enable this parameter and also enable SkipFinalShapshot, the command results in an error.

This setting doesn't apply to RDS Custom.

Response Elements

Constraints:

• Must be 1 to 255 letters or numbers.

• First character must be a letter.

• Can't end with a hyphen or contain two consecutive hyphens.

• Can't be speciﬁed when deleting a read replica.

Type: String Required: No SkipFinalSnapshot

A value that indicates whether to skip the creation of a ﬁnal DB snapshot before deleting the instance. If you enable this parameter, RDS doesn't create a DB snapshot. If you don't enable this parameter, RDS creates a DB snapshot before the DB instance is deleted. By default, skip isn't enabled, and the DB snapshot is created.

NoteIf you don't enable this parameter, you must specify the FinalDBSnapshotIdentifier parameter.

When a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, RDS can delete the instance only if you enable this parameter.

If you delete a read replica or an RDS Custom instance, you must enable this setting.

This setting is required for RDS Custom.

Type: Boolean Required: No

Response Elements

The following element is returned by the service.

DBInstance

Contains the details of an Amazon RDS DB instance.

This data type is used as a response element in the operations CreateDBInstance, CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, ModifyDBInstance, PromoteReadReplica, RebootDBInstance,

RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3,

RestoreDBInstanceToPointInTime, StartDBInstance, and StopDBInstance.

Type: DBInstance (p. 619) object

Errors

For information about the errors that are common to all actions, see Common Errors (p. 745).

DBInstanceAutomatedBackupQuotaExceeded

The quota for retained automated backups was exceeded. This prevents you from retaining any additional automated backups. The retained automated backups quota is the same as your DB Instance quota.

Examples

HTTP Status Code: 400 DBInstanceNotFound

DBInstanceIdentifier doesn't refer to an existing DB instance.

HTTP Status Code: 404 DBSnapshotAlreadyExists

DBSnapshotIdentifier is already used by an existing snapshot.

HTTP Status Code: 400 InvalidDBClusterStateFault

The requested operation can't be performed while the cluster is in this state.

HTTP Status Code: 400 InvalidDBInstanceState

The DB instance isn't in a valid state.

HTTP Status Code: 400 SnapshotQuotaExceeded

The request would result in the user exceeding the allowed number of DB snapshots.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of DeleteDBInstance.

Sample Request

https://rds.us-east-1.amazonaws.com/

?Action=DeleteDBInstance

&DBInstanceIdentifier=mydatabase &SignatureMethod=HmacSHA256 &SignatureVersion=4

&SkipFinalSnapshot=true &Version=2014-09-01

&X-Amz-Algorithm=AWS4-HMAC-SHA256

&X-Amz-Credential=AKIADQKE4SARGYLE/20131109/us-east-1/rds/aws4_request &X-Amz-Date=20131109T001924Z

&X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date &X-Amz-Signature=70e774e243c0fbb7ffe84029637005bf543e9e321cdf432c0b272be5687d32d8

Sample Response

<DBInstanceStatus>deleting</DBInstanceStatus>

<MultiAZ>false</MultiAZ>

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 743).

DBInstanceAutomatedBackupsArn

The Amazon Resource Name (ARN) of the automated backups to delete, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.

This setting doesn't apply to RDS Custom.

Type: String Required: No DbiResourceId

The identiﬁer for the source DB instance, which can't be changed and which is unique to an AWS Region.

Type: String Required: No

Response Elements

The following element is returned by the service.

DBInstanceAutomatedBackup

An automated backup of a DB instance. It consists of system backups, transaction logs, and the database instance properties that existed at the time you deleted the source instance.

Type: DBInstanceAutomatedBackup (p. 630) object

Errors

For information about the errors that are common to all actions, see Common Errors (p. 745).

DBInstanceAutomatedBackupNotFound

No automated backup for this DB instance was found.

在文檔中 Amazon Relational Database Service API Reference API Version 2014-10-31 (頁 181-200)

Deleting a Multi-AZ DB cluster

Sample Response