Class: Aws::EC2::Types::EbsBlockDevice

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

Overview

Note:

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

{
  delete_on_termination: false,
  iops: 1,
  snapshot_id: "String",
  volume_size: 1,
  volume_type: "standard", # accepts standard, io1, io2, gp2, sc1, st1, gp3
  kms_key_id: "String",
  throughput: 1,
  outpost_arn: "String",
  encrypted: false,
}

Describes a block device for an EBS volume.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#delete_on_terminationBoolean

Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the Amazon EC2 User Guide.

Returns:

  • (Boolean)


26796
26797
26798
26799
26800
26801
26802
26803
26804
26805
26806
26807
26808
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 26796

class EbsBlockDevice < Struct.new(
  :delete_on_termination,
  :iops,
  :snapshot_id,
  :volume_size,
  :volume_type,
  :kms_key_id,
  :throughput,
  :outpost_arn,
  :encrypted)
  SENSITIVE = []
  include Aws::Structure
end

#encryptedBoolean

Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS encryption in the Amazon EC2 User Guide.

In no case can you remove encryption from an encrypted volume.

Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types.

This parameter is not returned by .

Returns:

  • (Boolean)


26796
26797
26798
26799
26800
26801
26802
26803
26804
26805
26806
26807
26808
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 26796

class EbsBlockDevice < Struct.new(
  :delete_on_termination,
  :iops,
  :snapshot_id,
  :volume_size,
  :volume_type,
  :kms_key_id,
  :throughput,
  :outpost_arn,
  :encrypted)
  SENSITIVE = []
  include Aws::Structure
end

#iopsInteger

The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.

The following are the supported values for each volume type:

  • gp3: 3,000-16,000 IOPS

  • io1: 100-64,000 IOPS

  • io2: 100-64,000 IOPS

For io1 and io2 volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System. Other instance families guarantee performance up to 32,000 IOPS.

This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for gp2, st1, sc1, or standard volumes.

Returns:

  • (Integer)


26796
26797
26798
26799
26800
26801
26802
26803
26804
26805
26806
26807
26808
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 26796

class EbsBlockDevice < Struct.new(
  :delete_on_termination,
  :iops,
  :snapshot_id,
  :volume_size,
  :volume_type,
  :kms_key_id,
  :throughput,
  :outpost_arn,
  :encrypted)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_idString

Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.

This parameter is only supported on BlockDeviceMapping objects called by RunInstances, RequestSpotFleet, and RequestSpotInstances.

Returns:

  • (String)


26796
26797
26798
26799
26800
26801
26802
26803
26804
26805
26806
26807
26808
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 26796

class EbsBlockDevice < Struct.new(
  :delete_on_termination,
  :iops,
  :snapshot_id,
  :volume_size,
  :volume_type,
  :kms_key_id,
  :throughput,
  :outpost_arn,
  :encrypted)
  SENSITIVE = []
  include Aws::Structure
end

#outpost_arnString

The ARN of the Outpost on which the snapshot is stored.

Returns:

  • (String)


26796
26797
26798
26799
26800
26801
26802
26803
26804
26805
26806
26807
26808
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 26796

class EbsBlockDevice < Struct.new(
  :delete_on_termination,
  :iops,
  :snapshot_id,
  :volume_size,
  :volume_type,
  :kms_key_id,
  :throughput,
  :outpost_arn,
  :encrypted)
  SENSITIVE = []
  include Aws::Structure
end

#snapshot_idString

The ID of the snapshot.

Returns:

  • (String)


26796
26797
26798
26799
26800
26801
26802
26803
26804
26805
26806
26807
26808
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 26796

class EbsBlockDevice < Struct.new(
  :delete_on_termination,
  :iops,
  :snapshot_id,
  :volume_size,
  :volume_type,
  :kms_key_id,
  :throughput,
  :outpost_arn,
  :encrypted)
  SENSITIVE = []
  include Aws::Structure
end

#throughputInteger

The throughput that the volume supports, in MiB/s.

This parameter is valid only for gp3 volumes.

Valid Range: Minimum value of 125. Maximum value of 1000.

Returns:

  • (Integer)


26796
26797
26798
26799
26800
26801
26802
26803
26804
26805
26806
26807
26808
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 26796

class EbsBlockDevice < Struct.new(
  :delete_on_termination,
  :iops,
  :snapshot_id,
  :volume_size,
  :volume_type,
  :kms_key_id,
  :throughput,
  :outpost_arn,
  :encrypted)
  SENSITIVE = []
  include Aws::Structure
end

#volume_sizeInteger

The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.

The following are the supported volumes sizes for each volume type:

  • gp2 and gp3:1-16,384

  • io1 and io2: 4-16,384

  • st1 and sc1: 125-16,384

  • standard: 1-1,024

Returns:

  • (Integer)


26796
26797
26798
26799
26800
26801
26802
26803
26804
26805
26806
26807
26808
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 26796

class EbsBlockDevice < Struct.new(
  :delete_on_termination,
  :iops,
  :snapshot_id,
  :volume_size,
  :volume_type,
  :kms_key_id,
  :throughput,
  :outpost_arn,
  :encrypted)
  SENSITIVE = []
  include Aws::Structure
end

#volume_typeString

The volume type. For more information, see Amazon EBS volume types in the Amazon EC2 User Guide. If the volume type is io1 or io2, you must specify the IOPS that the volume supports.

Returns:

  • (String)


26796
26797
26798
26799
26800
26801
26802
26803
26804
26805
26806
26807
26808
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 26796

class EbsBlockDevice < Struct.new(
  :delete_on_termination,
  :iops,
  :snapshot_id,
  :volume_size,
  :volume_type,
  :kms_key_id,
  :throughput,
  :outpost_arn,
  :encrypted)
  SENSITIVE = []
  include Aws::Structure
end