Package software.amazon.awscdk.services.ecs

Class ServiceManagedEBSVolumeConfiguration.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.ecs.ServiceManagedEBSVolumeConfiguration.Jsii$Proxy

All Implemented Interfaces:

ServiceManagedEBSVolumeConfiguration, software.amazon.jsii.JsiiSerializable

Enclosing interface:

ServiceManagedEBSVolumeConfiguration

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

An implementation for ServiceManagedEBSVolumeConfiguration

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

ServiceManagedEBSVolumeConfiguration.Builder, ServiceManagedEBSVolumeConfiguration.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(ServiceManagedEBSVolumeConfiguration.Builder builder)	Constructor that initializes the object based on literal property values passed by the ServiceManagedEBSVolumeConfiguration.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 Boolean	getEncrypted()	Indicates whether the volume should be encrypted.
final FileSystemType	getFileSystemType()	The Linux filesystem type for the volume.
final Number	getIops()	The number of I/O operations per second (IOPS).
final IKey	getKmsKeyId()	AWS Key Management Service key to use for Amazon EBS encryption.
final IRole	getRole()	An IAM role that allows ECS to make calls to EBS APIs on your behalf.
final Size	getSize()	The size of the volume in GiB.
final String	getSnapShotId()	The snapshot that Amazon ECS uses to create the volume.
final List<EBSTagSpecification>	getTagSpecifications()	Specifies the tags to apply to the volume and whether to propagate those tags 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 Size	getVolumeInitializationRate()	Specifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), at which to download the snapshot blocks from Amazon S3 to the volume.
final EbsDeviceVolumeType	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(ServiceManagedEBSVolumeConfiguration.Builder builder)

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

Method Details

getEncrypted

public final Boolean getEncrypted()

Description copied from interface: ServiceManagedEBSVolumeConfiguration

Indicates whether the volume should be encrypted.

Default: - Default Amazon EBS encryption.

Specified by:

getEncrypted in interface ServiceManagedEBSVolumeConfiguration

getFileSystemType

public final FileSystemType getFileSystemType()

Description copied from interface: ServiceManagedEBSVolumeConfiguration

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. The available filesystem types are ext3, ext4, and xfs.

Default: - FileSystemType.XFS

Specified by:

getFileSystemType in interface ServiceManagedEBSVolumeConfiguration

getIops

public final Number getIops()

Description copied from interface: ServiceManagedEBSVolumeConfiguration

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.

Default: - undefined

Specified by:

getIops in interface ServiceManagedEBSVolumeConfiguration

getKmsKeyId

public final IKey getKmsKeyId()

Description copied from interface: ServiceManagedEBSVolumeConfiguration

AWS Key Management Service key to use for Amazon EBS encryption.

Default: - When `encryption` is turned on and no `kmsKey` is specified, the default AWS managed key for Amazon EBS volumes is used.

Specified by:

getKmsKeyId in interface ServiceManagedEBSVolumeConfiguration

getRole

public final IRole getRole()

Description copied from interface: ServiceManagedEBSVolumeConfiguration

An IAM role that allows ECS to make calls to EBS APIs on your behalf.

This role is required to create and manage the Amazon EBS volume.

Default: - automatically generated role.

Specified by:

getRole in interface ServiceManagedEBSVolumeConfiguration

getSize

public final Size getSize()

Description copied from interface: ServiceManagedEBSVolumeConfiguration

The size of the volume in GiB.

You must specify either size or snapshotId. You can optionally specify a volume size greater than or equal to the snapshot size.

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

Default: - The snapshot size is used for the volume size if you specify `snapshotId`, otherwise this parameter is required.

Specified by:

getSize in interface ServiceManagedEBSVolumeConfiguration

getSnapShotId

public final String getSnapShotId()

Description copied from interface: ServiceManagedEBSVolumeConfiguration

The snapshot that Amazon ECS uses to create the volume.

You must specify either size or snapshotId.

Default: - No snapshot.

Specified by:

getSnapShotId in interface ServiceManagedEBSVolumeConfiguration

getTagSpecifications

public final List<EBSTagSpecification> getTagSpecifications()

Description copied from interface: ServiceManagedEBSVolumeConfiguration

Specifies the tags to apply to the volume and whether to propagate those tags to the volume.

Default: - No tags are specified.

Specified by:

getTagSpecifications in interface ServiceManagedEBSVolumeConfiguration

getThroughput

public final Number getThroughput()

Description copied from interface: ServiceManagedEBSVolumeConfiguration

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

This parameter is only supported for the gp3 volume type.

Default: - No throughput.

Specified by:

getThroughput in interface ServiceManagedEBSVolumeConfiguration

getVolumeInitializationRate

public final Size getVolumeInitializationRate()

Description copied from interface: ServiceManagedEBSVolumeConfiguration

Specifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), at which to download the snapshot blocks from Amazon S3 to the volume.

Valid range is between 100 and 300 MiB/s.

Default: undefined - The volume initialization rate is not set.

Specified by:

getVolumeInitializationRate in interface ServiceManagedEBSVolumeConfiguration

getVolumeType

public final EbsDeviceVolumeType getVolumeType()

Description copied from interface: ServiceManagedEBSVolumeConfiguration

The volume type.

Default: - ec2.EbsDeviceVolumeType.GP2

Specified by:

getVolumeType in interface ServiceManagedEBSVolumeConfiguration

$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