software.amazon.awscdk.services.ecs.CfnService.ServiceManagedEBSVolumeConfigurationProperty.Builder

All Implemented Interfaces:: software.amazon.jsii.Builder<CfnService.ServiceManagedEBSVolumeConfigurationProperty>

Enclosing interface:: CfnService.ServiceManagedEBSVolumeConfigurationProperty

@Stability(Stable) public static final class CfnService.ServiceManagedEBSVolumeConfigurationProperty.Builder extends Object implements software.amazon.jsii.Builder<CfnService.ServiceManagedEBSVolumeConfigurationProperty>

A builder for CfnService.ServiceManagedEBSVolumeConfigurationProperty

Constructor Summary

Constructors

Constructor

Description

Builder()
Method Summary

Modifier and Type

Method

Description

CfnService.ServiceManagedEBSVolumeConfigurationProperty

build()

Builds the configured instance.

CfnService.ServiceManagedEBSVolumeConfigurationProperty.Builder

encrypted(Boolean encrypted)

Sets the value of CfnService.ServiceManagedEBSVolumeConfigurationProperty.getEncrypted()

CfnService.ServiceManagedEBSVolumeConfigurationProperty.Builder

encrypted(IResolvable encrypted)

Sets the value of CfnService.ServiceManagedEBSVolumeConfigurationProperty.getEncrypted()

CfnService.ServiceManagedEBSVolumeConfigurationProperty.Builder

filesystemType(String filesystemType)

Sets the value of CfnService.ServiceManagedEBSVolumeConfigurationProperty.getFilesystemType()

CfnService.ServiceManagedEBSVolumeConfigurationProperty.Builder

iops(Number iops)

Sets the value of CfnService.ServiceManagedEBSVolumeConfigurationProperty.getIops()

CfnService.ServiceManagedEBSVolumeConfigurationProperty.Builder

kmsKeyId(String kmsKeyId)

Sets the value of CfnService.ServiceManagedEBSVolumeConfigurationProperty.getKmsKeyId()

CfnService.ServiceManagedEBSVolumeConfigurationProperty.Builder

roleArn(String roleArn)

Sets the value of CfnService.ServiceManagedEBSVolumeConfigurationProperty.getRoleArn()

CfnService.ServiceManagedEBSVolumeConfigurationProperty.Builder

sizeInGiB(Number sizeInGiB)

Sets the value of CfnService.ServiceManagedEBSVolumeConfigurationProperty.getSizeInGiB()

CfnService.ServiceManagedEBSVolumeConfigurationProperty.Builder

snapshotId(String snapshotId)

Sets the value of CfnService.ServiceManagedEBSVolumeConfigurationProperty.getSnapshotId()

CfnService.ServiceManagedEBSVolumeConfigurationProperty.Builder

tagSpecifications(List<? extends Object> tagSpecifications)

Sets the value of CfnService.ServiceManagedEBSVolumeConfigurationProperty.getTagSpecifications()

CfnService.ServiceManagedEBSVolumeConfigurationProperty.Builder

tagSpecifications(IResolvable tagSpecifications)

Sets the value of CfnService.ServiceManagedEBSVolumeConfigurationProperty.getTagSpecifications()

CfnService.ServiceManagedEBSVolumeConfigurationProperty.Builder

throughput(Number throughput)

Sets the value of CfnService.ServiceManagedEBSVolumeConfigurationProperty.getThroughput()

CfnService.ServiceManagedEBSVolumeConfigurationProperty.Builder

volumeInitializationRate(Number volumeInitializationRate)

Sets the value of CfnService.ServiceManagedEBSVolumeConfigurationProperty.getVolumeInitializationRate()

CfnService.ServiceManagedEBSVolumeConfigurationProperty.Builder

volumeType(String volumeType)

Sets the value of CfnService.ServiceManagedEBSVolumeConfigurationProperty.getVolumeType()

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

Constructor Details
- Builder
  
  public Builder()
Method Details
- roleArn
  
  @Stability(Stable) public CfnService.ServiceManagedEBSVolumeConfigurationProperty.Builder roleArn(String roleArn)
  
  Sets the value of CfnService.ServiceManagedEBSVolumeConfigurationProperty.getRoleArn()
  
  Parameters:
  
  roleArn - The ARN of the IAM role to associate with this volume. This parameter is required. This is the Amazon ECS infrastructure IAM role that is used to manage your AWS 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:
  
  this
- encrypted
  
  @Stability(Stable) public CfnService.ServiceManagedEBSVolumeConfigurationProperty.Builder encrypted(Boolean encrypted)
  
  Sets the value of CfnService.ServiceManagedEBSVolumeConfigurationProperty.getEncrypted()
  
  Parameters:
  
  encrypted - Indicates whether the volume should be encrypted. If you turn on Region-level Amazon EBS encryption by default but set this value as false , the setting is overridden and the volume is encrypted with the KMS key specified for Amazon EBS encryption by default. This parameter maps 1:1 with the Encrypted parameter of the CreateVolume API in the Amazon EC2 API Reference .
  
  Returns:
  
  this
- encrypted
  
  @Stability(Stable) public CfnService.ServiceManagedEBSVolumeConfigurationProperty.Builder encrypted(IResolvable encrypted)
  
  Sets the value of CfnService.ServiceManagedEBSVolumeConfigurationProperty.getEncrypted()
  
  Parameters:
  
  encrypted - Indicates whether the volume should be encrypted. If you turn on Region-level Amazon EBS encryption by default but set this value as false , the setting is overridden and the volume is encrypted with the KMS key specified for Amazon EBS encryption by default. This parameter maps 1:1 with the Encrypted parameter of the CreateVolume API in the Amazon EC2 API Reference .
  
  Returns:
  
  this
