interface IFargateService

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

Implements IDependable, IConstruct, IEnvironmentAware, IResource, IServiceRef, IService

Implemented by FargateService

Obtainable from FargateService.fromFargateServiceArn()

The interface for a service using the Fargate launch type on an ECS cluster.

Properties

Name	Type	Description
env	ResourceEnvironment	The environment this resource belongs to.
node	Node	The tree node.
serviceArn	string	The Amazon Resource Name (ARN) of the service.
serviceName	string	The name of the service.
serviceRef🔹	ServiceReference	A reference to a Service resource.
stack	Stack	The stack in which this resource is defined.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

---

node

Type: Node

The tree node.

---

serviceArn

Type: string

The Amazon Resource Name (ARN) of the service.

---

serviceName

Type: string

The name of the service.

---

serviceRef🔹

Type: ServiceReference

A reference to a Service resource.

---

stack

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
with(...mixins)	Applies one or more mixins to this construct.

---

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

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.