Class: Aws::Lightsail::Types::CreateDiskRequest

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 CreateDiskRequest data as a hash:

{
  disk_name: "ResourceName", # required
  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",
      },
    },
  ],
}

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:



2121
2122
2123
2124
2125
2126
2127
2128
2129
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2121

class CreateDiskRequest < Struct.new(
  :disk_name,
  :availability_zone,
  :size_in_gb,
  :tags,
  :add_ons)
  SENSITIVE = []
  include Aws::Structure
end

#availability_zoneString

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

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

Returns:

  • (String)


2121
2122
2123
2124
2125
2126
2127
2128
2129
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2121

class CreateDiskRequest < Struct.new(
  :disk_name,
  :availability_zone,
  :size_in_gb,
  :tags,
  :add_ons)
  SENSITIVE = []
  include Aws::Structure
end

#disk_nameString

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

Returns:

  • (String)


2121
2122
2123
2124
2125
2126
2127
2128
2129
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2121

class CreateDiskRequest < Struct.new(
  :disk_name,
  :availability_zone,
  :size_in_gb,
  :tags,
  :add_ons)
  SENSITIVE = []
  include Aws::Structure
end

#size_in_gbInteger

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

Returns:

  • (Integer)


2121
2122
2123
2124
2125
2126
2127
2128
2129
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2121

class CreateDiskRequest < Struct.new(
  :disk_name,
  :availability_zone,
  :size_in_gb,
  :tags,
  :add_ons)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<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:



2121
2122
2123
2124
2125
2126
2127
2128
2129
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 2121

class CreateDiskRequest < Struct.new(
  :disk_name,
  :availability_zone,
  :size_in_gb,
  :tags,
  :add_ons)
  SENSITIVE = []
  include Aws::Structure
end