API.md

API Reference

Constructs

AlbFargateServices

Initializers

import { AlbFargateServices } from 'serverless-container-constructs'

new AlbFargateServices(scope: Construct, id: string, props: AlbFargateServicesProps)

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: serverless-container-constructs.AlbFargateServicesProps

---

Properties

externalAlb^Optional

public readonly externalAlb: ApplicationLoadBalancer;

• Type: aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationLoadBalancer

---

internalAlb^Optional

public readonly internalAlb: ApplicationLoadBalancer;

• Type: aws-cdk-lib.aws_elasticloadbalancingv2.ApplicationLoadBalancer

---

BaseFargateServices

Initializers

import { BaseFargateServices } from 'serverless-container-constructs'

new BaseFargateServices(scope: Construct, id: string, props: BaseFargateServicesProps)

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: serverless-container-constructs.BaseFargateServicesProps

---

Properties

service^Required

public readonly service: FargateService[];

• Type: aws-cdk-lib.aws_ecs.FargateService[]

The service(s) created from the task(s).

---

vpc^Required

public readonly vpc: IVpc;

• Type: aws-cdk-lib.aws_ec2.IVpc

---

Structs

AlbFargateServicesProps

Initializer

import { AlbFargateServicesProps } from 'serverless-container-constructs'

const albFargateServicesProps: AlbFargateServicesProps = { ... }

tasks^Required

public readonly tasks: FargateTaskProps[];

• Type: serverless-container-constructs.FargateTaskProps[]

---

enableExecuteCommand^Optional

public readonly enableExecuteCommand: boolean;

• Type: boolean
• Default: false

Whether to enable ECS Exec support.

https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-exec.html

---

route53Ops^Optional

public readonly route53Ops: Route53Options;

• Type: serverless-container-constructs.Route53Options

---

spot^Optional

public readonly spot: boolean;

• Type: boolean
• Default: false

create a FARGATE_SPOT only cluster.

---

vpc^Optional

public readonly vpc: IVpc;

• Type: aws-cdk-lib.aws_ec2.IVpc

---

vpcSubnets^Optional

public readonly vpcSubnets: SubnetSelection;

• Type: aws-cdk-lib.aws_ec2.SubnetSelection
• Default: { subnetType: ec2.SubnetType.PRIVATE, }

The subnets to associate with the service.

---

BaseFargateServicesProps

Initializer

import { BaseFargateServicesProps } from 'serverless-container-constructs'

const baseFargateServicesProps: BaseFargateServicesProps = { ... }

tasks^Required

public readonly tasks: FargateTaskProps[];

• Type: serverless-container-constructs.FargateTaskProps[]

---

enableExecuteCommand^Optional

public readonly enableExecuteCommand: boolean;

• Type: boolean
• Default: false

Whether to enable ECS Exec support.

https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-exec.html

---

route53Ops^Optional

public readonly route53Ops: Route53Options;

• Type: serverless-container-constructs.Route53Options

---

spot^Optional

public readonly spot: boolean;

• Type: boolean
• Default: false

create a FARGATE_SPOT only cluster.

---

vpc^Optional

public readonly vpc: IVpc;

• Type: aws-cdk-lib.aws_ec2.IVpc

---

vpcSubnets^Optional

public readonly vpcSubnets: SubnetSelection;

• Type: aws-cdk-lib.aws_ec2.SubnetSelection
• Default: { subnetType: ec2.SubnetType.PRIVATE, }

The subnets to associate with the service.

---

FargateTaskProps

Initializer

import { FargateTaskProps } from 'serverless-container-constructs'

const fargateTaskProps: FargateTaskProps = { ... }

listenerPort^Required

public readonly listenerPort: number;

• Type: number

---

task^Required

public readonly task: FargateTaskDefinition;

• Type: aws-cdk-lib.aws_ecs.FargateTaskDefinition

---

accessibility^Optional

public readonly accessibility: LoadBalancerAccessibility;

• Type: serverless-container-constructs.LoadBalancerAccessibility
• Default: both

Register the service to internal ELB, external ELB or both.

---

capacityProviderStrategy^Optional

public readonly capacityProviderStrategy: CapacityProviderStrategy[];

• Type: aws-cdk-lib.aws_ecs.CapacityProviderStrategy[]

---

desiredCount^Optional

public readonly desiredCount: number;

• Type: number
• Default: 1

desired number of tasks for the service.

---

scalingPolicy^Optional

public readonly scalingPolicy: ServiceScalingPolicy;

• Type: serverless-container-constructs.ServiceScalingPolicy
• Default: { maxCapacity: 10, targetCpuUtilization: 50, requestsPerTarget: 1000 }

service autoscaling policy.

---

Route53Options

Initializer

import { Route53Options } from 'serverless-container-constructs'

const route53Options: Route53Options = { ... }

externalElbRecordName^Optional

public readonly externalElbRecordName: string;

• Type: string
• Default: external

the external ELB record name.

---

internalElbRecordName^Optional

public readonly internalElbRecordName: string;

• Type: string
• Default: internal

the internal ELB record name.

---

zoneName^Optional

public readonly zoneName: string;

• Type: string
• Default: svc.local

private zone name.

---

ServiceScalingPolicy

Initializer

import { ServiceScalingPolicy } from 'serverless-container-constructs'

const serviceScalingPolicy: ServiceScalingPolicy = { ... }

maxCapacity^Optional

public readonly maxCapacity: number;

• Type: number
• Default: 10

max capacity for the service autoscaling.

---

requestPerTarget^Optional

public readonly requestPerTarget: number;

• Type: number
• Default: 1000

request per target.

---

targetCpuUtilization^Optional

public readonly targetCpuUtilization: number;

• Type: number
• Default: 50

target cpu utilization.

---

Enums

LoadBalancerAccessibility

The load balancer accessibility.

EXTERNAL_ONLY

register to external load balancer only.

---

INTERNAL_ONLY

register to internal load balancer only.

---