One Observability Workshop v3.0.0

One Observability Workshop / constructs/ecs-service / EcsServiceProperties

Interface: EcsServiceProperties¶

Defined in: constructs/ecs-service.ts:64

Properties for configuring an ECS-hosted microservice.

Extends MicroserviceProperties with ECS-specific settings for task sizing, observability sidecars, and log routing.

Extends¶

• MicroserviceProperties

Extended by¶

• PayForAdoptionServiceProperties
• PetSearchServiceProperties
• PetFoodProperties
• ListAdoptionsServiceProperties

Properties¶

cpu¶

cpu: number

Defined in: constructs/ecs-service.ts:66

CPU units for the task (256, 512, 1024, 2048, 4096)

memoryLimitMiB¶

memoryLimitMiB: number

Defined in: constructs/ecs-service.ts:68

Memory limit in MiB for the task

desiredTaskCount¶

desiredTaskCount: number

Defined in: constructs/ecs-service.ts:70

Number of desired task instances

cloudMapNamespace?¶

optional cloudMapNamespace: IPrivateDnsNamespace

Defined in: constructs/ecs-service.ts:72

Cloud Map namespace for service discovery registration

openSearchCollection?¶

optional openSearchCollection: OpenSearchCollection | { collectionArn: string; collectionEndpoint: string; }

Defined in: constructs/ecs-service.ts:74

OpenSearch Serverless collection for direct log ingestion

openSearchPipeline?¶

optional openSearchPipeline: OpenSearchPipeline | { pipelineEndpoint: string; pipelineArn?: string; pipelineRoleArn?: string; }

Defined in: constructs/ecs-service.ts:85

OpenSearch ingestion pipeline for log routing When provided, logs will be sent to the pipeline instead of directly to OpenSearch Mutually exclusive with openSearchCollection

additionalEnvironment?¶

optional additionalEnvironment: object

Defined in: constructs/ecs-service.ts:93

Extra environment variables merged into the application container

Index Signature¶

[key: string]: string

enableCloudWatchAgent?¶

optional enableCloudWatchAgent: boolean

Defined in: constructs/ecs-service.ts:98

Enable CloudWatch agent sidecar for application signals and OTLP traces When enabled, adds a CloudWatch agent container that listens on port 4317

cloudWatchAgentTraceMode?¶

optional cloudWatchAgentTraceMode: CloudWatchAgentTraceMode

Defined in: constructs/ecs-service.ts:103

CloudWatch agent trace collection mode

Default¶

CloudWatchAgentTraceMode.APPLICATION_SIGNALS

hostType¶

hostType: HostType

Defined in: constructs/microservice.ts:53

Where the service runs: ECS, EKS, or None (AgentCore)

Inherited from¶

MicroserviceProperties.hostType

computeType¶

computeType: ComputeType

Defined in: constructs/microservice.ts:55

Compute backing: Fargate or EC2

Inherited from¶

MicroserviceProperties.computeType

tags?¶

optional tags: object

Defined in: constructs/microservice.ts:57

Resource tags applied to all child constructs

Index Signature¶

[key: string]: string

Inherited from¶

MicroserviceProperties.tags

securityGroup?¶

optional securityGroup: ISecurityGroup

Defined in: constructs/microservice.ts:59

Security group for the service's network interface

Inherited from¶

MicroserviceProperties.securityGroup

vpc?¶

optional vpc: IVpc

Defined in: constructs/microservice.ts:61

VPC for network placement

Inherited from¶

MicroserviceProperties.vpc

eksCluster?¶

optional eksCluster: ICluster

Defined in: constructs/microservice.ts:63

EKS cluster (required when hostType is EKS)

Inherited from¶

MicroserviceProperties.eksCluster

ecsCluster?¶

optional ecsCluster: ICluster

Defined in: constructs/microservice.ts:65

ECS cluster (required when hostType is ECS)

Inherited from¶

MicroserviceProperties.ecsCluster

logRetentionDays?¶

optional logRetentionDays: RetentionDays

Defined in: constructs/microservice.ts:67

Default Log Retention

Inherited from¶

MicroserviceProperties.logRetentionDays

name¶

name: string

Defined in: constructs/microservice.ts:69

Service name used for resource naming and identification

Inherited from¶

MicroserviceProperties.name

repositoryURI¶

repositoryURI: string

Defined in: constructs/microservice.ts:71

ECR repository URI for the container image

Inherited from¶

MicroserviceProperties.repositoryURI

disableService?¶

optional disableService: boolean

Defined in: constructs/microservice.ts:73

Skip creating the runtime service (container build only)

Inherited from¶

MicroserviceProperties.disableService

healthCheck?¶

optional healthCheck: string

Defined in: constructs/microservice.ts:75

Health check path for the load balancer target group

Inherited from¶

MicroserviceProperties.healthCheck

subnetType?¶

optional subnetType: SubnetType

Defined in: constructs/microservice.ts:77

Subnet type for task placement

Inherited from¶

MicroserviceProperties.subnetType

listenerPort?¶

optional listenerPort: number

Defined in: constructs/microservice.ts:79

ALB listener port (default: 80)

Inherited from¶

MicroserviceProperties.listenerPort

containerPort?¶

optional containerPort: number

Defined in: constructs/microservice.ts:81

Container port the application listens on

Inherited from¶

MicroserviceProperties.containerPort

createLoadBalancer?¶

optional createLoadBalancer: boolean

Defined in: constructs/microservice.ts:83

Whether to create an ALB for this service

Inherited from¶

MicroserviceProperties.createLoadBalancer

enableSLO?¶

optional enableSLO: boolean

Defined in: constructs/microservice.ts:85

Whether to create Application Signals SLOs

Inherited from¶

MicroserviceProperties.enableSLO