drs / Client / associate_source_network_stack

associate_source_network_stack#

drs.Client.associate_source_network_stack(**kwargs)#

Associate a Source Network to an existing CloudFormation Stack and modify launch templates to use this network. Can be used for reverting to previously deployed CloudFormation stacks.

Request Syntax

response = client.associate_source_network_stack(
    cfnStackName='string',
    sourceNetworkID='string'
)

Parameters:

cfnStackName (string) –
[REQUIRED]

CloudFormation template to associate with a Source Network.
sourceNetworkID (string) –
[REQUIRED]

The Source Network ID to associate with CloudFormation template.

Return type:

dict

Returns:

Response Syntax

{
    'job': {
        'arn': 'string',
        'creationDateTime': 'string',
        'endDateTime': 'string',
        'initiatedBy': 'START_RECOVERY'|'START_DRILL'|'FAILBACK'|'DIAGNOSTIC'|'TERMINATE_RECOVERY_INSTANCES'|'TARGET_ACCOUNT'|'CREATE_NETWORK_RECOVERY'|'UPDATE_NETWORK_RECOVERY'|'ASSOCIATE_NETWORK_RECOVERY',
        'jobID': 'string',
        'participatingResources': [
            {
                'launchStatus': 'PENDING'|'IN_PROGRESS'|'LAUNCHED'|'FAILED'|'TERMINATED',
                'participatingResourceID': {
                    'sourceNetworkID': 'string'
                }
            },
        ],
        'participatingServers': [
            {
                'launchStatus': 'PENDING'|'IN_PROGRESS'|'LAUNCHED'|'FAILED'|'TERMINATED',
                'recoveryInstanceID': 'string',
                'sourceServerID': 'string'
            },
        ],
        'status': 'PENDING'|'STARTED'|'COMPLETED',
        'tags': {
            'string': 'string'
        },
        'type': 'LAUNCH'|'TERMINATE'|'CREATE_CONVERTED_SNAPSHOT'
    }
}

Response Structure

(dict) –
- job (dict) –
  
  The Source Network association Job.
  - arn (string) –
    
    The ARN of a Job.
  - creationDateTime (string) –
    
    The date and time of when the Job was created.
  - endDateTime (string) –
    
    The date and time of when the Job ended.
  - initiatedBy (string) –
    
    A string representing who initiated the Job.
  - jobID (string) –
    
    The ID of the Job.
  - participatingResources (list) –
    
    A list of resources that the Job is acting upon.
    - (dict) –
      
      Represents a resource participating in an asynchronous Job.
      - launchStatus (string) –
        
        The launch status of a participating resource.
      - participatingResourceID (dict) –
        
        The ID of a participating resource.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys will be set: sourceNetworkID. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        sourceNetworkID (string) –
        
        Source Network ID.
  - participatingServers (list) –
    
    A list of servers that the Job is acting upon.
    - (dict) –
      
      Represents a server participating in an asynchronous Job.
      - launchStatus (string) –
        
        The launch status of a participating server.
      - recoveryInstanceID (string) –
        
        The Recovery Instance ID of a participating server.
      - sourceServerID (string) –
        
        The Source Server ID of a participating server.
  - status (string) –
    
    The status of the Job.
  - tags (dict) –
    
    A list of tags associated with the Job.
    - (string) –
      - (string) –
  - type (string) –
    
    The type of the Job.

Exceptions

drs.Client.exceptions.ResourceNotFoundException
drs.Client.exceptions.InternalServerException
drs.Client.exceptions.ConflictException
drs.Client.exceptions.ServiceQuotaExceededException
drs.Client.exceptions.ThrottlingException
drs.Client.exceptions.ValidationException
drs.Client.exceptions.UninitializedAccountException