Class VolumeProps.Builder
java.lang.Object
software.amazon.awscdk.services.ec2.VolumeProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<VolumeProps>
- Enclosing interface:
VolumeProps
@Stability(Stable)
public static final class VolumeProps.Builder
extends Object
implements software.amazon.jsii.Builder<VolumeProps>
A builder for
VolumeProps
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionautoEnableIo
(Boolean autoEnableIo) Sets the value ofVolumeProps.getAutoEnableIo()
availabilityZone
(String availabilityZone) Sets the value ofVolumeProps.getAvailabilityZone()
build()
Builds the configured instance.enableMultiAttach
(Boolean enableMultiAttach) Sets the value ofVolumeProps.getEnableMultiAttach()
Sets the value ofVolumeProps.getEncrypted()
encryptionKey
(IKey encryptionKey) Sets the value ofVolumeProps.getEncryptionKey()
Sets the value ofVolumeProps.getIops()
removalPolicy
(RemovalPolicy removalPolicy) Sets the value ofVolumeProps.getRemovalPolicy()
Sets the value ofVolumeProps.getSize()
snapshotId
(String snapshotId) Sets the value ofVolumeProps.getSnapshotId()
volumeName
(String volumeName) Sets the value ofVolumeProps.getVolumeName()
volumeType
(EbsDeviceVolumeType volumeType) Sets the value ofVolumeProps.getVolumeType()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
availabilityZone
Sets the value ofVolumeProps.getAvailabilityZone()
- Parameters:
availabilityZone
- The Availability Zone in which to create the volume. This parameter is required.- Returns:
this
-
autoEnableIo
Sets the value ofVolumeProps.getAutoEnableIo()
- Parameters:
autoEnableIo
- Indicates whether the volume is auto-enabled for I/O operations. By default, Amazon EBS disables I/O to the volume from attached EC2 instances when it determines that a volume's data is potentially inconsistent. If the consistency of the volume is not a concern, and you prefer that the volume be made available immediately if it's impaired, you can configure the volume to automatically enable I/O.- Returns:
this
-
enableMultiAttach
Sets the value ofVolumeProps.getEnableMultiAttach()
- Parameters:
enableMultiAttach
- Indicates whether Amazon EBS Multi-Attach is enabled. Seeinvalid @link
{@link https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volumes-multi.html#considerations|Considerations
- Returns:
this
-
encrypted
Sets the value ofVolumeProps.getEncrypted()
- Parameters:
encrypted
- Specifies whether the volume should be encrypted. 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, seeinvalid @link
{@link https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default|Encryption
invalid @link
{@link https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances|Supported
- Returns:
this
-
encryptionKey
Sets the value ofVolumeProps.getEncryptionKey()
- Parameters:
encryptionKey
- The customer-managed encryption key that is used to encrypt the Volume. The encrypted property must be true if this is provided. Note: If using aninvalid @link
{@link aws-kms.IKey
invalid @link
{@link aws-kms.Key.fromKeyArn()
ex: arn:aws:iam::00000000000:root" }, "Resource": "*", "Action": [ "kms:DescribeKey", "kms:GenerateDataKeyWithoutPlainText", ], "Condition": { "StringEquals": { "kms:ViaService": "ec2. .amazonaws.com", (eg: ec2.us-east-1.amazonaws.com) "kms:CallerAccount": "0000000000" (your account ID) } } } ``` - Returns:
this
-
iops
Sets the value ofVolumeProps.getIops()
- Parameters:
iops
- The number of I/O operations per second (IOPS) to provision for the volume. The maximum ratio is 50 IOPS/GiB for PROVISIONED_IOPS_SSD, and 500 IOPS/GiB for both PROVISIONED_IOPS_SSD_IO2 and GENERAL_PURPOSE_SSD_GP3. Seeinvalid @link
{@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html
- Returns:
this
-
removalPolicy
Sets the value ofVolumeProps.getRemovalPolicy()
- Parameters:
removalPolicy
- Policy to apply when the volume is removed from the stack.- Returns:
this
-
size
Sets the value ofVolumeProps.getSize()
- Parameters:
size
- The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. Seeinvalid @link
{@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-ebs-volume.html
- Returns:
this
-
snapshotId
Sets the value ofVolumeProps.getSnapshotId()
- Parameters:
snapshotId
- The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.- Returns:
this
-
volumeName
Sets the value ofVolumeProps.getVolumeName()
- Parameters:
volumeName
- The value of the physicalName property of this resource.- Returns:
this
-
volumeType
Sets the value ofVolumeProps.getVolumeType()
- Parameters:
volumeType
- The type of the volume;. what type of storage to use to form the EBS Volume.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<VolumeProps>
- Returns:
- a new instance of
VolumeProps
- Throws:
NullPointerException
- if any required attribute was not provided
-