Note:
You are viewing the documentation for an older major version of the AWS CLI (version 1).AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
describe-blue-green-deployments¶
Description¶
Describes one or more blue/green deployments.
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
describe-blue-green-deployments is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument.
When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: BlueGreenDeployments
Synopsis¶
describe-blue-green-deployments
[--blue-green-deployment-identifier <value>]
[--filters <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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>]
Options¶
--blue-green-deployment-identifier (string)
The blue/green deployment identifier. If you specify this parameter, the response only includes information about the specific blue/green deployment. This parameter isn't case-sensitive.
Constraints:
- Must match an existing blue/green deployment identifier.
--filters (list)
A filter that specifies one or more blue/green deployments to describe.
Valid Values:
blue-green-deployment-identifier- Accepts system-generated identifiers for blue/green deployments. The results list only includes information about the blue/green deployments with the specified identifiers.blue-green-deployment-name- Accepts user-supplied names for blue/green deployments. The results list only includes information about the blue/green deployments with the specified names.source- Accepts source databases for a blue/green deployment. The results list only includes information about the blue/green deployments with the specified source databases.target- Accepts target databases for a blue/green deployment. The results list only includes information about the blue/green deployments with the specified target databases.(structure)
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.The following actions can be filtered:
DescribeDBClusterBacktracksDescribeDBClusterEndpointsDescribeDBClustersDescribeDBInstancesDescribeDBRecommendationsDescribeDBShardGroupsDescribePendingMaintenanceActionsName -> (string)
The name of the filter. Filter names are case-sensitive.Values -> (list)
One or more filter values. Filter values are case-sensitive.
(string)
Shorthand Syntax:
Name=string,Values=string,string ...
JSON Syntax:
[
{
"Name": "string",
"Values": ["string", ...]
}
...
]
--cli-input-json (string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.
--starting-token (string)
A token to specify where to start paginating. This is the
NextTokenfrom a previously truncated response.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--page-size (integer)
The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.
For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--max-items (integer)
The total number of items to return in the command's output. If the total number of items available is more than the value specified, a
NextTokenis provided in the command's output. To resume pagination, provide theNextTokenvalue in thestarting-tokenargument of a subsequent command. Do not use theNextTokenresponse element directly outside of the AWS CLI.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
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. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output (string)
The formatting style for command output.
- json
- text
- table
--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.
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 describe a blue/green deployment of an RDS DB instance after creation completes
The following describe-blue-green-deployment example retrieves the details of a blue/green deployment after creation completes.
aws rds describe-blue-green-deployments \
--blue-green-deployment-identifier bgd-v53303651eexfake
Output:
{
"BlueGreenDeployments": [
{
"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-rkfbpe",
"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-rkfbpe",
"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-j382ha",
"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-ejv4ao",
"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-vlpz3t",
"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": "AVAILABLE",
"CreateTime": "2022-02-25T21:18:51.183000+00:00"
}
]
}
For more information, see Viewing a blue/green deployment in the Amazon RDS User Guide.
Example 2: To describe a blue/green deployment for an Aurora MySQL DB cluster
The following describe-blue-green-deployment example retrieves the details of a blue/green deployment.
aws rds describe-blue-green-deployments \
--blue-green-deployment-identifier bgd-wi89nwzglccsfake
Output:
{
"BlueGreenDeployments": [
{
"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-3rnukl",
"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-3rnukl",
"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-gpmaxf",
"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-j2oajq",
"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-mkxies",
"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-4sqjrq",
"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-gwwzlg",
"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": "AVAILABLE",
"CreateTime": "2022-02-25T21:12:00.288000+00:00"
}
]
}
For more information, see Viewing a blue/green deployment in the Amazon Aurora User Guide.
Example 3: To describe a blue/green deployment for an Aurora MySQL cluster after switchover
The following describe-blue-green-deployment example retrieves the details about a blue/green deployment after the green environment is promoted to be the production environment.
aws rds describe-blue-green-deployments \
--blue-green-deployment-identifier bgd-wi89nwzglccsfake
Output:
{
"BlueGreenDeployments": [
{
"BlueGreenDeploymentIdentifier": "bgd-wi89nwzglccsfake",
"BlueGreenDeploymentName": "my-blue-green-deployment",
"Source": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster-old1",
"Target": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster",
"SwitchoverDetails": [
{
"SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster-old1",
"TargetMember": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster",
"Status": "SWITCHOVER_COMPLETED"
},
{
"SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-1-old1",
"TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-1",
"Status": "SWITCHOVER_COMPLETED"
},
{
"SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-2-old1",
"TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-2",
"Status": "SWITCHOVER_COMPLETED"
},
{
"SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-3-old1",
"TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-3",
"Status": "SWITCHOVER_COMPLETED"
},
{
"SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-excluded-member-endpoint-old1",
"TargetMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-excluded-member-endpoint",
"Status": "SWITCHOVER_COMPLETED"
},
{
"SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-reader-endpoint-old1",
"TargetMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-reader-endpoint",
"Status": "SWITCHOVER_COMPLETED"
}
],
"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_COMPLETED",
"CreateTime": "2022-02-25T22:38:49.522000+00:00"
}
]
}
For more information, see Viewing a blue/green deployment in the Amazon Aurora User Guide.
Example 4: To describe a combined blue/green deployment
The following describe-blue-green-deployment example retrieves the details of a combined blue/green deployment.
aws rds describe-blue-green-deployments
Output:
{
"BlueGreenDeployments": [
{
"BlueGreenDeploymentIdentifier": "bgd-wi89nwzgfakelccs",
"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-3rnukl",
"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-3rnukl",
"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-gpmaxf",
"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-j2oajq",
"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-mkxies",
"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-4sqjrq",
"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-gwwzlg",
"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": "AVAILABLE",
"CreateTime": "2022-02-25T21:12:00.288000+00:00"
},
{
"BlueGreenDeploymentIdentifier": "bgd-v5330365fake1eex",
"BlueGreenDeploymentName": "bgd-cli-test-instance",
"Source": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-old1",
"Target": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance",
"SwitchoverDetails": [
{
"SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-old1",
"TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance",
"Status": "SWITCHOVER_COMPLETED"
},
{
"SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-1-old1",
"TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-1",
"Status": "SWITCHOVER_COMPLETED"
},
{
"SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-2-old1",
"TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-2",
"Status": "SWITCHOVER_COMPLETED"
},
{
"SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-3-old1",
"TargetMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-3",
"Status": "SWITCHOVER_COMPLETED"
}
],
"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_COMPLETED",
"CreateTime": "2022-02-25T22:33:22.225000+00:00"
}
]
}
For more information, see Viewing a blue/green deployment in the Amazon RDS User Guide and Viewing a blue/green deployment in the Amazon Aurora User Guide.
Output¶
BlueGreenDeployments -> (list)
A list of blue/green deployments in the current account and Amazon Web Services Region.
(structure)
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 unique 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:
PROVISIONING- The resource is being prepared to switch over.AVAILABLE- 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.MISSING_SOURCE- The source resource has been deleted.MISSING_TARGET- The target resource has been deleted.Tasks -> (list)
Either tasks to be performed or tasks that have been completed on the target database before switchover.
(structure)
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.
Valid Values:
PENDING- The resource is 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.
Valid 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)
The time when the blue/green deployment was created, in Universal Coordinated Time (UTC).DeleteTime -> (timestamp)
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 or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora 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 or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora 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 withaws: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 withaws:orrds:. The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
Marker -> (string)
A pagination token that can be used in a laterDescribeBlueGreenDeploymentsrequest.