Amazon Relational Database Service

2022/11/28 - Amazon Relational Database Service - 4 new api methods

Changes  This release enables new Aurora and RDS feature called Blue/Green Deployments that makes updates to databases safer, simpler and faster.

CreateBlueGreenDeployment (new) Link ¶

Creates a blue/green deployment.

A blue/green deployment creates a staging environment that copies the production environment. In a blue/green deployment, the blue environment is the current production environment. The green environment is the staging environment. The staging environment stays in sync with the current production environment using logical replication.

You can make changes to the databases in the green environment without affecting production workloads. For example, you can upgrade the major or minor DB engine version, change database parameters, or make schema changes in the staging environment. You can thoroughly test changes in the green environment. When ready, you can switch over the environments to promote the green environment to be the new production environment. The switchover typically takes under a minute.

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

Request Syntax

client.create_blue_green_deployment(
    BlueGreenDeploymentName='string',
    Source='string',
    TargetEngineVersion='string',
    TargetDBParameterGroupName='string',
    TargetDBClusterParameterGroupName='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
type BlueGreenDeploymentName

string

param BlueGreenDeploymentName

[REQUIRED]

The name of the blue/green deployment.

Constraints:

  • Can't be the same as an existing blue/green deployment name in the same account and Amazon Web Services Region.

type Source

string

param Source

[REQUIRED]

The Amazon Resource Name (ARN) of the source production database.

Specify the database that you want to clone. The blue/green deployment creates this database in the green environment. You can make updates to the database in the green environment, such as an engine version upgrade. When you are ready, you can switch the database in the green environment to be the production database.

type TargetEngineVersion

string

param TargetEngineVersion

The engine version of the database in the green environment.

Specify the engine version to upgrade to in the green environment.

type TargetDBParameterGroupName

string

param TargetDBParameterGroupName

The DB parameter group associated with the DB instance in the green environment.

To test parameter changes, specify a DB parameter group that is different from the one associated with the source DB instance.

type TargetDBClusterParameterGroupName

string

param TargetDBClusterParameterGroupName

The DB cluster parameter group associated with the Aurora DB cluster in the green environment.

To test parameter changes, specify a DB cluster parameter group that is different from the one associated with the source DB cluster.

type Tags

list

param Tags

Tags to assign to the blue/green deployment.

  • (dict) --

    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: or rds: . 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: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").

rtype

dict

returns

Response Syntax

{
    'BlueGreenDeployment': {
        'BlueGreenDeploymentIdentifier': 'string',
        'BlueGreenDeploymentName': 'string',
        'Source': 'string',
        'Target': 'string',
        'SwitchoverDetails': [
            {
                'SourceMember': 'string',
                'TargetMember': 'string',
                'Status': 'string'
            },
        ],
        'Tasks': [
            {
                'Name': 'string',
                'Status': 'string'
            },
        ],
        'Status': 'string',
        'StatusDetails': 'string',
        'CreateTime': datetime(2015, 1, 1),
        'DeleteTime': datetime(2015, 1, 1),
        'TagList': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • BlueGreenDeployment (dict) --

      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.

        • (dict) --

          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.

        • (dict) --

          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 (datetime) --

        Specifies the time when the blue/green deployment was created, in Universal Coordinated Time (UTC).

      • DeleteTime (datetime) --

        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.

        • (dict) --

          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: or rds: . 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: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").

DeleteBlueGreenDeployment (new) Link ¶

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 .

See also: AWS API Documentation

Request Syntax

client.delete_blue_green_deployment(
    BlueGreenDeploymentIdentifier='string',
    DeleteTarget=True|False
)
type BlueGreenDeploymentIdentifier

string

param BlueGreenDeploymentIdentifier

[REQUIRED]

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 DeleteTarget

boolean

param DeleteTarget

A value that indicates whether to delete the resources in the green environment.

rtype

dict

returns

Response Syntax

{
    'BlueGreenDeployment': {
        'BlueGreenDeploymentIdentifier': 'string',
        'BlueGreenDeploymentName': 'string',
        'Source': 'string',
        'Target': 'string',
        'SwitchoverDetails': [
            {
                'SourceMember': 'string',
                'TargetMember': 'string',
                'Status': 'string'
            },
        ],
        'Tasks': [
            {
                'Name': 'string',
                'Status': 'string'
            },
        ],
        'Status': 'string',
        'StatusDetails': 'string',
        'CreateTime': datetime(2015, 1, 1),
        'DeleteTime': datetime(2015, 1, 1),
        'TagList': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • BlueGreenDeployment (dict) --

      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.

        • (dict) --

          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.

        • (dict) --

          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 (datetime) --

        Specifies the time when the blue/green deployment was created, in Universal Coordinated Time (UTC).

      • DeleteTime (datetime) --

        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.

        • (dict) --

          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: or rds: . 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: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").

DescribeBlueGreenDeployments (new) Link ¶

Returns information about 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

Request Syntax

client.describe_blue_green_deployments(
    BlueGreenDeploymentIdentifier='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    Marker='string',
    MaxRecords=123
)
type BlueGreenDeploymentIdentifier

string

param BlueGreenDeploymentIdentifier

The blue/green deployment identifier. If this parameter is specified, information from only the specific blue/green deployment is returned. This parameter isn't case-sensitive.

Constraints:

  • If supplied, must match an existing blue/green deployment identifier.

type Filters

list

param Filters

A filter that specifies one or more blue/green deployments to describe.

Supported filters:

  • 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.

  • (dict) --

    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:

    • DescribeDBClusterBacktracks

    • DescribeDBClusterEndpoints

    • DescribeDBClusters

    • DescribeDBInstances

    • DescribePendingMaintenanceActions

    • Name (string) -- [REQUIRED]

      The name of the filter. Filter names are case-sensitive.

    • Values (list) -- [REQUIRED]

      One or more filter values. Filter values are case-sensitive.

      • (string) --

type Marker

string

param Marker

An optional pagination token provided by a previous DescribeBlueGreenDeployments request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

type MaxRecords

integer

param MaxRecords

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

rtype

dict

returns

Response Syntax

{
    'BlueGreenDeployments': [
        {
            'BlueGreenDeploymentIdentifier': 'string',
            'BlueGreenDeploymentName': 'string',
            'Source': 'string',
            'Target': 'string',
            'SwitchoverDetails': [
                {
                    'SourceMember': 'string',
                    'TargetMember': 'string',
                    'Status': 'string'
                },
            ],
            'Tasks': [
                {
                    'Name': 'string',
                    'Status': 'string'
                },
            ],
            'Status': 'string',
            'StatusDetails': 'string',
            'CreateTime': datetime(2015, 1, 1),
            'DeleteTime': datetime(2015, 1, 1),
            'TagList': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'Marker': 'string'
}

Response Structure

  • (dict) --

    • BlueGreenDeployments (list) --

      Contains a list of blue/green deployments for the user.

      • (dict) --

        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.

          • (dict) --

            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.

          • (dict) --

            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 (datetime) --

          Specifies the time when the blue/green deployment was created, in Universal Coordinated Time (UTC).

        • DeleteTime (datetime) --

          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.

          • (dict) --

            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: or rds: . 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: or rds: . 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 later DescribeBlueGreenDeployments request.

SwitchoverBlueGreenDeployment (new) Link ¶

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

Request Syntax

client.switchover_blue_green_deployment(
    BlueGreenDeploymentIdentifier='string',
    SwitchoverTimeout=123
)
type BlueGreenDeploymentIdentifier

string

param BlueGreenDeploymentIdentifier

[REQUIRED]

The blue/green deployment identifier.

Constraints:

  • Must match an existing blue/green deployment identifier.

type SwitchoverTimeout

integer

param SwitchoverTimeout

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.

rtype

dict

returns

Response Syntax

{
    'BlueGreenDeployment': {
        'BlueGreenDeploymentIdentifier': 'string',
        'BlueGreenDeploymentName': 'string',
        'Source': 'string',
        'Target': 'string',
        'SwitchoverDetails': [
            {
                'SourceMember': 'string',
                'TargetMember': 'string',
                'Status': 'string'
            },
        ],
        'Tasks': [
            {
                'Name': 'string',
                'Status': 'string'
            },
        ],
        'Status': 'string',
        'StatusDetails': 'string',
        'CreateTime': datetime(2015, 1, 1),
        'DeleteTime': datetime(2015, 1, 1),
        'TagList': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) --

    • BlueGreenDeployment (dict) --

      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.

        • (dict) --

          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.

        • (dict) --

          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 (datetime) --

        Specifies the time when the blue/green deployment was created, in Universal Coordinated Time (UTC).

      • DeleteTime (datetime) --

        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.

        • (dict) --

          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: or rds: . 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: or rds: . The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").