Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . lightsail ]

create-disk-from-snapshot

Description

Creates a block storage disk from a manual or automatic snapshot of a disk. The resulting disk can be attached to an Amazon Lightsail instance in the same Availability Zone (e.g., us-east-2a ).

The create disk from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identified by disk snapshot name . For more information, see the Lightsail Dev Guide .

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-disk-from-snapshot
--disk-name <value>
[--disk-snapshot-name <value>]
--availability-zone <value>
--size-in-gb <value>
[--tags <value>]
[--add-ons <value>]
[--source-disk-name <value>]
[--restore-date <value>]
[--use-latest-restorable-auto-snapshot | --no-use-latest-restorable-auto-snapshot]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--disk-name (string)

The unique Lightsail disk name (e.g., my-disk ).

--disk-snapshot-name (string)

The name of the disk snapshot (e.g., my-snapshot ) from which to create the new storage disk.

Constraint:

  • This parameter cannot be defined together with the source disk name parameter. The disk snapshot name and source disk name parameters are mutually exclusive.

--availability-zone (string)

The Availability Zone where you want to create the disk (e.g., us-east-2a ). Choose the same Availability Zone as the Lightsail instance where you want to create the disk.

Use the GetRegions operation to list the Availability Zones where Lightsail is currently available.

--size-in-gb (integer)

The size of the disk in GB (e.g., 32 ).

--tags (list)

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it's created.

(structure)

Describes a tag key and optional value assigned to an Amazon Lightsail resource.

For more information about tags in Lightsail, see the Lightsail Dev Guide .

key -> (string)

The key of the tag.

Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @

value -> (string)

The value of the tag.

Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @

Shorthand Syntax:

key=string,value=string ...

JSON Syntax:

[
  {
    "key": "string",
    "value": "string"
  }
  ...
]

--add-ons (list)

An array of objects that represent the add-ons to enable for the new disk.

(structure)

Describes a request to enable, modify, or disable an add-on for an Amazon Lightsail resource.

Note

An additional cost may be associated with enabling add-ons. For more information, see the Lightsail pricing page .

addOnType -> (string)

The add-on type.

autoSnapshotAddOnRequest -> (structure)

An object that represents additional parameters when enabling or modifying the automatic snapshot add-on.

snapshotTimeOfDay -> (string)

The daily time when an automatic snapshot will be created.

Constraints:

  • Must be in HH:00 format, and in an hourly increment.
  • Specified in Coordinated Universal Time (UTC).
  • The snapshot will be automatically created between the time specified and up to 45 minutes after.

Shorthand Syntax:

addOnType=string,autoSnapshotAddOnRequest={snapshotTimeOfDay=string} ...

JSON Syntax:

[
  {
    "addOnType": "AutoSnapshot",
    "autoSnapshotAddOnRequest": {
      "snapshotTimeOfDay": "string"
    }
  }
  ...
]

--source-disk-name (string)

The name of the source disk from which the source automatic snapshot was created.

Constraints:

  • This parameter cannot be defined together with the disk snapshot name parameter. The source disk name and disk snapshot name parameters are mutually exclusive.
  • Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the Lightsail Dev Guide .

--restore-date (string)

The date of the automatic snapshot to use for the new disk. Use the get auto snapshots operation to identify the dates of the available automatic snapshots.

Constraints:

  • Must be specified in YYYY-MM-DD format.
  • This parameter cannot be defined together with the use latest restorable auto snapshot parameter. The restore date and use latest restorable auto snapshot parameters are mutually exclusive.
  • Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the Lightsail Dev Guide .

--use-latest-restorable-auto-snapshot | --no-use-latest-restorable-auto-snapshot (boolean)

A Boolean value to indicate whether to use the latest available automatic snapshot.

Constraints:

  • This parameter cannot be defined together with the restore date parameter. The use latest restorable auto snapshot and restore date parameters are mutually exclusive.
  • Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the Lightsail Dev Guide .

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To create a create a disk from a disk snapshot

The following create-disk-from-snapshot example creates a block storage disk named Disk-2 from the specified block storage disk snapshot. The disk is created in the specified AWS Region and Availability Zone, with 32 GB of storage space.

aws lightsail create-disk-from-snapshot \
    --disk-name Disk-2 \
    --disk-snapshot-name Disk-1-1566839161 \
    --availability-zone us-west-2a \
    --size-in-gb 32

Output:

{
    "operations": [
        {
            "id": "d42b605d-5ef1-4b4a-8791-7a3e8b66b5e7",
            "resourceName": "Disk-2",
            "resourceType": "Disk",
            "createdAt": 1569624941.471,
            "location": {
                "availabilityZone": "us-west-2a",
                "regionName": "us-west-2"
            },
            "isTerminal": false,
            "operationType": "CreateDiskFromSnapshot",
            "status": "Started",
            "statusChangedAt": 1569624941.791
        }
    ]
}

For more information, see Creating a block storage disk from a snapshot in Amazon Lightsail in the Lightsail Developer Guide.

Output

operations -> (list)

An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

(structure)

Describes the API operation.

id -> (string)

The ID of the operation.

resourceName -> (string)

The resource name.

resourceType -> (string)

The resource type.

createdAt -> (timestamp)

The timestamp when the operation was initialized (e.g., 1479816991.349 ).

location -> (structure)

The AWS Region and Availability Zone.

availabilityZone -> (string)

The Availability Zone. Follows the format us-east-2a (case-sensitive).

regionName -> (string)

The AWS Region name.

isTerminal -> (boolean)

A Boolean value indicating whether the operation is terminal.

operationDetails -> (string)

Details about the operation (e.g., Debian-1GB-Ohio-1 ).

operationType -> (string)

The type of operation.

status -> (string)

The status of the operation.

statusChangedAt -> (timestamp)

The timestamp when the status was changed (e.g., 1479816991.349 ).

errorCode -> (string)

The error code.

errorDetails -> (string)

The error details.