Request Parameters Response Elements Errors Examples See Also

DeleteBlueGreenDeployment

Deletes a blue/green deployment.

For more information, see Using Amazon RDS Blue/Green Deployments for database updates in the Amazon RDS User Guide and Using Amazon RDS Blue/Green Deployments for database updates in the Amazon Aurora User Guide.

Request Parameters

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

BlueGreenDeploymentIdentifier

The blue/green deployment identifier of the deployment to be deleted. This parameter isn't case-sensitive.

Constraints:

Must match an existing blue/green deployment identifier.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [A-Za-z][0-9A-Za-z-:._]*

Required: Yes

DeleteTarget

A value that indicates whether to delete the resources in the green environment. You can't specify this option if the blue/green deployment status is SWITCHOVER_COMPLETED.

Type: Boolean

Required: No

Response Elements

The following element is returned by the service.

BlueGreenDeployment

Contains the details about a blue/green deployment.

Type: BlueGreenDeployment object

Errors

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

BlueGreenDeploymentNotFoundFault

BlueGreenDeploymentIdentifier doesn't refer to an existing blue/green deployment.

HTTP Status Code: 404

InvalidBlueGreenDeploymentStateFault

The blue/green deployment can't be switched over or deleted because there is an invalid configuration in the green environment.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of DeleteBlueGreenDeployment.

Sample Request


https://rds.us-west-2.amazonaws.com/
   ?Action=DeleteBlueGreenDeployment
   &BlueGreenDeploymentIdentifier=bgd-mdoyy2mn7vbkhhgg
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &Version=2014-10-31
   &X-Amz-Credential=AKIADQKE4SARGYLE/20141031/us-west-2/rds/aws4_request
   &X-Amz-Date=20230110T191150Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-date
   &X-Amz-Signature=8a684aebe6d5219bb3572316a341963324d6ef339bd0dcfa5854f1a01d401214

Sample Response


<DeleteBlueGreenDeploymentResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <DeleteBlueGreenDeploymentResult>
    <BlueGreenDeployment>
      <TagList/>
      <BlueGreenDeploymentName>my-blue-green-deployment</BlueGreenDeploymentName>
      <DeleteTime>2023-01-10T19:11:51.293Z</DeleteTime>
      <CreateTime>2023-01-10T18:42:09.330Z</CreateTime>
      <SwitchoverDetails>
        <member>
          <SourceMember>arn:aws:rds:us-west-2:123456789012:db:database-1-old1</SourceMember>
          <TargetMember>arn:aws:rds:us-west-2:123456789012:db:database-1</TargetMember>
          <Status>SWITCHOVER_COMPLETED</Status>
        </member>
      </SwitchoverDetails>
      <Source>arn:aws:rds:us-west-2:123456789012:db:database-1-old1</Source>
      <BlueGreenDeploymentIdentifier>bgd-mdoyy2mn7vbkhhgg</BlueGreenDeploymentIdentifier>
      <Tasks>
        <member>
          <Name>CREATING_READ_REPLICA_OF_SOURCE</Name>
          <Status>COMPLETED</Status>
        </member>
        <member>
          <Name>CONFIGURE_BACKUPS</Name>
          <Status>COMPLETED</Status>
        </member>
      </Tasks>
      <Target>arn:aws:rds:us-west-2:123456789012:db:database-1</Target>
      <Status>DELETING</Status>
    </BlueGreenDeployment>
  </DeleteBlueGreenDeploymentResult>
  <ResponseMetadata>
    <RequestId>34deffd3-543a-4c26-9ff1-f859894f43bc</RequestId>
  </ResponseMetadata>
</DeleteBlueGreenDeploymentResponse>