One Observability Workshop / constructs/microservice / MicroserviceProperties

Interface: MicroserviceProperties¶

Defined in: constructs/microservice.ts:51

Common properties shared by all microservice constructs (ECS, EKS, and AgentCore).

Extended by¶

Properties¶

hostType¶

hostType: HostType

Defined in: constructs/microservice.ts:53

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

computeType¶

computeType: ComputeType

Defined in: constructs/microservice.ts:55

Compute backing: Fargate or EC2

tags?¶

optional tags: object

Defined in: constructs/microservice.ts:57

Resource tags applied to all child constructs

Index Signature¶

[key: string]: string

securityGroup?¶

optional securityGroup: ISecurityGroup

Defined in: constructs/microservice.ts:59

Security group for the service's network interface

vpc?¶

optional vpc: IVpc

Defined in: constructs/microservice.ts:61

VPC for network placement

eksCluster?¶

optional eksCluster: ICluster

Defined in: constructs/microservice.ts:63

EKS cluster (required when hostType is EKS)

ecsCluster?¶

optional ecsCluster: ICluster

Defined in: constructs/microservice.ts:65

ECS cluster (required when hostType is ECS)

logRetentionDays?¶

optional logRetentionDays: RetentionDays

Defined in: constructs/microservice.ts:67

Default Log Retention

name¶

name: string

Defined in: constructs/microservice.ts:69

Service name used for resource naming and identification

repositoryURI¶

repositoryURI: string

Defined in: constructs/microservice.ts:71

ECR repository URI for the container image

disableService?¶

optional disableService: boolean

Defined in: constructs/microservice.ts:73

Skip creating the runtime service (container build only)

healthCheck?¶

optional healthCheck: string

Defined in: constructs/microservice.ts:75

Health check path for the load balancer target group

subnetType?¶

optional subnetType: SubnetType

Defined in: constructs/microservice.ts:77

Subnet type for task placement

listenerPort?¶

optional listenerPort: number

Defined in: constructs/microservice.ts:79

ALB listener port (default: 80)

containerPort?¶

optional containerPort: number

Defined in: constructs/microservice.ts:81

Container port the application listens on

createLoadBalancer?¶

optional createLoadBalancer: boolean

Defined in: constructs/microservice.ts:83

Whether to create an ALB for this service

enableSLO?¶

optional enableSLO: boolean

Defined in: constructs/microservice.ts:85

Whether to create Application Signals SLOs