Skip to content

RDS  >  Operations  >  delete_blue_green_deployment

delete_blue_green_deployment

Operation

delete_blue_green_deployment async

delete_blue_green_deployment(request: DeleteBlueGreenDeploymentInput | DeleteBlueGreenDeploymentInputDict, /, *, plugins: list[Plugin] | None = None) -> DeleteBlueGreenDeploymentOutput
delete_blue_green_deployment(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteBlueGreenDeploymentInputDict]) -> DeleteBlueGreenDeploymentOutput

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.

Parameters:

Name Type Description Default
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

Returns:

Type Description
DeleteBlueGreenDeploymentOutput

An instance of DeleteBlueGreenDeploymentOutput.

Input

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

Model

DeleteBlueGreenDeploymentInput dataclass

Bases: _SerdeShape

Dataclass for DeleteBlueGreenDeploymentInput structure.

Attributes
blue_green_deployment_identifier class-attribute instance-attribute
blue_green_deployment_identifier: str | None = ...

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

Constraints:

  • Must match an existing blue/green deployment identifier.
delete_target class-attribute instance-attribute
delete_target: bool | None = ...

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

Dictionaries

DeleteBlueGreenDeploymentInputDict

Bases: TypedDict

Dictionary form of DeleteBlueGreenDeploymentInput.

Attributes
blue_green_deployment_identifier instance-attribute
blue_green_deployment_identifier: Required[str]

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

Constraints:

  • Must match an existing blue/green deployment identifier.
delete_target instance-attribute
delete_target: bool | None

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

Output

DeleteBlueGreenDeploymentOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteBlueGreenDeploymentOutput structure.

Attributes

blue_green_deployment class-attribute instance-attribute
blue_green_deployment: BlueGreenDeployment | None = ...

Details about 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.

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.