Package software.amazon.awssdk.services.ecs.model

Interface TaskManagedEBSVolumeConfiguration.Builder

All Superinterfaces:
Buildable, CopyableBuilder<TaskManagedEBSVolumeConfiguration.Builder,TaskManagedEBSVolumeConfiguration>, SdkBuilder<TaskManagedEBSVolumeConfiguration.Builder,TaskManagedEBSVolumeConfiguration>, SdkPojo
Enclosing class:
TaskManagedEBSVolumeConfiguration
public static interface TaskManagedEBSVolumeConfiguration.Builder extends SdkPojo, CopyableBuilder<TaskManagedEBSVolumeConfiguration.Builder,TaskManagedEBSVolumeConfiguration>

  • Method Details

    • encrypted

      TaskManagedEBSVolumeConfiguration.Builder encrypted(Boolean encrypted)

      Indicates whether the volume should be encrypted. If no value is specified, encryption is turned on by default. This parameter maps 1:1 with the Encrypted parameter of the CreateVolume API in the Amazon EC2 API Reference.

      Parameters:
      encrypted - Indicates whether the volume should be encrypted. If no value is specified, encryption is turned on by default. This parameter maps 1:1 with the Encrypted parameter of the CreateVolume API in the Amazon EC2 API Reference.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • kmsKeyId

      TaskManagedEBSVolumeConfiguration.Builder kmsKeyId(String kmsKeyId)

      The Amazon Resource Name (ARN) identifier of the Amazon Web Services Key Management Service key to use for Amazon EBS encryption. When encryption is turned on and no Amazon Web Services Key Management Service key is specified, the default Amazon Web Services managed key for Amazon EBS volumes is used. This parameter maps 1:1 with the KmsKeyId parameter of the CreateVolume API in the Amazon EC2 API Reference.

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

      Parameters:
      kmsKeyId - The Amazon Resource Name (ARN) identifier of the Amazon Web Services Key Management Service key to use for Amazon EBS encryption. When encryption is turned on and no Amazon Web Services Key Management Service key is specified, the default Amazon Web Services managed key for Amazon EBS volumes is used. This parameter maps 1:1 with the KmsKeyId parameter of the CreateVolume API in the Amazon EC2 API Reference.

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

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

    • volumeType

      TaskManagedEBSVolumeConfiguration.Builder volumeType(String volumeType)

      The volume type. This parameter maps 1:1 with the VolumeType parameter of the CreateVolume API in the Amazon EC2 API Reference. For more information, see Amazon EBS volume types in the Amazon EC2 User Guide.

      The following are the supported volume types.

      • General Purpose SSD: gp2|gp3

      • Provisioned IOPS SSD: io1|io2

      • Throughput Optimized HDD: st1

      • Cold HDD: sc1

      • Magnetic: standard

        The magnetic volume type is not supported on Fargate.

      Parameters:
      volumeType - The volume type. This parameter maps 1:1 with the VolumeType parameter of the CreateVolume API in the Amazon EC2 API Reference. For more information, see Amazon EBS volume types in the Amazon EC2 User Guide.

      The following are the supported volume types.

      • General Purpose SSD: gp2|gp3

      • Provisioned IOPS SSD: io1|io2

      • Throughput Optimized HDD: st1

      • Cold HDD: sc1

      • Magnetic: standard

        The magnetic volume type is not supported on Fargate.

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

    • sizeInGiB

      TaskManagedEBSVolumeConfiguration.Builder sizeInGiB(Integer sizeInGiB)

      The size of the volume in GiB. You must specify either a volume size or a snapshot ID. If you specify a snapshot ID, the snapshot size is used for the volume size by default. You can optionally specify a volume size greater than or equal to the snapshot size. This parameter maps 1:1 with the Size parameter of the CreateVolume API in the Amazon EC2 API Reference.

      The following are the supported volume size values for each volume type.

      • gp2 and gp3: 1-16,384

      • io1 and io2: 4-16,384

      • st1 and sc1: 125-16,384

      • standard: 1-1,024

      Parameters:
      sizeInGiB - The size of the volume in GiB. You must specify either a volume size or a snapshot ID. If you specify a snapshot ID, the snapshot size is used for the volume size by default. You can optionally specify a volume size greater than or equal to the snapshot size. This parameter maps 1:1 with the Size parameter of the CreateVolume API in the Amazon EC2 API Reference.

      The following are the supported volume size values for each volume type.

      • gp2 and gp3: 1-16,384

      • io1 and io2: 4-16,384

      • st1 and sc1: 125-16,384

      • standard: 1-1,024

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

    • snapshotId

      TaskManagedEBSVolumeConfiguration.Builder snapshotId(String snapshotId)

      The snapshot that Amazon ECS uses to create the volume. You must specify either a snapshot ID or a volume size. This parameter maps 1:1 with the SnapshotId parameter of the CreateVolume API in the Amazon EC2 API Reference.

      Parameters:
      snapshotId - The snapshot that Amazon ECS uses to create the volume. You must specify either a snapshot ID or a volume size. This parameter maps 1:1 with the SnapshotId parameter of the CreateVolume API in the Amazon EC2 API Reference.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • iops

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

      This parameter is required for io1 and io2 volume types. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for st1, sc1, or standard volume types.

      This parameter maps 1:1 with the Iops parameter of the CreateVolume API in the Amazon EC2 API Reference.

      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

      This parameter is required for io1 and io2 volume types. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for st1, sc1, or standard volume types.

      This parameter maps 1:1 with the Iops parameter of the CreateVolume API in the Amazon EC2 API Reference.

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

    • throughput

      TaskManagedEBSVolumeConfiguration.Builder throughput(Integer throughput)

      The throughput to provision for a volume, in MiB/s, with a maximum of 1,000 MiB/s. This parameter maps 1:1 with the Throughput parameter of the CreateVolume API in the Amazon EC2 API Reference.

      This parameter is only supported for the gp3 volume type.

      Parameters:
      throughput - The throughput to provision for a volume, in MiB/s, with a maximum of 1,000 MiB/s. This parameter maps 1:1 with the Throughput parameter of the CreateVolume API in the Amazon EC2 API Reference.

      This parameter is only supported for the gp3 volume type.

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

    • tagSpecifications

      TaskManagedEBSVolumeConfiguration.Builder tagSpecifications(Collection<EBSTagSpecification> tagSpecifications)

      The tags to apply to the volume. Amazon ECS applies service-managed tags by default. This parameter maps 1:1 with the TagSpecifications.N parameter of the CreateVolume API in the Amazon EC2 API Reference.

      Parameters:
      tagSpecifications - The tags to apply to the volume. Amazon ECS applies service-managed tags by default. This parameter maps 1:1 with the TagSpecifications.N parameter of the CreateVolume API in the Amazon EC2 API Reference.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tagSpecifications

      TaskManagedEBSVolumeConfiguration.Builder tagSpecifications(EBSTagSpecification... tagSpecifications)

      The tags to apply to the volume. Amazon ECS applies service-managed tags by default. This parameter maps 1:1 with the TagSpecifications.N parameter of the CreateVolume API in the Amazon EC2 API Reference.

      Parameters:
      tagSpecifications - The tags to apply to the volume. Amazon ECS applies service-managed tags by default. This parameter maps 1:1 with the TagSpecifications.N parameter of the CreateVolume API in the Amazon EC2 API Reference.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tagSpecifications

      TaskManagedEBSVolumeConfiguration.Builder tagSpecifications(Consumer<EBSTagSpecification.Builder>... tagSpecifications)

      The tags to apply to the volume. Amazon ECS applies service-managed tags by default. This parameter maps 1:1 with the TagSpecifications.N parameter of the CreateVolume API in the Amazon EC2 API Reference.

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

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

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

    • roleArn

      TaskManagedEBSVolumeConfiguration.Builder roleArn(String roleArn)

      The ARN of the IAM role to associate with this volume. This is the Amazon ECS infrastructure IAM role that is used to manage your Amazon Web Services infrastructure. We recommend using the Amazon ECS-managed AmazonECSInfrastructureRolePolicyForVolumes IAM policy with this role. For more information, see Amazon ECS infrastructure IAM role in the Amazon ECS Developer Guide.

      Parameters:
      roleArn - The ARN of the IAM role to associate with this volume. This is the Amazon ECS infrastructure IAM role that is used to manage your Amazon Web Services infrastructure. We recommend using the Amazon ECS-managed AmazonECSInfrastructureRolePolicyForVolumes IAM policy with this role. For more information, see Amazon ECS infrastructure IAM role in the Amazon ECS Developer Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • terminationPolicy

      TaskManagedEBSVolumeConfiguration.Builder terminationPolicy(TaskManagedEBSVolumeTerminationPolicy terminationPolicy)

      The termination policy for the volume when the task exits. This provides a way to control whether Amazon ECS terminates the Amazon EBS volume when the task stops.

      Parameters:
      terminationPolicy - The termination policy for the volume when the task exits. This provides a way to control whether Amazon ECS terminates the Amazon EBS volume when the task stops.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • terminationPolicy

      default TaskManagedEBSVolumeConfiguration.Builder terminationPolicy(Consumer<TaskManagedEBSVolumeTerminationPolicy.Builder> terminationPolicy)

      The termination policy for the volume when the task exits. This provides a way to control whether Amazon ECS terminates the Amazon EBS volume when the task stops.

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

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

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

    • filesystemType

      TaskManagedEBSVolumeConfiguration.Builder filesystemType(String filesystemType)

      The Linux filesystem type for the volume. For volumes created from a snapshot, you must specify the same filesystem type that the volume was using when the snapshot was created. If there is a filesystem type mismatch, the task will fail to start.

      The available filesystem types are
 ext3, ext4, and xfs. If no value is specified, the xfs filesystem type is used by default.

      Parameters:
      filesystemType - The Linux filesystem type for the volume. For volumes created from a snapshot, you must specify the same filesystem type that the volume was using when the snapshot was created. If there is a filesystem type mismatch, the task will fail to start.

      The available filesystem types are
 ext3, ext4, and xfs. If no value is specified, the xfs filesystem type is used by default.

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

    • filesystemType

      TaskManagedEBSVolumeConfiguration.Builder filesystemType(TaskFilesystemType filesystemType)

      The Linux filesystem type for the volume. For volumes created from a snapshot, you must specify the same filesystem type that the volume was using when the snapshot was created. If there is a filesystem type mismatch, the task will fail to start.

      The available filesystem types are
 ext3, ext4, and xfs. If no value is specified, the xfs filesystem type is used by default.

      Parameters:
      filesystemType - The Linux filesystem type for the volume. For volumes created from a snapshot, you must specify the same filesystem type that the volume was using when the snapshot was created. If there is a filesystem type mismatch, the task will fail to start.

      The available filesystem types are
 ext3, ext4, and xfs. If no value is specified, the xfs filesystem type is used by default.

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