interface IBaseService

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

Implemented by Ec2Service, ExternalService, FargateService

Obtainable from BaseService.fromServiceArnWithCluster(), Ec2Service.fromEc2ServiceAttributes(), ExternalService.fromExternalServiceAttributes(), FargateService.fromFargateServiceAttributes()

The interface for BaseService.

Properties

Name	Type	Description
cluster	ICluster	The cluster that hosts the service.
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.
stack	Stack	The stack in which this resource is defined.

---

cluster

Type: ICluster

The cluster that hosts the service.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that 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.

---

stack

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.

---

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