AWS API Changes

2023/10/16 - Elastic Disaster Recovery Service - 5 updated api methods

Changes Updated exsiting API to allow AWS Elastic Disaster Recovery support of launching recovery into existing EC2 instances.

CreateLaunchConfigurationTemplate (updated)

Link ¶
Changes (request, response)
Request

{'launchIntoSourceInstance': 'boolean'}

Response

{'launchConfigurationTemplate': {'launchIntoSourceInstance': 'boolean'}}

Creates a new Launch Configuration Template.

See also: AWS API Documentation

Request Syntax

client.create_launch_configuration_template(
    copyPrivateIp=True|False,
    copyTags=True|False,
    exportBucketArn='string',
    launchDisposition='STOPPED'|'STARTED',
    launchIntoSourceInstance=True|False,
    licensing={
        'osByol': True|False
    },
    postLaunchEnabled=True|False,
    tags={
        'string': 'string'
    },
    targetInstanceTypeRightSizingMethod='NONE'|'BASIC'|'IN_AWS'
)

type copyPrivateIp

boolean

param copyPrivateIp

Copy private IP.

type copyTags

boolean

param copyTags

Copy tags.

type exportBucketArn

string

param exportBucketArn

S3 bucket ARN to export Source Network templates.

type launchDisposition

string

param launchDisposition

Launch disposition.

type launchIntoSourceInstance

boolean

param launchIntoSourceInstance

DRS will set the 'launch into instance ID' of any source server when performing a drill, recovery or failback to the previous region or availability zone, using the instance ID of the source instance.

type licensing

dict

param licensing

Licensing.

osByol (boolean) --

Whether to enable "Bring your own license" or not.

type postLaunchEnabled

boolean

param postLaunchEnabled

Whether we want to activate post-launch actions.

type tags

dict

param tags

Request to associate tags during creation of a Launch Configuration Template.

(string) --
- (string) --

type targetInstanceTypeRightSizingMethod

string

param targetInstanceTypeRightSizingMethod

Target instance type right-sizing method.

rtype

dict

returns

Response Syntax

{
    'launchConfigurationTemplate': {
        'arn': 'string',
        'copyPrivateIp': True|False,
        'copyTags': True|False,
        'exportBucketArn': 'string',
        'launchConfigurationTemplateID': 'string',
        'launchDisposition': 'STOPPED'|'STARTED',
        'launchIntoSourceInstance': True|False,
        'licensing': {
            'osByol': True|False
        },
        'postLaunchEnabled': True|False,
        'tags': {
            'string': 'string'
        },
        'targetInstanceTypeRightSizingMethod': 'NONE'|'BASIC'|'IN_AWS'
    }
}

Response Structure

(dict) --
- launchConfigurationTemplate (dict) --
  
  Created Launch Configuration Template.
  - arn (string) --
    
    ARN of the Launch Configuration Template.
  - copyPrivateIp (boolean) --
    
    Copy private IP.
  - copyTags (boolean) --
    
    Copy tags.
  - exportBucketArn (string) --
    
    S3 bucket ARN to export Source Network templates.
  - launchConfigurationTemplateID (string) --
    
    ID of the Launch Configuration Template.
  - launchDisposition (string) --
    
    Launch disposition.
  - launchIntoSourceInstance (boolean) --
    
    DRS will set the 'launch into instance ID' of any source server when performing a drill, recovery or failback to the previous region or availability zone, using the instance ID of the source instance.
  - licensing (dict) --
    
    Licensing.
    - osByol (boolean) --
      
      Whether to enable "Bring your own license" or not.
  - postLaunchEnabled (boolean) --
    
    Post-launch actions activated.
  - tags (dict) --
    
    Tags of the Launch Configuration Template.
    - (string) --
      - (string) --
  - targetInstanceTypeRightSizingMethod (string) --
    
    Target instance type right-sizing method.

DescribeLaunchConfigurationTemplates (updated)

Link ¶
Changes (response)

{'items': {'launchIntoSourceInstance': 'boolean'}}

Lists all Launch Configuration Templates, filtered by Launch Configuration Template IDs

See also: AWS API Documentation

Request Syntax

