Package software.amazon.awscdk.services.ecs

Interface CfnService.ServiceVolumeConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnService.ServiceVolumeConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnService

@Stability(Stable)
public static interface CfnService.ServiceVolumeConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

The configuration for a volume specified in the task definition as a volume that is configured at launch time.

Currently, the only supported volume type is an Amazon EBS volume.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ecs.*;
 ServiceVolumeConfigurationProperty serviceVolumeConfigurationProperty = ServiceVolumeConfigurationProperty.builder()
         .name("name")
         // the properties below are optional
         .managedEbsVolume(ServiceManagedEBSVolumeConfigurationProperty.builder()
                 .roleArn("roleArn")
                 // the properties below are optional
                 .encrypted(false)
                 .filesystemType("filesystemType")
                 .iops(123)
                 .kmsKeyId("kmsKeyId")
                 .sizeInGiB(123)
                 .snapshotId("snapshotId")
                 .tagSpecifications(List.of(EBSTagSpecificationProperty.builder()
                         .resourceType("resourceType")
                         // the properties below are optional
                         .propagateTags("propagateTags")
                         .tags(List.of(CfnTag.builder()
                                 .key("key")
                                 .value("value")
                                 .build()))
                         .build()))
                 .throughput(123)
                 .volumeType("volumeType")
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-servicevolumeconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnService.ServiceVolumeConfigurationProperty.Builder	A builder for CfnService.ServiceVolumeConfigurationProperty
static final class	CfnService.ServiceVolumeConfigurationProperty.Jsii$Proxy	An implementation for CfnService.ServiceVolumeConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnService.ServiceVolumeConfigurationProperty.Builder	builder()
default Object	getManagedEbsVolume()	The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf.
String	getName()	The name of the volume.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The name of the volume.

This value must match the volume name from the Volume object in the task definition.

See Also:

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

getManagedEbsVolume

@Stability(Stable)
@Nullable
default Object getManagedEbsVolume()

The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf.

These settings are used to create each Amazon EBS volume, with one volume created for each task in the service. The Amazon EBS volumes are visible in your account in the Amazon EC2 console once they are created.

See Also:

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

builder

@Stability(Stable)
static CfnService.ServiceVolumeConfigurationProperty.Builder builder()

Returns:

a CfnService.ServiceVolumeConfigurationProperty.Builder of CfnService.ServiceVolumeConfigurationProperty