EC2 / Client / enable_fast_launch

enable_fast_launch

EC2.Client.enable_fast_launch(**kwargs)

When you enable faster launching for a Windows AMI, images are pre-provisioned, using snapshots to launch instances up to 65% faster. To create the optimized Windows image, Amazon EC2 launches an instance and runs through Sysprep steps, rebooting as required. Then it creates a set of reserved snapshots that are used for subsequent launches. The reserved snapshots are automatically replenished as they are used, depending on your settings for launch frequency.

Note

To change these settings, you must own the AMI.

See also: AWS API Documentation

Request Syntax

response = client.enable_fast_launch(
    ImageId='string',
    ResourceType='string',
    SnapshotConfiguration={
        'TargetResourceCount': 123
    },
    LaunchTemplate={
        'LaunchTemplateId': 'string',
        'LaunchTemplateName': 'string',
        'Version': 'string'
    },
    MaxParallelLaunches=123,
    DryRun=True|False
)

Parameters:

• ImageId (string) –

  [REQUIRED]

  The ID of the image for which you’re enabling faster launching.

• ResourceType (string) – The type of resource to use for pre-provisioning the Windows AMI for faster launching. Supported values include: snapshot, which is the default value.

• SnapshotConfiguration (dict) –

  Configuration settings for creating and managing the snapshots that are used for pre-provisioning the Windows AMI for faster launching. The associated ResourceType must be snapshot.

  • TargetResourceCount (integer) –

    The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled Windows AMI.

• LaunchTemplate (dict) –

  The launch template to use when launching Windows instances from pre-provisioned snapshots. Launch template parameters can include either the name or ID of the launch template, but not both.

  • LaunchTemplateId (string) –

    The ID of the launch template to use for faster launching for a Windows AMI.

  • LaunchTemplateName (string) –

    The name of the launch template to use for faster launching for a Windows AMI.

  • Version (string) – [REQUIRED]

    The version of the launch template to use for faster launching for a Windows AMI.

• MaxParallelLaunches (integer) – The maximum number of instances that Amazon EC2 can launch at the same time to create pre-provisioned snapshots for Windows faster launching. Value must be 6 or greater.

• DryRun (boolean) – Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Return type:

dict

Returns:

Response Syntax

{
    'ImageId': 'string',
    'ResourceType': 'snapshot',
    'SnapshotConfiguration': {
        'TargetResourceCount': 123
    },
    'LaunchTemplate': {
        'LaunchTemplateId': 'string',
        'LaunchTemplateName': 'string',
        'Version': 'string'
    },
    'MaxParallelLaunches': 123,
    'OwnerId': 'string',
    'State': 'enabling'|'enabling-failed'|'enabled'|'enabled-failed'|'disabling'|'disabling-failed',
    'StateTransitionReason': 'string',
    'StateTransitionTime': datetime(2015, 1, 1)
}

Response Structure

• (dict) –

  • ImageId (string) –

    The image ID that identifies the Windows AMI for which faster launching was enabled.

  • ResourceType (string) –

    The type of resource that was defined for pre-provisioning the Windows AMI for faster launching.

  • SnapshotConfiguration (dict) –

    Settings to create and manage the pre-provisioned snapshots that Amazon EC2 uses for faster launches from the Windows AMI. This property is returned when the associated resourceType is snapshot.

    • TargetResourceCount (integer) –

      The number of pre-provisioned snapshots requested to keep on hand for a fast-launch enabled Windows AMI.

  • LaunchTemplate (dict) –

    The launch template that is used when launching Windows instances from pre-provisioned snapshots.

    • LaunchTemplateId (string) –

      The ID of the launch template for faster launching of the associated Windows AMI.

    • LaunchTemplateName (string) –

      The name of the launch template for faster launching of the associated Windows AMI.

    • Version (string) –

      The version of the launch template for faster launching of the associated Windows AMI.

  • MaxParallelLaunches (integer) –

    The maximum number of instances that Amazon EC2 can launch at the same time to create pre-provisioned snapshots for Windows faster launching.

  • OwnerId (string) –

    The owner ID for the Windows AMI for which faster launching was enabled.

  • State (string) –

    The current state of faster launching for the specified Windows AMI.

  • StateTransitionReason (string) –

    The reason that the state changed for faster launching for the Windows AMI.

  • StateTransitionTime (datetime) –

    The time that the state changed for faster launching for the Windows AMI.