Interface X8ServiceProps

Properties that are used for customize a service. You can add multiple services behind the load balancer using addService() method and passing these properties for customization.

Hierarchy

  • X8ServiceProps

Properties

x8ContainerPort?: number

Port at which container listens for requests

Default

80

x8EnableExecuteCommand?: boolean

Enable execute command for debugging container, not recommended for production

Default

false

x8FargateServiceProps?: FargateServiceProps

Fargate Service Props

x8FargateTaskDefinitionProps?: WaFargateTaskDefinitionProps

Additional WaFargateTaskDefinitionProps

x8HealthCheckPath?: string

Health check path e.g. /health

Default

The first entry in the x8PathPatterns e.g. /service-a

x8Image: ContainerImage

Container image used for the task definition

x8LogStreamPrefix?: string

Log stream prefix

Default

X8ServiceNameLogs

x8Logging?: LogDriver

Container logging

Default

AWSLogDriver

x8MaxAutoscalingCapacity?: number

Maximum capacity allocation for autoscaling

Default

10 tasks for production 2 tasks for non production environments

x8PathPattern: string

Service Path e.g /service-a or /service-b

x8ServiceName: string

Service name e.g. UserService, FileService etc.

x8ServicePriority: number

Priority of the service within the load balancer routing

x8TargetCPUUtilizationPercent?: number

CPU utilization percentage when autoscaling should trigger

Default Value

60 percent for production 80 for non production environments

x8TargetMemoryUtilizationPercent?: number

Memory utilization percentage when autoscaling should trigger

Default Value

60 percent for production 80 for non production environments

Generated using TypeDoc