RDS / Client / switchover_blue_green_deployment

switchover_blue_green_deployment#

RDS.Client.switchover_blue_green_deployment(**kwargs)#

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

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

Parameters:

BlueGreenDeploymentIdentifier (string) –
[REQUIRED]

The blue/green deployment identifier.

Constraints:
- Must match an existing blue/green deployment identifier.
SwitchoverTimeout (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.

Return type:

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}_.:/=+\-@]*)$”).

Exceptions

RDS.Client.exceptions.BlueGreenDeploymentNotFoundFault
RDS.Client.exceptions.InvalidBlueGreenDeploymentStateFault