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

Inherits:
Struct
  • Object
show all
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,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#add_onsArray<Types::AddOnRequest>

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

Returns:



1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1392

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_zoneString

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)


1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1392

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_nameString

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

Returns:

  • (String)


1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1392

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_nameString

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)


1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1392

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_dateString

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.

Returns:

  • (String)


1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1392

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_gbInteger

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

Returns:

  • (Integer)


1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1392

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_nameString

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.

Returns:

  • (String)


1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1392

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

#tagsArray<Types::Tag>

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

To tag a resource after it has been created, see the tag resource operation.

Returns:



1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1392

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_snapshotBoolean

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.

Returns:

  • (Boolean)


1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 1392

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