disable-fast-launch¶

Description¶

Discontinue faster launching for a Windows AMI, and clean up existing pre-provisioned snapshots. When you disable faster launching, the AMI uses the standard launch process for each instance. All pre-provisioned snapshots must be removed before you can enable faster launching again.

Note

To change these settings, you must own the AMI.

Synopsis¶

  disable-fast-launch
--image-id <value>
[--force | --no-force]
[--dry-run | --no-dry-run]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--image-id (string)

The ID of the image for which you’re turning off faster launching, and removing pre-provisioned snapshots.

--force | --no-force (boolean)

Forces the image settings to turn off faster launching for your Windows AMI. This parameter overrides any errors that are encountered while cleaning up resources in your account.

--dry-run | --no-dry-run (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 .

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To discontinue fast launching for an image

The following disable-fast-launch example discontinues fast launching on the specified AMI, and cleans up existing pre-provisioned snapshots.

aws ec2 disable-fast-launch \
    --image-id ami-01234567890abcedf

Output:

{
    "ImageId": "ami-01234567890abcedf",
    "ResourceType": "snapshot",
    "SnapshotConfiguration": {},
    "LaunchTemplate": {
        "LaunchTemplateId": "lt-01234567890abcedf",
        "LaunchTemplateName": "EC2FastLaunchDefaultResourceCreation-a8c6215d-94e6-441b-9272-dbd1f87b07e2",
        "Version": "1"
    },
    "MaxParallelLaunches": 6,
    "OwnerId": "0123456789123",
    "State": "disabling",
    "StateTransitionReason": "Client.UserInitiated",
    "StateTransitionTime": "2022-01-27T22:47:29.265000+00:00"
}

For more information about configuring a Windows AMI for faster launching, see Configure your AMI for faster launching in the Amazon EC2 User Guide.

Output¶

ImageId -> (string)

The ID of the image for which faster-launching has been turned off.

ResourceType -> (string)

The pre-provisioning resource type that must be cleaned after turning off faster launching for the Windows AMI. Supported values include: snapshot .

SnapshotConfiguration -> (structure)

Parameters that were used for faster launching for the Windows AMI before faster launching was turned off. This informs the clean-up process.

TargetResourceCount -> (integer)

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

LaunchTemplate -> (structure)

The launch template that was used to launch 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 parallel instances to launch for creating resources.

OwnerId -> (string)

The owner of the Windows AMI for which faster launching was turned off.

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 -> (timestamp)

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

Table of Contents

Feedback

User Guide