Package software.amazon.awscdk.services.ecs

Class CfnService.ServiceManagedEBSVolumeConfigurationProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.ecs.CfnService.ServiceManagedEBSVolumeConfigurationProperty.Jsii$Proxy

All Implemented Interfaces:

CfnService.ServiceManagedEBSVolumeConfigurationProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnService.ServiceManagedEBSVolumeConfigurationProperty

@Stability(Stable)
@Internal
public static final class CfnService.ServiceManagedEBSVolumeConfigurationProperty.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnService.ServiceManagedEBSVolumeConfigurationProperty

An implementation for CfnService.ServiceManagedEBSVolumeConfigurationProperty

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ecs.CfnService.ServiceManagedEBSVolumeConfigurationProperty

CfnService.ServiceManagedEBSVolumeConfigurationProperty.Builder, CfnService.ServiceManagedEBSVolumeConfigurationProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnService.ServiceManagedEBSVolumeConfigurationProperty.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnService.ServiceManagedEBSVolumeConfigurationProperty.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Object	getEncrypted()	Indicates whether the volume should be encrypted.
final String	getFilesystemType()	The filesystem type for the volume.
final Number	getIops()	The number of I/O operations per second (IOPS).
final String	getKmsKeyId()	The Amazon Resource Name (ARN) identifier of the AWS Key Management Service key to use for Amazon EBS encryption.
final String	getRoleArn()	The ARN of the IAM role to associate with this volume.
final Number	getSizeInGiB()	The size of the volume in GiB.
final String	getSnapshotId()	The snapshot that Amazon ECS uses to create volumes for attachment to tasks maintained by the service.
final Object	getTagSpecifications()	The tags to apply to the volume.
final Number	getThroughput()	The throughput to provision for a volume, in MiB/s, with a maximum of 1,000 MiB/s.
final Number	getVolumeInitializationRate()	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.
final String	getVolumeType()	The volume type.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnService.ServiceManagedEBSVolumeConfigurationProperty.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnService.ServiceManagedEBSVolumeConfigurationProperty.Builder.

Method Details

getRoleArn

public final String getRoleArn()

Description copied from interface: CfnService.ServiceManagedEBSVolumeConfigurationProperty

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

Specified by:

getRoleArn in interface CfnService.ServiceManagedEBSVolumeConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-servicemanagedebsvolumeconfiguration.html#cfn-ecs-service-servicemanagedebsvolumeconfiguration-rolearn

getEncrypted

public final Object getEncrypted()

Description copied from interface: CfnService.ServiceManagedEBSVolumeConfigurationProperty

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 union: either Boolean or IResolvable

Specified by:

getEncrypted in interface CfnService.ServiceManagedEBSVolumeConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-servicemanagedebsvolumeconfiguration.html#cfn-ecs-service-servicemanagedebsvolumeconfiguration-encrypted

getFilesystemType

public final String getFilesystemType()

Description copied from interface: CfnService.ServiceManagedEBSVolumeConfigurationProperty

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 .

Specified by:

getFilesystemType in interface CfnService.ServiceManagedEBSVolumeConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-servicemanagedebsvolumeconfiguration.html#cfn-ecs-service-servicemanagedebsvolumeconfiguration-filesystemtype

getIops

public final Number getIops()

Description copied from interface: CfnService.ServiceManagedEBSVolumeConfigurationProperty

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 .

Specified by:

getIops in interface CfnService.ServiceManagedEBSVolumeConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-servicemanagedebsvolumeconfiguration.html#cfn-ecs-service-servicemanagedebsvolumeconfiguration-iops

getKmsKeyId

public final String getKmsKeyId()

Description copied from interface: CfnService.ServiceManagedEBSVolumeConfigurationProperty

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.

Specified by:

getKmsKeyId in interface CfnService.ServiceManagedEBSVolumeConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-servicemanagedebsvolumeconfiguration.html#cfn-ecs-service-servicemanagedebsvolumeconfiguration-kmskeyid

getSizeInGiB

public final Number getSizeInGiB()

Description copied from interface: CfnService.ServiceManagedEBSVolumeConfigurationProperty

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

Specified by:

getSizeInGiB in interface CfnService.ServiceManagedEBSVolumeConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-servicemanagedebsvolumeconfiguration.html#cfn-ecs-service-servicemanagedebsvolumeconfiguration-sizeingib

getSnapshotId

public final String getSnapshotId()

Description copied from interface: CfnService.ServiceManagedEBSVolumeConfigurationProperty

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 .

Specified by:

getSnapshotId in interface CfnService.ServiceManagedEBSVolumeConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-servicemanagedebsvolumeconfiguration.html#cfn-ecs-service-servicemanagedebsvolumeconfiguration-snapshotid

getTagSpecifications

public final Object getTagSpecifications()

Description copied from interface: CfnService.ServiceManagedEBSVolumeConfigurationProperty

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 union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnService.EBSTagSpecificationProperty>

Specified by:

getTagSpecifications in interface CfnService.ServiceManagedEBSVolumeConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-servicemanagedebsvolumeconfiguration.html#cfn-ecs-service-servicemanagedebsvolumeconfiguration-tagspecifications

getThroughput

public final Number getThroughput()

Description copied from interface: CfnService.ServiceManagedEBSVolumeConfigurationProperty

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.

Specified by:

getThroughput in interface CfnService.ServiceManagedEBSVolumeConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-servicemanagedebsvolumeconfiguration.html#cfn-ecs-service-servicemanagedebsvolumeconfiguration-throughput

getVolumeInitializationRate

public final Number getVolumeInitializationRate()

Description copied from interface: CfnService.ServiceManagedEBSVolumeConfigurationProperty

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 .

Specified by:

getVolumeInitializationRate in interface CfnService.ServiceManagedEBSVolumeConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-servicemanagedebsvolumeconfiguration.html#cfn-ecs-service-servicemanagedebsvolumeconfiguration-volumeinitializationrate

getVolumeType

public final String getVolumeType()

Description copied from interface: CfnService.ServiceManagedEBSVolumeConfigurationProperty

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.

Specified by:

getVolumeType in interface CfnService.ServiceManagedEBSVolumeConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-servicemanagedebsvolumeconfiguration.html#cfn-ecs-service-servicemanagedebsvolumeconfiguration-volumetype

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object