Struct LaunchTemplateEbsBlockDeviceRequest

#[non_exhaustive]
pub struct LaunchTemplateEbsBlockDeviceRequest {
    pub encrypted: Option<bool>,
    pub delete_on_termination: Option<bool>,
    pub iops: Option<i32>,
    pub kms_key_id: Option<String>,
    pub snapshot_id: Option<String>,
    pub volume_size: Option<i32>,
    pub volume_type: Option<VolumeType>,
    pub throughput: Option<i32>,
    pub volume_initialization_rate: Option<i32>,
}

The parameters for a block device for an EBS volume.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

encrypted: Option<bool>

Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value.

delete_on_termination: Option<bool>

Indicates whether the EBS volume is deleted on instance termination.

iops: Option<i32>

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 - 256,000 IOPS

For io2 volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS.

This parameter is supported for io1, io2, and gp3 volumes only.

kms_key_id: Option<String>

Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption.

snapshot_id: Option<String>

The ID of the snapshot.

volume_size: Option<i32>

The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. The following are the supported volumes sizes for each volume type:

• gp2 and gp3: 1 - 16,384 GiB

• io1: 4 - 16,384 GiB

• io2: 4 - 65,536 GiB

• st1 and sc1: 125 - 16,384 GiB

• standard: 1 - 1024 GiB

volume_type: Option<VolumeType>

The volume type. For more information, see Amazon EBS volume types in the Amazon EBS User Guide.

throughput: Option<i32>

The throughput to provision for a gp3 volume, with a maximum of 1,000 MiB/s.

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

volume_initialization_rate: Option<i32>

Specifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download the snapshot blocks from Amazon S3 to the volume. This is also known as volume initialization. Specifying a volume initialization rate ensures that the volume is initialized at a predictable and consistent rate after creation.

This parameter is supported only for volumes created from snapshots. Omit this parameter if:

• You want to create the volume using fast snapshot restore. You must specify a snapshot that is enabled for fast snapshot restore. In this case, the volume is fully initialized at creation.

  If you specify a snapshot that is enabled for fast snapshot restore and a volume initialization rate, the volume will be initialized at the specified rate instead of fast snapshot restore.

• You want to create a volume that is initialized at the default rate.

For more information, see Initialize Amazon EBS volumes in the Amazon EC2 User Guide.

Valid range: 100 - 300 MiB/s

Implementations

impl LaunchTemplateEbsBlockDeviceRequest

pub fn encrypted(&self) -> Option<bool>

Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value.

pub fn delete_on_termination(&self) -> Option<bool>

Indicates whether the EBS volume is deleted on instance termination.

pub fn iops(&self) -> Option<i32>

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 - 256,000 IOPS

For io2 volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS.

This parameter is supported for io1, io2, and gp3 volumes only.

pub fn kms_key_id(&self) -> Option<&str>

Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption.

pub fn snapshot_id(&self) -> Option<&str>

The ID of the snapshot.

pub fn volume_size(&self) -> Option<i32>

The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. The following are the supported volumes sizes for each volume type:

• gp2 and gp3: 1 - 16,384 GiB

• io1: 4 - 16,384 GiB

• io2: 4 - 65,536 GiB

• st1 and sc1: 125 - 16,384 GiB

• standard: 1 - 1024 GiB

pub fn volume_type(&self) -> Option<&VolumeType>

The volume type. For more information, see Amazon EBS volume types in the Amazon EBS User Guide.

pub fn throughput(&self) -> Option<i32>

The throughput to provision for a gp3 volume, with a maximum of 1,000 MiB/s.

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

pub fn volume_initialization_rate(&self) -> Option<i32>

Specifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download the snapshot blocks from Amazon S3 to the volume. This is also known as volume initialization. Specifying a volume initialization rate ensures that the volume is initialized at a predictable and consistent rate after creation.

This parameter is supported only for volumes created from snapshots. Omit this parameter if:

• You want to create the volume using fast snapshot restore. You must specify a snapshot that is enabled for fast snapshot restore. In this case, the volume is fully initialized at creation.

  If you specify a snapshot that is enabled for fast snapshot restore and a volume initialization rate, the volume will be initialized at the specified rate instead of fast snapshot restore.

• You want to create a volume that is initialized at the default rate.

For more information, see Initialize Amazon EBS volumes in the Amazon EC2 User Guide.

Valid range: 100 - 300 MiB/s

impl LaunchTemplateEbsBlockDeviceRequest

pub fn builder() -> LaunchTemplateEbsBlockDeviceRequestBuilder

Creates a new builder-style object to manufacture LaunchTemplateEbsBlockDeviceRequest.

Trait Implementations

impl Clone for LaunchTemplateEbsBlockDeviceRequest

fn clone(&self) -> LaunchTemplateEbsBlockDeviceRequest

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for LaunchTemplateEbsBlockDeviceRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for LaunchTemplateEbsBlockDeviceRequest

fn eq(&self, other: &LaunchTemplateEbsBlockDeviceRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for LaunchTemplateEbsBlockDeviceRequest