@zarpay/zar-cdk-lib - v0.32.0
    Preparing search index...

    Interface EcsFargateServiceProps

    Props for EcsFargateService construct.

    interface EcsFargateServiceProps {
        appName: string;
        autoScaling?: AutoScalingProps;
        blueGreen?: BlueGreenDeploymentProps;
        circuitBreaker?: DeploymentCircuitBreaker;
        cluster?: ICluster;
        command?: string[];
        containerPort?: number;
        cpu?: FargateCpuValue;
        deployEnvironment: string;
        desiredCount?: number;
        disableAutoScaling?: boolean;
        disableContainerHealthCheck?: boolean;
        enableExecuteCommand?: boolean;
        enableInitProcess?: boolean;
        entryPoint?: string[];
        environment?: Record<string, string>;
        executionRole?: IRole;
        healthCheck?: ContainerHealthCheckProps;
        healthCheckGracePeriod?: Duration;
        image: ContainerImage;
        imageVersion?: string;
        logging?: LogGroup | RetentionDays | LogDriver;
        maxHealthyPercent?: number;
        memoryLimitMiB?: number;
        minHealthyPercent?: number;
        policyStatements?: PolicyStatement[];
        secrets?: Record<string, Secret>;
        securityGroup?: SecurityGroup;
        serviceName?: string;
        subnetSelection?: SubnetSelection;
        taskDef?: IEcsFargateTask;
        taskRole?: IRole;
        validateProductionImageVersion?: boolean;
        vpc?: IVpc;
        vpcName?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    appName autoScaling? blueGreen? circuitBreaker? cluster? command? containerPort? cpu? deployEnvironment desiredCount? disableAutoScaling? disableContainerHealthCheck? enableExecuteCommand? enableInitProcess? entryPoint? environment? executionRole? healthCheck? healthCheckGracePeriod? image imageVersion? logging? maxHealthyPercent? memoryLimitMiB? minHealthyPercent? policyStatements? secrets? securityGroup? serviceName? subnetSelection? taskDef? taskRole? validateProductionImageVersion? vpc? vpcName?

    Properties

    appName: string

    Application name (e.g., 'ZarCore', 'ZarPayments'). Used for naming resources and tagging.

    autoScaling?: AutoScalingProps

    Auto-scaling configuration.

    - Scaling on 80% CPU/Memory
    blueGreen?: BlueGreenDeploymentProps

    Blue/Green deployment configuration.

    - Rolling deployment (no Blue/Green)
    circuitBreaker?: DeploymentCircuitBreaker

    Circuit breaker configuration.

    { enable: true, rollback: true }
    cluster?: ICluster

    Pre-existing ECS cluster.

    - Creates a new cluster for this service
    command?: string[]

    Custom command for the container.

    containerPort?: number

    Port the container listens on.

    80
    cpu?: FargateCpuValue

    CPU units for the task.

    1024 (1 vCPU)
    deployEnvironment: string

    Deployment environment (e.g., 'development', 'staging', 'production').

    desiredCount?: number

    Desired task count.

    disableAutoScaling?: boolean

    Disable auto-scaling.

    false
    disableContainerHealthCheck?: boolean

    Disable container health check. Useful when using ALB health checks instead.

    false
    enableExecuteCommand?: boolean

    Enable ECS Exec for debugging.

    true
    enableInitProcess?: boolean

    Enable init process (tini) for proper signal handling.

    true
    entryPoint?: string[]

    Custom entry point for the container.

    environment?: Record<string, string>

    Environment variables for the container.

    executionRole?: IRole

    Pre-existing execution role.

    - Creates new execution role
    healthCheck?: ContainerHealthCheckProps

    Container health check configuration.

    - Health check on /up endpoint
    healthCheckGracePeriod?: Duration

    Health check grace period.

    Duration.seconds(60)
    image: ContainerImage

    Container image to deploy.

    imageVersion?: string

    Image version/tag for validation. Required when validateProductionImageVersion is true in production. In production, this must be a semantic version (e.g., v1.2.3).

    logging?: LogGroup | RetentionDays | LogDriver

    Logging configuration for the ECS task.

    Can be one of:

    • ecs.LogDriver - Full control over logging configuration
    • logs.LogGroup - We create an AwsLogDriver with this LogGroup
    • logs.RetentionDays - We create an AwsLogDriver and LogGroup with specified retention
    - Creates AwsLogDriver with LogGroup using TWO_WEEKS retention

    // Use custom retention
    logging: logs.RetentionDays.ONE_MONTH,

    // Use existing log group
    logging: myLogGroup,

    // Full control with custom LogDriver
    logging: ecs.LogDrivers.awsLogs({
      logGroup: myLogGroup,
      streamPrefix: 'custom',
    }),
    maxHealthyPercent?: number

    Maximum healthy percent during deployment.

    200
    memoryLimitMiB?: number

    Memory in MiB for the task.

    2048 (2 GB)
    minHealthyPercent?: number

    Minimum healthy percent during deployment.

    50
    policyStatements?: PolicyStatement[]

    Additional IAM policy statements for task role.

    secrets?: Record<string, Secret>

    Secrets from Secrets Manager or SSM Parameter Store.

    securityGroup?: SecurityGroup

    Pre-existing security group for ECS tasks.

    - Creates new security group with HTTPS (443) egress
    serviceName?: string

    Service name suffix. Used for naming the ECS service.

    'svc'
    subnetSelection?: SubnetSelection

    Subnet selection for task placement.

    - Private subnets with egress
    taskDef?: IEcsFargateTask

    Pre-existing task definition (for composition). If provided, task definition props are ignored.

    - Creates new task definition
    taskRole?: IRole

    Pre-existing task role.

    - Creates new task role
    validateProductionImageVersion?: boolean

    Validate image version format in production.

    true
    vpc?: IVpc

    Pre-existing VPC to use.

    - Imports VPC from Platform.vpc() using vpcName
    vpcName?: string

    Name of VPC to import via SSM parameters.

    'ZarVpc'

    Settings

    Member Visibility

    On This Page

    Properties