BlueGreenDeployment
Contains the 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.
Contents
Note
In the following list, the required parameters are described first.
- BlueGreenDeploymentIdentifier
-
The system-generated identifier of the blue/green deployment.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[A-Za-z][0-9A-Za-z-:._]*Required: No
- BlueGreenDeploymentName
-
The user-supplied name of the blue/green deployment.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 60.
Pattern:
[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*Required: No
- CreateTime
-
Specifies the time when the blue/green deployment was created, in Universal Coordinated Time (UTC).
Type: Timestamp
Required: No
- DeleteTime
-
Specifies the time when the blue/green deployment was deleted, in Universal Coordinated Time (UTC).
Type: Timestamp
Required: No
- Source
-
The source database for the blue/green deployment.
Before switchover, the source database is the production database in the blue environment.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^arn:[A-Za-z][0-9A-Za-z-:._]*Required: No
- Status
-
The status of the blue/green deployment.
Values:
-
PROVISIONING- Resources are being created in the green environment. -
AVAILABLE- Resources are available in the green environment. -
SWITCHOVER_IN_PROGRESS- The deployment is being switched from the blue environment to the green environment. -
SWITCHOVER_COMPLETED- Switchover from the blue environment to the green environment is complete. -
INVALID_CONFIGURATION- Resources in the green environment are invalid, so switchover isn't possible. -
SWITCHOVER_FAILED- Switchover was attempted but failed. -
DELETING- The blue/green deployment is being deleted.
Type: String
Required: No
-
- StatusDetails
-
Additional information about the status of the blue/green deployment.
Type: String
Required: No
- SwitchoverDetails.member.N
-
The details about each source and target resource in the blue/green deployment.
Type: Array of SwitchoverDetail objects
Required: No
- TagList.Tag.N
-
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
Type: Array of Tag objects
Required: No
- Target
-
The target database for the blue/green deployment.
Before switchover, the target database is the clone database in the green environment.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^arn:[A-Za-z][0-9A-Za-z-:._]*Required: No
- Tasks.member.N
-
Either tasks to be performed or tasks that have been completed on the target database before switchover.
Type: Array of BlueGreenDeploymentTask objects
Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: