class ServiceManagedVolume (construct)

Language	Type name
.NET	Amazon.CDK.AWS.ECS.ServiceManagedVolume
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsecs#ServiceManagedVolume
Java	software.amazon.awscdk.services.ecs.ServiceManagedVolume
Python	aws_cdk.aws_ecs.ServiceManagedVolume
TypeScript (source)	aws-cdk-lib » aws_ecs » ServiceManagedVolume

Implements IConstruct, IDependable

Represents a service-managed volume and always configured at launch.

Example

declare const cluster: ecs.Cluster;
const taskDefinition = new ecs.FargateTaskDefinition(this, 'TaskDef');

const container = taskDefinition.addContainer('web', {
  image: ecs.ContainerImage.fromRegistry('amazon/amazon-ecs-sample'),
  portMappings: [{
    containerPort: 80,
    protocol: ecs.Protocol.TCP,
  }],
});

const volume = new ecs.ServiceManagedVolume(this, 'EBSVolume', {
  name: 'ebs1',
  managedEBSVolume: {
    size: Size.gibibytes(15),
    volumeType: ec2.EbsDeviceVolumeType.GP3,
    fileSystemType: ecs.FileSystemType.XFS,
    tagSpecifications: [{
      tags: {
        purpose: 'production',
      },
      propagateTags: ecs.EbsPropagatedTagSource.SERVICE,
    }],
  },
});

volume.mountIn(container, {
  containerPath: '/var/lib',
  readOnly: false,
});

taskDefinition.addVolume(volume);

const service = new ecs.FargateService(this, 'FargateService', {
  cluster,
  taskDefinition,
  minHealthyPercent: 100,
});

service.addVolume(volume);

Initializer

new ServiceManagedVolume(scope: Construct, id: string, props: ServiceManagedVolumeProps)

Parameters

• scope Construct
• id string
• props ServiceManagedVolumeProps

Construct Props

Name	Type	Description
name	string	The name of the volume.
managedEBSVolume?	ServiceManagedEBSVolumeConfiguration	Configuration for an Amazon Elastic Block Store (EBS) volume managed by ECS.

---

name

Type: string

The name of the volume.

This corresponds to the name provided in the ECS TaskDefinition.

---

managedEBSVolume?

Type: ServiceManagedEBSVolumeConfiguration (optional, default: undefined)

Configuration for an Amazon Elastic Block Store (EBS) volume managed by ECS.

Properties

Name	Type	Description
configuredAtLaunch	boolean	configuredAtLaunch indicates volume at launch time, referenced by taskdefinition volume.
name	string	Name of the volume, referenced by taskdefintion and mount point.
node	Node	The tree node.
role	IRole	An IAM role that allows ECS to make calls to EBS APIs.
config?	ServiceManagedEBSVolumeConfiguration	Volume configuration.

---

configuredAtLaunch

Type: boolean

configuredAtLaunch indicates volume at launch time, referenced by taskdefinition volume.

---

name

Type: string

Name of the volume, referenced by taskdefintion and mount point.

---

node

Type: Node

The tree node.

---

role

Type: IRole

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

If not provided, a new role with appropriate permissions will be created by default.

---

config?

Type: ServiceManagedEBSVolumeConfiguration (optional)

Volume configuration.

Methods

Name	Description
mountIn(container, mountPoint)	Mounts the service managed volume to a specified container at a defined mount point.
toString()	Returns a string representation of this construct.
with(...mixins)	Applies one or more mixins to this construct.

---

mountIn(container, mountPoint)

public mountIn(container: ContainerDefinition, mountPoint: ContainerMountPoint): void

Parameters

• container ContainerDefinition — The container to mount the volume on.
• mountPoint ContainerMountPoint — The mounting point details within the container.

Mounts the service managed volume to a specified container at a defined mount point.

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

with(...mixins)

public with(...mixins: IMixin[]): IConstruct

Parameters

• mixins IMixin — The mixins to apply.

Returns

• IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.