switchover-blue-green-deployment¶
Description¶
Switches over a blue/green deployment.
Before you switch over, production traffic is routed to the databases in the blue environment. After you switch over, production traffic is routed to the databases in the green environment.
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 .
See also: AWS API Documentation
Synopsis¶
switchover-blue-green-deployment
--blue-green-deployment-identifier <value>
[--switchover-timeout <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
Options¶
--blue-green-deployment-identifier (string)
The blue/green deployment identifier.
Constraints:
Must match an existing blue/green deployment identifier.
--switchover-timeout (integer)
The amount of time, in seconds, for the switchover to complete. The default is 300.
If the switchover takes longer than the specified duration, then any changes are rolled back, and no changes are made to the environments.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
Global Options¶
--debug (boolean)
Turn on debug logging.
--endpoint-url (string)
Override command’s default URL with the given URL.
--no-verify-ssl (boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate (boolean)
Disable automatic pagination.
--output (string)
The formatting style for command output.
json
text
table
yaml
yaml-stream
--query (string)
A JMESPath query to use in filtering the response data.
--profile (string)
Use a specific profile from your credential file.
--region (string)
The region to use. Overrides config/env settings.
--version (string)
Display the version of this tool.
--color (string)
Turn on/off color output.
on
off
auto
--no-sign-request (boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle (string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout (int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout (int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format (string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.
base64
raw-in-base64-out
--no-cli-pager (boolean)
Disable cli pager for output.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt (boolean)
Disable automatically prompt for CLI input parameters.
Examples¶
Note
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
Example 1: To switch a blue/green deployment for an RDS DB instance
The following switchover-blue-green-deployment example promotes the specified green environment as the new production environment.
aws rds switchover-blue-green-deployment \
--blue-green-deployment-identifier bgd-wi89nwzglccsfake \
--switchover-timeout 300
Output:
{
"BlueGreenDeployment": {
"BlueGreenDeploymentIdentifier": "bgd-v53303651eexfake",
"BlueGreenDeploymentName": "bgd-cli-test-instance",
"Source": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance",
"Target": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-green-blhi1e",
"SwitchoverDetails": [
{
"SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance",
"TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-green-blhi1e",
"Status": "AVAILABLE"
},
{
"SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-1",
"TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-1-green-k5fv7u",
"Status": "AVAILABLE"
},
{
"SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-2",
"TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-2-green-ggsh8m",
"Status": "AVAILABLE"
},
{
"SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-3",
"TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-3-green-o2vwm0",
"Status": "AVAILABLE"
}
],
"Tasks": [
{
"Name": "CREATING_READ_REPLICA_OF_SOURCE",
"Status": "COMPLETED"
},
{
"Name": "DB_ENGINE_VERSION_UPGRADE",
"Status": "COMPLETED"
},
{
"Name": "CONFIGURE_BACKUPS",
"Status": "COMPLETED"
},
{
"Name": "CREATING_TOPOLOGY_OF_SOURCE",
"Status": "COMPLETED"
}
],
"Status": "SWITCHOVER_IN_PROGRESS",
"CreateTime": "2022-02-25T22:33:22.225000+00:00"
}
}
For more information, see Switching a blue/green deployment in the Amazon RDS User Guide.
Example 2: To promote a blue/green deployment for an Aurora MySQL DB cluster
The following switchover-blue-green-deployment example promotes the specified green environment as the new production environment.
aws rds switchover-blue-green-deployment \
--blue-green-deployment-identifier bgd-wi89nwzglccsfake \
--switchover-timeout 300
Output:
{
"BlueGreenDeployment": {
"BlueGreenDeploymentIdentifier": "bgd-wi89nwzglccsfake",
"BlueGreenDeploymentName": "my-blue-green-deployment",
"Source": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster",
"Target": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster-green-3ud8z6",
"SwitchoverDetails": [
{
"SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster",
"TargetMember": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster-green-3ud8z6",
"Status": "AVAILABLE"
},
{
"SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-1",
"TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-1-green-bvxc73",
"Status": "AVAILABLE"
},
{
"SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-2",
"TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-2-green-7wc4ie",
"Status": "AVAILABLE"
},
{
"SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-3",
"TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-3-green-p4xxkz",
"Status": "AVAILABLE"
},
{
"SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-excluded-member-endpoint",
"TargetMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-excluded-member-endpoint-green-np1ikl",
"Status": "AVAILABLE"
},
{
"SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-reader-endpoint",
"TargetMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-reader-endpoint-green-miszlf",
"Status": "AVAILABLE"
}
],
"Tasks": [
{
"Name": "CREATING_READ_REPLICA_OF_SOURCE",
"Status": "COMPLETED"
},
{
"Name": "DB_ENGINE_VERSION_UPGRADE",
"Status": "COMPLETED"
},
{
"Name": "CREATE_DB_INSTANCES_FOR_CLUSTER",
"Status": "COMPLETED"
},
{
"Name": "CREATE_CUSTOM_ENDPOINTS",
"Status": "COMPLETED"
}
],
"Status": "SWITCHOVER_IN_PROGRESS",
"CreateTime": "2022-02-25T22:38:49.522000+00:00"
}
}
For more information, see Switching a blue/green deployment in the Amazon Aurora User Guide.
Output¶
BlueGreenDeployment -> (structure)
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 .
BlueGreenDeploymentIdentifier -> (string)
The system-generated identifier of the blue/green deployment.
BlueGreenDeploymentName -> (string)
The user-supplied name of the blue/green deployment.
Source -> (string)
The source database for the blue/green deployment.
Before switchover, the source database is the production database in the blue environment.
Target -> (string)
The target database for the blue/green deployment.
Before switchover, the target database is the clone database in the green environment.
SwitchoverDetails -> (list)
The details about each source and target resource in the blue/green deployment.
(structure)
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 .
SourceMember -> (string)
The Amazon Resource Name (ARN) of a resource in the blue environment.
TargetMember -> (string)
The Amazon Resource Name (ARN) of a resource in the green environment.
Status -> (string)
The switchover status of a resource in a blue/green deployment.
Values:
preparing-for-switchover- The resource is being prepared to switch over.
ready-for-switchover- The resource is ready to switch over.
switchover-in-progress- The resource is being switched over.
switchover-completed- The resource has been switched over.
switchover-failed- The resource attempted to switch over but failed.Tasks -> (list)
Either tasks to be performed or tasks that have been completed on the target database before switchover.
(structure)
Contains the details about a task for 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 .
Name -> (string)
The name of the blue/green deployment task.
Status -> (string)
The status of the blue/green deployment task.
Values:
PENDING- The resources are being prepared for deployment.
IN_PROGRESS- The resource is being deployed.
COMPLETED- The resource has been deployed.
FAILED- Deployment of the resource failed.Status -> (string)
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.StatusDetails -> (string)
Additional information about the status of the blue/green deployment.
CreateTime -> (timestamp)
Specifies the time when the blue/green deployment was created, in Universal Coordinated Time (UTC).
DeleteTime -> (timestamp)
Specifies the time when the blue/green deployment was deleted, in Universal Coordinated Time (UTC).
TagList -> (list)
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
(structure)
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
Key -> (string)
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can’t be prefixed with
aws:orrds:. The string can only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘:’, ‘/’, ‘=’, ‘+’, ‘-’, ‘@’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+-@]*)$”).Value -> (string)
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can’t be prefixed with
aws:orrds:. The string can only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘:’, ‘/’, ‘=’, ‘+’, ‘-’, ‘@’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+-@]*)$”).