You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Lightsail::Types::CreateDiskSnapshotRequest

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

{
  disk_name: "ResourceName",
  disk_snapshot_name: "ResourceName", # required
  instance_name: "ResourceName",
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
}

Instance Attribute Summary collapse

Instance Attribute Details

#disk_nameString

The unique name of the source disk (e.g., Disk-Virginia-1).

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

Returns:

  • (String)


807
808
809
810
811
812
813
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 807

class CreateDiskSnapshotRequest < Struct.new(
  :disk_name,
  :disk_snapshot_name,
  :instance_name,
  :tags)
  include Aws::Structure
end

#disk_snapshot_nameString

The name of the destination disk snapshot (e.g., my-disk-snapshot) based on the source disk.

Returns:

  • (String)


807
808
809
810
811
812
813
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 807

class CreateDiskSnapshotRequest < Struct.new(
  :disk_name,
  :disk_snapshot_name,
  :instance_name,
  :tags)
  include Aws::Structure
end

#instance_nameString

The unique name of the source instance (e.g., Amazon_Linux-512MB-Virginia-1). When this is defined, a snapshot of the instance's system volume is created.

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

Returns:

  • (String)


807
808
809
810
811
812
813
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 807

class CreateDiskSnapshotRequest < Struct.new(
  :disk_name,
  :disk_snapshot_name,
  :instance_name,
  :tags)
  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:



807
808
809
810
811
812
813
# File 'gems/aws-sdk-lightsail/lib/aws-sdk-lightsail/types.rb', line 807

class CreateDiskSnapshotRequest < Struct.new(
  :disk_name,
  :disk_snapshot_name,
  :instance_name,
  :tags)
  include Aws::Structure
end