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

Class: Aws::AutoScaling::Types::Ebs

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb

Overview

Note:

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

{
  snapshot_id: "XmlStringMaxLen255",
  volume_size: 1,
  volume_type: "BlockDeviceEbsVolumeType",
  delete_on_termination: false,
  iops: 1,
  encrypted: false,
}

Describes an Amazon EBS volume. Used in combination with BlockDeviceMapping.

Instance Attribute Summary collapse

Instance Attribute Details

#delete_on_terminationBoolean

Indicates whether the volume is deleted on instance termination. The default value is true.

Returns:

  • (Boolean)


2294
2295
2296
2297
2298
2299
2300
2301
2302
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 2294

class Ebs < Struct.new(
  :snapshot_id,
  :volume_size,
  :volume_type,
  :delete_on_termination,
  :iops,
  :encrypted)
  include Aws::Structure
end

#encryptedBoolean

Specifies whether the volume should be encrypted. Encrypted EBS volumes must be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are automatically encrypted. There is no way to create an encrypted volume from an unencrypted snapshot or an unencrypted volume from an encrypted snapshot. If your AMI uses encrypted volumes, you can only launch it on supported instance types. For more information, see Amazon EBS Encryption in the Amazon EC2 User Guide for Linux Instances.

Returns:

  • (Boolean)


2294
2295
2296
2297
2298
2299
2300
2301
2302
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 2294

class Ebs < Struct.new(
  :snapshot_id,
  :volume_size,
  :volume_type,
  :delete_on_termination,
  :iops,
  :encrypted)
  include Aws::Structure
end

#iopsInteger

The number of I/O operations per second (IOPS) to provision for the volume. For more information, see Amazon EBS Volume Types in the Amazon EC2 User Guide for Linux Instances.

Conditional: This parameter is required when the volume type is io1. (Not used with standard, gp2, st1, or sc1 volumes.)

Returns:

  • (Integer)


2294
2295
2296
2297
2298
2299
2300
2301
2302
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 2294

class Ebs < Struct.new(
  :snapshot_id,
  :volume_size,
  :volume_type,
  :delete_on_termination,
  :iops,
  :encrypted)
  include Aws::Structure
end

#snapshot_idString

The ID of the snapshot. This parameter is optional if you specify a volume size.

Returns:

  • (String)


2294
2295
2296
2297
2298
2299
2300
2301
2302
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 2294

class Ebs < Struct.new(
  :snapshot_id,
  :volume_size,
  :volume_type,
  :delete_on_termination,
  :iops,
  :encrypted)
  include Aws::Structure
end

#volume_sizeInteger

The volume size, in GiB.

Constraints: 1-1,024 for standard, 4-16,384 for io1, 1-16,384 for gp2, and 500-16,384 for st1 and sc1. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

Default: If you create a volume from a snapshot and you don't specify a volume size, the default is the snapshot size.

At least one of VolumeSize or SnapshotId is required.

Returns:

  • (Integer)


2294
2295
2296
2297
2298
2299
2300
2301
2302
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 2294

class Ebs < Struct.new(
  :snapshot_id,
  :volume_size,
  :volume_type,
  :delete_on_termination,
  :iops,
  :encrypted)
  include Aws::Structure
end

#volume_typeString

The volume type, which can be standard for Magnetic, io1 for Provisioned IOPS SSD, gp2 for General Purpose SSD, st1 for Throughput Optimized HDD, or sc1 for Cold HDD. For more information, see Amazon EBS Volume Types in the Amazon EC2 User Guide for Linux Instances.

Valid values: standard | io1 | gp2 | st1 | sc1

Returns:

  • (String)


2294
2295
2296
2297
2298
2299
2300
2301
2302
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 2294

class Ebs < Struct.new(
  :snapshot_id,
  :volume_size,
  :volume_type,
  :delete_on_termination,
  :iops,
  :encrypted)
  include Aws::Structure
end