Interface LaunchTemplateEbsBlockDeviceRequest.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<LaunchTemplateEbsBlockDeviceRequest.Builder,LaunchTemplateEbsBlockDeviceRequest>,SdkBuilder<LaunchTemplateEbsBlockDeviceRequest.Builder,LaunchTemplateEbsBlockDeviceRequest>,SdkPojo
- Enclosing class:
- LaunchTemplateEbsBlockDeviceRequest
@Mutable @NotThreadSafe public static interface LaunchTemplateEbsBlockDeviceRequest.Builder extends SdkPojo, CopyableBuilder<LaunchTemplateEbsBlockDeviceRequest.Builder,LaunchTemplateEbsBlockDeviceRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description LaunchTemplateEbsBlockDeviceRequest.BuilderdeleteOnTermination(Boolean deleteOnTermination)Indicates whether the EBS volume is deleted on instance termination.LaunchTemplateEbsBlockDeviceRequest.Builderencrypted(Boolean encrypted)Indicates whether the EBS volume is encrypted.LaunchTemplateEbsBlockDeviceRequest.Builderiops(Integer iops)The number of I/O operations per second (IOPS).LaunchTemplateEbsBlockDeviceRequest.BuilderkmsKeyId(String kmsKeyId)Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption.LaunchTemplateEbsBlockDeviceRequest.BuildersnapshotId(String snapshotId)The ID of the snapshot.LaunchTemplateEbsBlockDeviceRequest.Builderthroughput(Integer throughput)The throughput to provision for agp3volume, with a maximum of 1,000 MiB/s.LaunchTemplateEbsBlockDeviceRequest.BuildervolumeInitializationRate(Integer volumeInitializationRate)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.LaunchTemplateEbsBlockDeviceRequest.BuildervolumeSize(Integer volumeSize)The size of the volume, in GiBs.LaunchTemplateEbsBlockDeviceRequest.BuildervolumeType(String volumeType)The volume type.LaunchTemplateEbsBlockDeviceRequest.BuildervolumeType(VolumeType volumeType)The volume type.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
-
-
-
Method Detail
-
encrypted
LaunchTemplateEbsBlockDeviceRequest.Builder encrypted(Boolean encrypted)
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.
- Parameters:
encrypted- 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
deleteOnTermination
LaunchTemplateEbsBlockDeviceRequest.Builder deleteOnTermination(Boolean deleteOnTermination)
Indicates whether the EBS volume is deleted on instance termination.
- Parameters:
deleteOnTermination- Indicates whether the EBS volume is deleted on instance termination.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
iops
LaunchTemplateEbsBlockDeviceRequest.Builder iops(Integer iops)
The number of I/O operations per second (IOPS). For
gp3,io1, andio2volumes, this represents the number of IOPS that are provisioned for the volume. Forgp2volumes, 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
io2volumes, 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, andgp3volumes only.- Parameters:
iops- The number of I/O operations per second (IOPS). Forgp3,io1, andio2volumes, this represents the number of IOPS that are provisioned for the volume. Forgp2volumes, 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
io2volumes, 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, andgp3volumes only.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
kmsKeyId
LaunchTemplateEbsBlockDeviceRequest.Builder kmsKeyId(String kmsKeyId)
Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption.
- Parameters:
kmsKeyId- Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
snapshotId
LaunchTemplateEbsBlockDeviceRequest.Builder snapshotId(String snapshotId)
The ID of the snapshot.
- Parameters:
snapshotId- The ID of the snapshot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
volumeSize
LaunchTemplateEbsBlockDeviceRequest.Builder volumeSize(Integer volumeSize)
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:
-
gp2andgp3: 1 - 16,384 GiB -
io1: 4 - 16,384 GiB -
io2: 4 - 65,536 GiB -
st1andsc1: 125 - 16,384 GiB -
standard: 1 - 1024 GiB
- Parameters:
volumeSize- 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:-
gp2andgp3: 1 - 16,384 GiB -
io1: 4 - 16,384 GiB -
io2: 4 - 65,536 GiB -
st1andsc1: 125 - 16,384 GiB -
standard: 1 - 1024 GiB
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
volumeType
LaunchTemplateEbsBlockDeviceRequest.Builder volumeType(String volumeType)
The volume type. For more information, see Amazon EBS volume types in the Amazon EBS User Guide.
- Parameters:
volumeType- The volume type. For more information, see Amazon EBS volume types in the Amazon EBS User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
VolumeType,VolumeType
-
volumeType
LaunchTemplateEbsBlockDeviceRequest.Builder volumeType(VolumeType volumeType)
The volume type. For more information, see Amazon EBS volume types in the Amazon EBS User Guide.
- Parameters:
volumeType- The volume type. For more information, see Amazon EBS volume types in the Amazon EBS User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
VolumeType,VolumeType
-
throughput
LaunchTemplateEbsBlockDeviceRequest.Builder throughput(Integer throughput)
The throughput to provision for a
gp3volume, with a maximum of 1,000 MiB/s.Valid Range: Minimum value of 125. Maximum value of 1000.
- Parameters:
throughput- The throughput to provision for agp3volume, with a maximum of 1,000 MiB/s.Valid Range: Minimum value of 125. Maximum value of 1000.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
volumeInitializationRate
LaunchTemplateEbsBlockDeviceRequest.Builder volumeInitializationRate(Integer volumeInitializationRate)
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
- Parameters:
volumeInitializationRate- 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
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
-