Class: Aws::Lightsail::Types::CreateDiskFromSnapshotRequest

Inherits:

Struct

• Object
• Struct
• Aws::Lightsail::Types::CreateDiskFromSnapshotRequest

Defined in:

gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb

Overview

Note:

When making an API call, you may pass CreateDiskFromSnapshotRequest data as a hash:

{
  disk_name: "ResourceName", # required
  disk_snapshot_name: "ResourceName",
  availability_zone: "NonEmptyString", # required
  size_in_gb: 1, # required
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
  add_ons: [
    {
      add_on_type: "AutoSnapshot", # required, accepts AutoSnapshot
      auto_snapshot_add_on_request: {
        snapshot_time_of_day: "TimeOfDay",
      },
    },
  ],
  source_disk_name: "string",
  restore_date: "string",
  use_latest_restorable_auto_snapshot: false,
}

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #add_ons ⇒ Array<Types::AddOnRequest>

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

• #availability_zone ⇒ String

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

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

• #restore_date ⇒ String

  The date of the automatic snapshot to use for the new disk.

• #size_in_gb ⇒ Integer

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

• #source_disk_name ⇒ String

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

• #tags ⇒ Array<Types::Tag>

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

• #use_latest_restorable_auto_snapshot ⇒ Boolean

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

Instance Attribute Details

#add_ons ⇒ Array<Types::AddOnRequest>

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

Returns:

• (Array<Types::AddOnRequest>)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3723

class CreateDiskFromSnapshotRequest < Struct.new(
  :disk_name,
  :disk_snapshot_name,
  :availability_zone,
  :size_in_gb,
  :tags,
  :add_ons,
  :source_disk_name,
  :restore_date,
  :use_latest_restorable_auto_snapshot)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

• (String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3723

class CreateDiskFromSnapshotRequest < Struct.new(
  :disk_name,
  :disk_snapshot_name,
  :availability_zone,
  :size_in_gb,
  :tags,
  :add_ons,
  :source_disk_name,
  :restore_date,
  :use_latest_restorable_auto_snapshot)
  SENSITIVE = []
  include Aws::Structure
end

#disk_name ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3723

class CreateDiskFromSnapshotRequest < Struct.new(
  :disk_name,
  :disk_snapshot_name,
  :availability_zone,
  :size_in_gb,
  :tags,
  :add_ons,
  :source_disk_name,
  :restore_date,
  :use_latest_restorable_auto_snapshot)
  SENSITIVE = []
  include Aws::Structure
end

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

^

Returns:

• (String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3723

class CreateDiskFromSnapshotRequest < Struct.new(
  :disk_name,
  :disk_snapshot_name,
  :availability_zone,
  :size_in_gb,
  :tags,
  :add_ons,
  :source_disk_name,
  :restore_date,
  :use_latest_restorable_auto_snapshot)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

• (String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3723

class CreateDiskFromSnapshotRequest < Struct.new(
  :disk_name,
  :disk_snapshot_name,
  :availability_zone,
  :size_in_gb,
  :tags,
  :add_ons,
  :source_disk_name,
  :restore_date,
  :use_latest_restorable_auto_snapshot)
  SENSITIVE = []
  include Aws::Structure
end

#size_in_gb ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3723

class CreateDiskFromSnapshotRequest < Struct.new(
  :disk_name,
  :disk_snapshot_name,
  :availability_zone,
  :size_in_gb,
  :tags,
  :add_ons,
  :source_disk_name,
  :restore_date,
  :use_latest_restorable_auto_snapshot)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

• (String)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3723

class CreateDiskFromSnapshotRequest < Struct.new(
  :disk_name,
  :disk_snapshot_name,
  :availability_zone,
  :size_in_gb,
  :tags,
  :add_ons,
  :source_disk_name,
  :restore_date,
  :use_latest_restorable_auto_snapshot)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

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.

Returns:

• (Array<Types::Tag>)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3723

class CreateDiskFromSnapshotRequest < Struct.new(
  :disk_name,
  :disk_snapshot_name,
  :availability_zone,
  :size_in_gb,
  :tags,
  :add_ons,
  :source_disk_name,
  :restore_date,
  :use_latest_restorable_auto_snapshot)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

• (Boolean)

# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 3723

class CreateDiskFromSnapshotRequest < Struct.new(
  :disk_name,
  :disk_snapshot_name,
  :availability_zone,
  :size_in_gb,
  :tags,
  :add_ons,
  :source_disk_name,
  :restore_date,
  :use_latest_restorable_auto_snapshot)
  SENSITIVE = []
  include Aws::Structure
end