Skip to content

Create Disk From Snapshot

lightsail_create_disk_from_snapshot R Documentation

Creates a block storage disk from a manual or automatic snapshot of a disk

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 (⁠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 Amazon Lightsail Developer Guide.

Usage

lightsail_create_disk_from_snapshot(diskName, diskSnapshotName,
  availabilityZone, sizeInGb, tags, addOns, sourceDiskName, restoreDate,
  useLatestRestorableAutoSnapshot)

Arguments

diskName

[required] The unique Lightsail disk name (my-disk).

diskSnapshotName

The name of the disk snapshot (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.

availabilityZone

[required] The Availability Zone where you want to create the disk (⁠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.

sizeInGb

[required] The size of the disk in GB (32).

tags

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

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

addOns

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

sourceDiskName

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 Amazon Lightsail Developer Guide.

restoreDate

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 Amazon Lightsail Developer Guide.

useLatestRestorableAutoSnapshot

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 Amazon Lightsail Developer Guide.

Value

A list with the following syntax: 

list(
  operations = list(
    list(
      id = "string",
      resourceName = "string",
      resourceType = "ContainerService"|"Instance"|"StaticIp"|"KeyPair"|"InstanceSnapshot"|"Domain"|"PeeredVpc"|"LoadBalancer"|"LoadBalancerTlsCertificate"|"Disk"|"DiskSnapshot"|"RelationalDatabase"|"RelationalDatabaseSnapshot"|"ExportSnapshotRecord"|"CloudFormationStackRecord"|"Alarm"|"ContactMethod"|"Distribution"|"Certificate"|"Bucket",
      createdAt = as.POSIXct(
        "2015-01-01"
      ),
      location = list(
        availabilityZone = "string",
        regionName = "us-east-1"|"us-east-2"|"us-west-1"|"us-west-2"|"eu-west-1"|"eu-west-2"|"eu-west-3"|"eu-central-1"|"ca-central-1"|"ap-south-1"|"ap-southeast-1"|"ap-southeast-2"|"ap-northeast-1"|"ap-northeast-2"|"eu-north-1"
      ),
      isTerminal = TRUE|FALSE,
      operationDetails = "string",
      operationType = "DeleteKnownHostKeys"|"DeleteInstance"|"CreateInstance"|"StopInstance"|"StartInstance"|"RebootInstance"|"OpenInstancePublicPorts"|"PutInstancePublicPorts"|"CloseInstancePublicPorts"|"AllocateStaticIp"|"ReleaseStaticIp"|"AttachStaticIp"|"DetachStaticIp"|"UpdateDomainEntry"|"DeleteDomainEntry"|"CreateDomain"|"DeleteDomain"|"CreateInstanceSnapshot"|"DeleteInstanceSnapshot"|"CreateInstancesFromSnapshot"|"CreateLoadBalancer"|"DeleteLoadBalancer"|"AttachInstancesToLoadBalancer"|"DetachInstancesFromLoadBalancer"|"UpdateLoadBalancerAttribute"|"CreateLoadBalancerTlsCertificate"|"DeleteLoadBalancerTlsCertificate"|"AttachLoadBalancerTlsCertificate"|"CreateDisk"|"DeleteDisk"|"AttachDisk"|"DetachDisk"|"CreateDiskSnapshot"|"DeleteDiskSnapshot"|"CreateDiskFromSnapshot"|"CreateRelationalDatabase"|"UpdateRelationalDatabase"|"DeleteRelationalDatabase"|"CreateRelationalDatabaseFromSnapshot"|"CreateRelationalDatabaseSnapshot"|"DeleteRelationalDatabaseSnapshot"|"UpdateRelationalDatabaseParameters"|"StartRelationalDatabase"|"RebootRelationalDatabase"|"StopRelationalDatabase"|"EnableAddOn"|"DisableAddOn"|"PutAlarm"|"GetAlarms"|"DeleteAlarm"|"TestAlarm"|"CreateContactMethod"|"GetContactMethods"|"SendContactMethodVerification"|"DeleteContactMethod"|"CreateDistribution"|"UpdateDistribution"|"DeleteDistribution"|"ResetDistributionCache"|"AttachCertificateToDistribution"|"DetachCertificateFromDistribution"|"UpdateDistributionBundle"|"SetIpAddressType"|"CreateCertificate"|"DeleteCertificate"|"CreateContainerService"|"UpdateContainerService"|"DeleteContainerService"|"CreateContainerServiceDeployment"|"CreateContainerServiceRegistryLogin"|"RegisterContainerImage"|"DeleteContainerImage"|"CreateBucket"|"DeleteBucket"|"CreateBucketAccessKey"|"DeleteBucketAccessKey"|"UpdateBucketBundle"|"UpdateBucket"|"SetResourceAccessForBucket"|"UpdateInstanceMetadataOptions"|"StartGUISession"|"StopGUISession"|"SetupInstanceHttps",
      status = "NotStarted"|"Started"|"Failed"|"Completed"|"Succeeded",
      statusChangedAt = as.POSIXct(
        "2015-01-01"
      ),
      errorCode = "string",
      errorDetails = "string"
    )
  )
)

Request syntax

svc$create_disk_from_snapshot(
  diskName = "string",
  diskSnapshotName = "string",
  availabilityZone = "string",
  sizeInGb = 123,
  tags = list(
    list(
      key = "string",
      value = "string"
    )
  ),
  addOns = list(
    list(
      addOnType = "AutoSnapshot"|"StopInstanceOnIdle",
      autoSnapshotAddOnRequest = list(
        snapshotTimeOfDay = "string"
      ),
      stopInstanceOnIdleRequest = list(
        threshold = "string",
        duration = "string"
      )
    )
  ),
  sourceDiskName = "string",
  restoreDate = "string",
  useLatestRestorableAutoSnapshot = TRUE|FALSE
)