Interface CreateVolumeRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateVolumeRequest.Builder,CreateVolumeRequest>, Ec2Request.Builder, SdkBuilder<CreateVolumeRequest.Builder,CreateVolumeRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateVolumeRequest
@Mutable @NotThreadSafe public static interface CreateVolumeRequest.Builder extends Ec2Request.Builder, SdkPojo, CopyableBuilder<CreateVolumeRequest.Builder,CreateVolumeRequest>

  • Method Details

    • availabilityZone

      CreateVolumeRequest.Builder availabilityZone(String availabilityZone)

      The ID of the Availability Zone in which to create the volume. For example, us-east-1a.

      Parameters:
      availabilityZone - The ID of the Availability Zone in which to create the volume. For example, us-east-1a.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • encrypted

      CreateVolumeRequest.Builder encrypted(Boolean encrypted)

      Indicates 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 EBS User Guide.

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

      Parameters:
      encrypted - Indicates 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 EBS User Guide.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • iops

      CreateVolumeRequest.Builder iops(Integer iops)

      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 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.

      Parameters:
      iops - 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 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:
      Returns a reference to this object so that method calls can be chained together.

    • kmsKeyId

      CreateVolumeRequest.Builder kmsKeyId(String kmsKeyId)

      The identifier of the KMS key to use for Amazon EBS encryption. If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId is specified, the encrypted state must be true.

      You can specify the KMS key using any of the following:

      • Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.

      • Key alias. For example, alias/ExampleAlias.

      • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.

      • Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

      Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.

      Parameters:
      kmsKeyId - The identifier of the KMS key to use for Amazon EBS encryption. If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId is specified, the encrypted state must be true.

      You can specify the KMS key using any of the following:

      • Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.

      • Key alias. For example, alias/ExampleAlias.

      • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.

      • Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

      Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outpostArn

      CreateVolumeRequest.Builder outpostArn(String outpostArn)

      The Amazon Resource Name (ARN) of the Outpost on which to create the volume.

      If you intend to use a volume with an instance running on an outpost, then you must create the volume on the same outpost as the instance. You can't use a volume created in an Amazon Web Services Region with an instance on an Amazon Web Services outpost, or the other way around.

      Parameters:
      outpostArn - The Amazon Resource Name (ARN) of the Outpost on which to create the volume.

      If you intend to use a volume with an instance running on an outpost, then you must create the volume on the same outpost as the instance. You can't use a volume created in an Amazon Web Services Region with an instance on an Amazon Web Services outpost, or the other way around.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • size

      CreateVolumeRequest.Builder size(Integer size)

      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 GiB

      • io1: 4 - 16,384 GiB

      • io2: 4 - 65,536 GiB

      • st1 and sc1: 125 - 16,384 GiB

      • standard: 1 - 1024 GiB

      Parameters:
      size - 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 GiB

      • io1: 4 - 16,384 GiB

      • io2: 4 - 65,536 GiB

      • st1 and sc1: 125 - 16,384 GiB

      • standard: 1 - 1024 GiB

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • snapshotId

      CreateVolumeRequest.Builder snapshotId(String snapshotId)

      The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.

      Parameters:
      snapshotId - The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • volumeType

      CreateVolumeRequest.Builder volumeType(String volumeType)

      The volume type. This parameter can be one of the following values:

      • General Purpose SSD: gp2 | gp3

      • Provisioned IOPS SSD: io1 | io2

      • Throughput Optimized HDD: st1

      • Cold HDD: sc1

      • Magnetic: standard

      Throughput Optimized HDD (st1) and Cold HDD (sc1) volumes can't be used as boot volumes.

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

      Default: gp2

      Parameters:
      volumeType - The volume type. This parameter can be one of the following values:

      • General Purpose SSD: gp2 | gp3

      • Provisioned IOPS SSD: io1 | io2

      • Throughput Optimized HDD: st1

      • Cold HDD: sc1

      • Magnetic: standard

      Throughput Optimized HDD (st1) and Cold HDD (sc1) volumes can't be used as boot volumes.

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

      Default: gp2

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • volumeType

      CreateVolumeRequest.Builder volumeType(VolumeType volumeType)

      The volume type. This parameter can be one of the following values:

      • General Purpose SSD: gp2 | gp3

      • Provisioned IOPS SSD: io1 | io2

      • Throughput Optimized HDD: st1

      • Cold HDD: sc1

      • Magnetic: standard

      Throughput Optimized HDD (st1) and Cold HDD (sc1) volumes can't be used as boot volumes.

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

      Default: gp2

      Parameters:
      volumeType - The volume type. This parameter can be one of the following values:

      • General Purpose SSD: gp2 | gp3

      • Provisioned IOPS SSD: io1 | io2

      • Throughput Optimized HDD: st1

      • Cold HDD: sc1

      • Magnetic: standard

      Throughput Optimized HDD (st1) and Cold HDD (sc1) volumes can't be used as boot volumes.

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

      Default: gp2

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tagSpecifications

      CreateVolumeRequest.Builder tagSpecifications(Collection<TagSpecification> tagSpecifications)

      The tags to apply to the volume during creation.

      Parameters:
      tagSpecifications - The tags to apply to the volume during creation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tagSpecifications

      CreateVolumeRequest.Builder tagSpecifications(TagSpecification... tagSpecifications)

      The tags to apply to the volume during creation.

      Parameters:
      tagSpecifications - The tags to apply to the volume during creation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tagSpecifications

      CreateVolumeRequest.Builder tagSpecifications(Consumer<TagSpecification.Builder>... tagSpecifications)

      The tags to apply to the volume during creation.

      This is a convenience method that creates an instance of the TagSpecification.Builder avoiding the need to create one manually via TagSpecification.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tagSpecifications(List<TagSpecification>).

      Parameters:
      tagSpecifications - a consumer that will call methods on TagSpecification.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • multiAttachEnabled

      CreateVolumeRequest.Builder multiAttachEnabled(Boolean multiAttachEnabled)

      Indicates whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the volume to up to 16 Instances built on the Nitro System in the same Availability Zone. This parameter is supported with io1 and io2 volumes only. For more information, see Amazon EBS Multi-Attach in the Amazon EBS User Guide.

      Parameters:
      multiAttachEnabled - Indicates whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the volume to up to 16 Instances built on the Nitro System in the same Availability Zone. This parameter is supported with io1 and io2 volumes only. For more information, see Amazon EBS Multi-Attach in the Amazon EBS User Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • throughput

      CreateVolumeRequest.Builder throughput(Integer throughput)

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

      This parameter is valid only for gp3 volumes.

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

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

      This parameter is valid only for gp3 volumes.

      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.

    • clientToken

      CreateVolumeRequest.Builder clientToken(String clientToken)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.

      Parameters:
      clientToken - Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • volumeInitializationRate

      CreateVolumeRequest.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.

    • operator

      CreateVolumeRequest.Builder operator(OperatorRequest operator)

      Reserved for internal use.

      Parameters:
      operator - Reserved for internal use.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • operator

      default CreateVolumeRequest.Builder operator(Consumer<OperatorRequest.Builder> operator)

      Reserved for internal use.

      This is a convenience method that creates an instance of the OperatorRequest.Builder avoiding the need to create one manually via OperatorRequest.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to operator(OperatorRequest).

      Parameters:
      operator - a consumer that will call methods on OperatorRequest.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • dryRun

      CreateVolumeRequest.Builder dryRun(Boolean dryRun)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

      Parameters:
      dryRun - Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreateVolumeRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateVolumeRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.