Elastic Disaster Recovery Service

2023/07/31 - Elastic Disaster Recovery Service - 5 updated api methods

Changes  Add support for in-aws right sizing

CreateLaunchConfigurationTemplate (updated) Link ¶
Changes (request, response)
Request 
{'targetInstanceTypeRightSizingMethod': {'IN_AWS'}}
Response 
{'launchConfigurationTemplate': {'targetInstanceTypeRightSizingMethod': {'IN_AWS'}}}

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',
    licensing={
        'osByol': 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 licensing:

dict

param licensing:

Licensing.

  • osByol (boolean) --

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

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',
        'licensing': {
            'osByol': 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.

      • licensing (dict) --

        Licensing.

        • osByol (boolean) --

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

      • tags (dict) --

        Tags of the Launch Configuration Template.

        • (string) --

          • (string) --

      • targetInstanceTypeRightSizingMethod (string) --

        Target instance type right-sizing method.

DescribeLaunchConfigurationTemplates (updated) Link ¶
Changes (response) 
{'items': {'targetInstanceTypeRightSizingMethod': {'IN_AWS'}}}

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',
            'licensing': {
                'osByol': 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.

        • licensing (dict) --

          Licensing.

          • osByol (boolean) --

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

        • 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) 
{'targetInstanceTypeRightSizingMethod': {'IN_AWS'}}

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',
    'licensing': {
        'osByol': True|False
    },
    'name': 'string',
    '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.

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

    • 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) 
{'targetInstanceTypeRightSizingMethod': {'IN_AWS'}}

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',
    licensing={
        'osByol': True|False
    },
    name='string',
    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 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 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',
    'licensing': {
        'osByol': True|False
    },
    'name': 'string',
    '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.

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

    • 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 
{'targetInstanceTypeRightSizingMethod': {'IN_AWS'}}
Response 
{'launchConfigurationTemplate': {'targetInstanceTypeRightSizingMethod': {'IN_AWS'}}}

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',
    licensing={
        'osByol': 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 licensing:

dict

param licensing:

Licensing.

  • osByol (boolean) --

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

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',
        'licensing': {
            'osByol': 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.

      • licensing (dict) --

        Licensing.

        • osByol (boolean) --

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

      • tags (dict) --

        Tags of the Launch Configuration Template.

        • (string) --

          • (string) --

      • targetInstanceTypeRightSizingMethod (string) --

        Target instance type right-sizing method.