@liflig/cdk
    Preparing search index...

    Interface FargateServiceProps

    interface FargateServiceProps {
        alarms: ServiceAlarmsConfig;
        cluster: ICluster;
        containerHealthCheck?: HealthCheck;
        containerPort?: number;
        cpu?: number;
        deregistrationDelay?: Duration;
        desiredCount: number;
        ecsImage: ContainerImage;
        enableCircuitBreaker?: boolean;
        environment?: Record<string, string>;
        healthCheckGracePeriod?: Duration;
        logDriverMode?: AwsLogDriverMode;
        logsRetention?: RetentionDays;
        memoryLimitMiB?: number;
        overrideContainerProps?: Partial<ContainerDefinitionOptions>;
        overrideFargateServiceProps?: Partial<FargateServiceProps>;
        overrideHealthCheck?: Partial<HealthCheck>;
        overrideTargetGroupProps?: Partial<ApplicationTargetGroupProps>;
        parameters?: Parameter[];
        portMappings?: PortMapping[];
        runtimePlatform?: RuntimePlatform;
        secrets?: Record<string, Secret>;
        serviceName: string;
        skipHealthCheckGracePeriod?: boolean;
        skipTargetGroup?: boolean;
        vpc: IVpc;
    }
    Index

    Properties

    alarms cluster containerHealthCheck? containerPort? cpu? deregistrationDelay? desiredCount ecsImage enableCircuitBreaker? environment? healthCheckGracePeriod? logDriverMode? logsRetention? memoryLimitMiB? overrideContainerProps? overrideFargateServiceProps? overrideHealthCheck? overrideTargetGroupProps? parameters? portMappings? runtimePlatform? secrets? serviceName skipHealthCheckGracePeriod? skipTargetGroup? vpc

    Properties

    alarms: ServiceAlarmsConfig

    Either

    • { enabled: false } to disable all alarms.
    • object with required alarmAction, warningAction, and loadBalancerFullName.

    When enabled, the construct will:

    • (By default) add a log-based JSON error alarm (enabled by default).
    • (By default) add target-group related alarms (target health, 5xx responses, response time) when a target group is present.
    • (Opt-in) optionally enable the uncaught Java exception alarm
    cluster: ICluster
    containerHealthCheck?: HealthCheck
    containerPort?: number
    8080
    cpu?: number
    256
    deregistrationDelay?: Duration
    15 seconds
    desiredCount: number
    ecsImage: ContainerImage
    enableCircuitBreaker?: boolean
    false
    environment?: Record<string, string>
    healthCheckGracePeriod?: Duration
    60 seconds
    logDriverMode?: AwsLogDriverMode
    AwsLogDriverMode.BLOCKING
    logsRetention?: RetentionDays
    2 weeks
    memoryLimitMiB?: number
    512
    overrideContainerProps?: Partial<ContainerDefinitionOptions>
    overrideFargateServiceProps?: Partial<FargateServiceProps>
    overrideHealthCheck?: Partial<HealthCheck>
    overrideTargetGroupProps?: Partial<ApplicationTargetGroupProps>
    parameters?: Parameter[]
    portMappings?: PortMapping[]
    runtimePlatform?: RuntimePlatform
    undefined
    secrets?: Record<string, Secret>
    serviceName: string
    skipHealthCheckGracePeriod?: boolean

    Use this as workaround when adding the service to a load balancer after it has been created. For avoiding 'Health check grace period is only valid for services configured to use load balancers' Link to GitHub issue: https://github.com/aws/aws-cdk/issues/19842

    skipTargetGroup?: boolean
    false
    vpc: IVpc

    Settings

    Member Visibility

    On This Page

    Properties