- filesystemType
  
  @Stability(Stable) public CfnService.ServiceManagedEBSVolumeConfigurationProperty.Builder filesystemType(String filesystemType)
  
  Sets the value of CfnService.ServiceManagedEBSVolumeConfigurationProperty.getFilesystemType()
  
  Parameters:
  
  filesystemType - The 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 tasks will fail to start.
  The available Linux filesystem types are ext3 , ext4 , and xfs . If no value is specified, the xfs filesystem type is used by default.
  The available Windows filesystem types are NTFS .
  
  Returns:
  
  this
- iops
  
  @Stability(Stable) public CfnService.ServiceManagedEBSVolumeConfigurationProperty.Builder iops(Number iops)
  
  Sets the value of CfnService.ServiceManagedEBSVolumeConfigurationProperty.getIops()
  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:
  
  this
- kmsKeyId
  
  @Stability(Stable) public CfnService.ServiceManagedEBSVolumeConfigurationProperty.Builder kmsKeyId(String kmsKeyId)
  
  Sets the value of CfnService.ServiceManagedEBSVolumeConfigurationProperty.getKmsKeyId()
  
  Parameters:
  
  kmsKeyId - The Amazon Resource Name (ARN) identifier of the AWS Key Management Service key to use for Amazon EBS encryption. When a key is specified using this parameter, it overrides Amazon EBS default encryption or any KMS key that you specified for cluster-level managed storage encryption. This parameter maps 1:1 with the KmsKeyId parameter of the CreateVolume API in the Amazon EC2 API Reference . For more information about encrypting Amazon EBS volumes attached to tasks, see Encrypt data stored in Amazon EBS volumes attached to Amazon ECS tasks .
  
  AWS authenticates the AWS 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:
  
  this
- sizeInGiB
  
  @Stability(Stable) public CfnService.ServiceManagedEBSVolumeConfigurationProperty.Builder sizeInGiB(Number sizeInGiB)
  
  Sets the value of CfnService.ServiceManagedEBSVolumeConfigurationProperty.getSizeInGiB()
  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:
  
  this
- snapshotId
  
  @Stability(Stable) public CfnService.ServiceManagedEBSVolumeConfigurationProperty.Builder snapshotId(String snapshotId)
  
  Sets the value of CfnService.ServiceManagedEBSVolumeConfigurationProperty.getSnapshotId()
  
  Parameters:
  
  snapshotId - The snapshot that Amazon ECS uses to create volumes for attachment to tasks maintained by the service. You must specify either snapshotId or sizeInGiB in your volume configuration. This parameter maps 1:1 with the SnapshotId parameter of the CreateVolume API in the Amazon EC2 API Reference .
  
  Returns:
  
  this
- tagSpecifications
  
  @Stability(Stable) public CfnService.ServiceManagedEBSVolumeConfigurationProperty.Builder tagSpecifications(IResolvable tagSpecifications)
  
  Sets the value of CfnService.ServiceManagedEBSVolumeConfigurationProperty.getTagSpecifications()
  
  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:
  
  this
- tagSpecifications
  
  @Stability(Stable) public CfnService.ServiceManagedEBSVolumeConfigurationProperty.Builder tagSpecifications(List<? extends Object> tagSpecifications)
  
  Sets the value of CfnService.ServiceManagedEBSVolumeConfigurationProperty.getTagSpecifications()
  
  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:
  
  this
- throughput
  
  @Stability(Stable) public CfnService.ServiceManagedEBSVolumeConfigurationProperty.Builder throughput(Number throughput)
  
  Sets the value of CfnService.ServiceManagedEBSVolumeConfigurationProperty.getThroughput()
  
  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:
  
  this
- volumeInitializationRate
  
  @Stability(Stable) public CfnService.ServiceManagedEBSVolumeConfigurationProperty.Builder volumeInitializationRate(Number volumeInitializationRate)
  
  Sets the value of CfnService.ServiceManagedEBSVolumeConfigurationProperty.getVolumeInitializationRate()
  
  Parameters:
  
  volumeInitializationRate - The rate, in MiB/s, at which data is fetched from a snapshot of an existing EBS volume to create new volumes for attachment to the tasks maintained by the service. This property can be specified only if you specify a snapshotId . For more information, see Initialize Amazon EBS volumes in the Amazon EBS User Guide .
  
  Returns:
  
  this
- volumeType
  
  @Stability(Stable) public CfnService.ServiceManagedEBSVolumeConfigurationProperty.Builder volumeType(String volumeType)
  
  Sets the value of CfnService.ServiceManagedEBSVolumeConfigurationProperty.getVolumeType()
  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:
  
  this
- build
  
  @Stability(Stable) public CfnService.ServiceManagedEBSVolumeConfigurationProperty build()
  
  Builds the configured instance.
  
  Specified by:
  
  build in interface software.amazon.jsii.Builder<CfnService.ServiceManagedEBSVolumeConfigurationProperty>
  
  Returns:
  
  a new instance of CfnService.ServiceManagedEBSVolumeConfigurationProperty
  
  Throws:
  
  NullPointerException - if any required attribute was not provided

Class CfnService.ServiceManagedEBSVolumeConfigurationProperty.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Details

Builder

Method Details

roleArn

encrypted

encrypted

filesystemType

iops

kmsKeyId

sizeInGiB

snapshotId

tagSpecifications

tagSpecifications

throughput

volumeInitializationRate

volumeType

build