client.describe_launch_configuration_templates(
    launchConfigurationTemplateIDs=[
        'string',
    ],
    maxResults=123,
    nextToken='string'
)

type launchConfigurationTemplateIDs

list

param launchConfigurationTemplateIDs

Request to filter Launch Configuration Templates list by Launch Configuration Template ID.

(string) --

type maxResults

integer

param maxResults

Maximum results to be returned in DescribeLaunchConfigurationTemplates.

type nextToken

string

param nextToken

The token of the next Launch Configuration Template to retrieve.

rtype

dict

returns

Response Syntax

{
    'items': [
        {
            'arn': 'string',
            'copyPrivateIp': True|False,
            'copyTags': True|False,
            'exportBucketArn': 'string',
            'launchConfigurationTemplateID': 'string',
            'launchDisposition': 'STOPPED'|'STARTED',
            'launchIntoSourceInstance': True|False,
            'licensing': {
                'osByol': True|False
            },
            'postLaunchEnabled': True|False,
            'tags': {
                'string': 'string'
            },
            'targetInstanceTypeRightSizingMethod': 'NONE'|'BASIC'|'IN_AWS'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- items (list) --
  
  List of items returned by DescribeLaunchConfigurationTemplates.
  - (dict) --
    
    Account level Launch Configuration Template.
    - arn (string) --
      
      ARN of the Launch Configuration Template.
    - copyPrivateIp (boolean) --
      
      Copy private IP.
    - copyTags (boolean) --
      
      Copy tags.
    - exportBucketArn (string) --
      
      S3 bucket ARN to export Source Network templates.
    - launchConfigurationTemplateID (string) --
      
      ID of the Launch Configuration Template.
    - launchDisposition (string) --
      
      Launch disposition.
    - launchIntoSourceInstance (boolean) --
      
      DRS will set the 'launch into instance ID' of any source server when performing a drill, recovery or failback to the previous region or availability zone, using the instance ID of the source instance.
    - licensing (dict) --
      
      Licensing.
      - osByol (boolean) --
        
        Whether to enable "Bring your own license" or not.
    - postLaunchEnabled (boolean) --
      
      Post-launch actions activated.
    - tags (dict) --
      
      Tags of the Launch Configuration Template.
      - (string) --
        
        (string) --
    - targetInstanceTypeRightSizingMethod (string) --
      
      Target instance type right-sizing method.
- nextToken (string) --
  
  The token of the next Launch Configuration Template to retrieve.

GetLaunchConfiguration (updated)

Link ¶
Changes (response)

{'launchIntoInstanceProperties': {'launchIntoEC2InstanceID': 'string'}}

Gets a LaunchConfiguration, filtered by Source Server IDs.

See also: AWS API Documentation

Request Syntax

client.get_launch_configuration(
    sourceServerID='string'
)

type sourceServerID

string

param sourceServerID

[REQUIRED]

The ID of the Source Server that we want to retrieve a Launch Configuration for.

rtype

dict

returns

Response Syntax

{
    'copyPrivateIp': True|False,
    'copyTags': True|False,
    'ec2LaunchTemplateID': 'string',
    'launchDisposition': 'STOPPED'|'STARTED',
    'launchIntoInstanceProperties': {
        'launchIntoEC2InstanceID': 'string'
    },
    'licensing': {
        'osByol': True|False
    },
    'name': 'string',
    'postLaunchEnabled': True|False,
    'sourceServerID': 'string',
    'targetInstanceTypeRightSizingMethod': 'NONE'|'BASIC'|'IN_AWS'
}

Response Structure

(dict) --
- copyPrivateIp (boolean) --
  
  Whether we should copy the Private IP of the Source Server to the Recovery Instance.
- copyTags (boolean) --
  
  Whether we want to copy the tags of the Source Server to the EC2 machine of the Recovery Instance.
- ec2LaunchTemplateID (string) --
  
  The EC2 launch template ID of this launch configuration.
- launchDisposition (string) --
  
  The state of the Recovery Instance in EC2 after the recovery operation.
- launchIntoInstanceProperties (dict) --
  
  Launch into existing instance properties.
  - launchIntoEC2InstanceID (string) --
    
    Optionally holds EC2 instance ID of an instance to launch into, instead of launching a new instance during drill, recovery or failback.
- licensing (dict) --
  
  The licensing configuration to be used for this launch configuration.
  - osByol (boolean) --
    
    Whether to enable "Bring your own license" or not.
- name (string) --
  
  The name of the launch configuration.
- postLaunchEnabled (boolean) --
  
  Whether we want to activate post-launch actions for the Source Server.
- sourceServerID (string) --
  
  The ID of the Source Server for this launch configuration.
- targetInstanceTypeRightSizingMethod (string) --
  
  Whether Elastic Disaster Recovery should try to automatically choose the instance type that best matches the OS, CPU, and RAM of your Source Server.

UpdateLaunchConfiguration (updated)

Link ¶
Changes (both)

{'launchIntoInstanceProperties': {'launchIntoEC2InstanceID': 'string'}}

Updates a LaunchConfiguration by Source Server ID.

See also: AWS API Documentation

Request Syntax

client.update_launch_configuration(
    copyPrivateIp=True|False,
    copyTags=True|False,
    launchDisposition='STOPPED'|'STARTED',
    launchIntoInstanceProperties={
        'launchIntoEC2InstanceID': 'string'
    },
    licensing={
        'osByol': True|False
    },
    name='string',
    postLaunchEnabled=True|False,
    sourceServerID='string',
    targetInstanceTypeRightSizingMethod='NONE'|'BASIC'|'IN_AWS'
)

type copyPrivateIp

boolean

param copyPrivateIp

Whether we should copy the Private IP of the Source Server to the Recovery Instance.

type copyTags

boolean

param copyTags

Whether we want to copy the tags of the Source Server to the EC2 machine of the Recovery Instance.

type launchDisposition

string

param launchDisposition

The state of the Recovery Instance in EC2 after the recovery operation.

type launchIntoInstanceProperties

dict

param launchIntoInstanceProperties

Launch into existing instance properties.

launchIntoEC2InstanceID (string) --

Optionally holds EC2 instance ID of an instance to launch into, instead of launching a new instance during drill, recovery or failback.

type licensing

dict

param licensing

The licensing configuration to be used for this launch configuration.

osByol (boolean) --

Whether to enable "Bring your own license" or not.

type name

string

param name

The name of the launch configuration.

type postLaunchEnabled

boolean

param postLaunchEnabled

Whether we want to enable post-launch actions for the Source Server.

type sourceServerID

string

param sourceServerID

[REQUIRED]

The ID of the Source Server that we want to retrieve a Launch Configuration for.

type targetInstanceTypeRightSizingMethod

string

param targetInstanceTypeRightSizingMethod

Whether Elastic Disaster Recovery should try to automatically choose the instance type that best matches the OS, CPU, and RAM of your Source Server.

rtype

dict

returns

Response Syntax

{
    'copyPrivateIp': True|False,
    'copyTags': True|False,
    'ec2LaunchTemplateID': 'string',
    'launchDisposition': 'STOPPED'|'STARTED',
    'launchIntoInstanceProperties': {
        'launchIntoEC2InstanceID': 'string'
    },
    'licensing': {
        'osByol': True|False
    },
    'name': 'string',
    'postLaunchEnabled': True|False,
    'sourceServerID': 'string',
    'targetInstanceTypeRightSizingMethod': 'NONE'|'BASIC'|'IN_AWS'
}

Response Structure

(dict) --
- copyPrivateIp (boolean) --
  
  Whether we should copy the Private IP of the Source Server to the Recovery Instance.
- copyTags (boolean) --
  
  Whether we want to copy the tags of the Source Server to the EC2 machine of the Recovery Instance.
- ec2LaunchTemplateID (string) --
  
  The EC2 launch template ID of this launch configuration.
- launchDisposition (string) --
  
  The state of the Recovery Instance in EC2 after the recovery operation.
- launchIntoInstanceProperties (dict) --
  
  Launch into existing instance properties.
  - launchIntoEC2InstanceID (string) --
    
    Optionally holds EC2 instance ID of an instance to launch into, instead of launching a new instance during drill, recovery or failback.
- licensing (dict) --
  
  The licensing configuration to be used for this launch configuration.
  - osByol (boolean) --
    
    Whether to enable "Bring your own license" or not.
- name (string) --
  
  The name of the launch configuration.
- postLaunchEnabled (boolean) --
  
  Whether we want to activate post-launch actions for the Source Server.
- sourceServerID (string) --
  
  The ID of the Source Server for this launch configuration.
- targetInstanceTypeRightSizingMethod (string) --
  
  Whether Elastic Disaster Recovery should try to automatically choose the instance type that best matches the OS, CPU, and RAM of your Source Server.

UpdateLaunchConfigurationTemplate (updated)

Link ¶
Changes (request, response)
Request

{'launchIntoSourceInstance': 'boolean'}

Response

{'launchConfigurationTemplate': {'launchIntoSourceInstance': 'boolean'}}

Updates an existing Launch Configuration Template by ID.

See also: AWS API Documentation

Request Syntax

client.update_launch_configuration_template(
    copyPrivateIp=True|False,
    copyTags=True|False,
    exportBucketArn='string',
    launchConfigurationTemplateID='string',
    launchDisposition='STOPPED'|'STARTED',
    launchIntoSourceInstance=True|False,
    licensing={
        'osByol': True|False
    },
    postLaunchEnabled=True|False,
    targetInstanceTypeRightSizingMethod='NONE'|'BASIC'|'IN_AWS'
)

type copyPrivateIp

boolean

param copyPrivateIp

Copy private IP.

type copyTags

boolean

param copyTags

Copy tags.

type exportBucketArn

string

param exportBucketArn

S3 bucket ARN to export Source Network templates.

type launchConfigurationTemplateID

string

param launchConfigurationTemplateID

[REQUIRED]

Launch Configuration Template ID.

type launchDisposition

string

param launchDisposition

Launch disposition.

type launchIntoSourceInstance

boolean

param launchIntoSourceInstance

type licensing

dict

param licensing

Licensing.

osByol (boolean) --

Whether to enable "Bring your own license" or not.

type postLaunchEnabled

boolean

param postLaunchEnabled

Whether we want to activate post-launch actions.

type targetInstanceTypeRightSizingMethod

string

param targetInstanceTypeRightSizingMethod

Target instance type right-sizing method.

rtype

dict

returns

Response Syntax

{
    'launchConfigurationTemplate': {
        'arn': 'string',
        'copyPrivateIp': True|False,
        'copyTags': True|False,
        'exportBucketArn': 'string',
        'launchConfigurationTemplateID': 'string',
        'launchDisposition': 'STOPPED'|'STARTED',
        'launchIntoSourceInstance': True|False,
        'licensing': {
            'osByol': True|False
        },
        'postLaunchEnabled': True|False,
        'tags': {
            'string': 'string'
        },
        'targetInstanceTypeRightSizingMethod': 'NONE'|'BASIC'|'IN_AWS'
    }
}

Response Structure

(dict) --
- launchConfigurationTemplate (dict) --
  
  Updated Launch Configuration Template.
  - arn (string) --
    
    ARN of the Launch Configuration Template.
  - copyPrivateIp (boolean) --
    
    Copy private IP.
  - copyTags (boolean) --
    
    Copy tags.
  - exportBucketArn (string) --
    
    S3 bucket ARN to export Source Network templates.
  - launchConfigurationTemplateID (string) --
    
    ID of the Launch Configuration Template.
  - launchDisposition (string) --
    
    Launch disposition.
  - launchIntoSourceInstance (boolean) --
    
    DRS will set the 'launch into instance ID' of any source server when performing a drill, recovery or failback to the previous region or availability zone, using the instance ID of the source instance.
  - licensing (dict) --
    
    Licensing.
    - osByol (boolean) --
      
      Whether to enable "Bring your own license" or not.
  - postLaunchEnabled (boolean) --
    
    Post-launch actions activated.
  - tags (dict) --
    
    Tags of the Launch Configuration Template.
    - (string) --
      - (string) --
  - targetInstanceTypeRightSizingMethod (string) --
    
    Target instance type right-sizing method.