CreateVolumeRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.ec2.model.Ec2Request
    - - software.amazon.awssdk.services.ec2.model.CreateVolumeRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateVolumeRequest.Builder,CreateVolumeRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateVolumeRequest
extends Ec2Request
implements ToCopyableBuilder<CreateVolumeRequest.Builder,CreateVolumeRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateVolumeRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateVolumeRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`availabilityZone()` The Availability Zone in which to create the volume.
`static CreateVolumeRequest.Builder`	`builder()`
`Boolean`	`encrypted()` Specifies whether the volume should be encrypted.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTagSpecifications()` Returns true if the TagSpecifications property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`Integer`	`iops()` The number of I/O operations per second (IOPS) to provision for the volume, with a maximum ratio of 50 IOPS/GiB.
`String`	`kmsKeyId()` The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption.
`Boolean`	`multiAttachEnabled()` Specifies whether to enable Amazon EBS Multi-Attach.
`String`	`outpostArn()` The Amazon Resource Name (ARN) of the Outpost.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateVolumeRequest.Builder>`	`serializableBuilderClass()`
`Integer`	`size()` The size of the volume, in GiBs.
`String`	`snapshotId()` The snapshot from which to create the volume.
`List<TagSpecification>`	`tagSpecifications()` The tags to apply to the volume during creation.
`CreateVolumeRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`VolumeType`	`volumeType()` The volume type.
`String`	`volumeTypeAsString()` The volume type.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - availabilityZone
```
public String availabilityZone()
```
    The Availability Zone in which to create the volume.
    
    Returns:
    
    The Availability Zone in which to create the volume.
  - encrypted
```
public Boolean 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, see Encryption by Default in the Amazon Elastic Compute Cloud User Guide.
    
    Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Supported Instance Types.
    
    Returns:
    
    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, see Encryption by Default in the Amazon Elastic Compute Cloud User Guide.
    
    Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Supported Instance Types.
  - iops
```
public Integer iops()
```
    The number of I/O operations per second (IOPS) to provision for the volume, with a maximum ratio of 50 IOPS/GiB. Range is 100 to 64,000 IOPS for volumes in most Regions. Maximum IOPS of 64,000 is guaranteed only on Nitro-based instances. Other instance families guarantee performance up to 32,000 IOPS. For more information, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.
    
    This parameter is valid only for Provisioned IOPS SSD (io1) volumes.
    
    Returns:
    
    The number of I/O operations per second (IOPS) to provision for the volume, with a maximum ratio of 50 IOPS/GiB. Range is 100 to 64,000 IOPS for volumes in most Regions. Maximum IOPS of 64,000 is guaranteed only on Nitro-based instances. Other instance families guarantee performance up to 32,000 IOPS. For more information, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.
    
    This parameter is valid only for Provisioned IOPS SSD (io1) volumes.
  - kmsKeyId
```
public String kmsKeyId()
```
    The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is specified, the encrypted state must be true.
    
    You can specify the CMK using any of the following:
    - Key ID. For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.
    - Key alias. For example, alias/ExampleAlias.
    - Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
    - Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
    AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.
    Returns:
    The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is specified, the encrypted state must be true.
    
    You can specify the CMK using any of the following:
    
    Key ID. For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.
    
    Key alias. For example, alias/ExampleAlias.
    
    Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
    
    Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
    
    AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.
  - outpostArn
```
public String outpostArn()
```
    The Amazon Resource Name (ARN) of the Outpost.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the Outpost.
  - size
```
public Integer size()
```
    The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size.
    
    Constraints: 1-16,384 for gp2, 4-16,384 for io1, 500-16,384 for st1, 500-16,384 for sc1, and 1-1,024 for standard. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.
    
    Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
    
    Returns:
    
    The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size.
    
    Constraints: 1-16,384 for gp2, 4-16,384 for io1, 500-16,384 for st1, 500-16,384 for sc1, and 1-1,024 for standard. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.
    
    Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
  - snapshotId
```
public String snapshotId()
```
    The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.
    
    Returns:
    
    The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.
  - volumeType
```
public VolumeType volumeType()
```
    The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.
    
    Default: gp2
    
    If the service returns an enum value that is not available in the current SDK version, volumeType will return VolumeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from volumeTypeAsString().
    
    Returns:
    
    The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.
    
    Default: gp2
    
    See Also:
    
    VolumeType
  - volumeTypeAsString
```
public String volumeTypeAsString()
```
    The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.
    
    Default: gp2
    
    If the service returns an enum value that is not available in the current SDK version, volumeType will return VolumeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from volumeTypeAsString().
    
    Returns:
    
    The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.
    
    Default: gp2
    
    See Also:
    
    VolumeType
  - hasTagSpecifications
```
public boolean hasTagSpecifications()
```
    Returns true if the TagSpecifications property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - tagSpecifications
```
public List<TagSpecification> tagSpecifications()
```
    The tags to apply to the volume during creation.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasTagSpecifications() to see if a value was sent in this field.
    
    Returns:
    
    The tags to apply to the volume during creation.
  - multiAttachEnabled
```
public Boolean multiAttachEnabled()
```
    Specifies whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the volume to up to 16 Nitro-based instances in the same Availability Zone. For more information, see Amazon EBS Multi-Attach in the Amazon Elastic Compute Cloud User Guide.
    
    Returns:
    
    Specifies whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the volume to up to 16 Nitro-based instances in the same Availability Zone. For more information, see Amazon EBS Multi-Attach in the Amazon Elastic Compute Cloud User Guide.
  - toBuilder
```
public CreateVolumeRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateVolumeRequest.Builder,CreateVolumeRequest>
    
    Specified by:
    
    toBuilder in class Ec2Request
  - builder
```
public static CreateVolumeRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateVolumeRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateVolumeRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

availabilityZone

encrypted

iops

kmsKeyId

outpostArn

size

snapshotId

volumeType

volumeTypeAsString

hasTagSpecifications

tagSpecifications

multiAttachEnabled

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields