Interface FargateServiceProps

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

Properties

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

Properties

cluster

cluster: ICluster

OptionalcontainerPort

containerPort?: number

Default

8080

Optionalcpu

cpu?: number

Default

256

OptionalderegistrationDelay

deregistrationDelay?: Duration

Default

15 seconds

desiredCount

desiredCount: number

ecsImage

ecsImage: ContainerImage

OptionalenableCircuitBreaker

enableCircuitBreaker?: boolean

Default

false

Optionalenvironment

environment?: Record<string, string>

OptionalhealthCheckGracePeriod

healthCheckGracePeriod?: Duration

Default

60 seconds

OptionallogsRetention

logsRetention?: RetentionDays

Default

2 weeks

OptionalmemoryLimitMiB

memoryLimitMiB?: number

Default

512

OptionaloverrideContainerProps

overrideContainerProps?: Partial<ContainerDefinitionOptions>

OptionaloverrideFargateServiceProps

overrideFargateServiceProps?: Partial<FargateServiceProps>

OptionaloverrideHealthCheck

overrideHealthCheck?: Partial<HealthCheck>

OptionaloverrideTargetGroupProps

overrideTargetGroupProps?: Partial<ApplicationTargetGroupProps>

Optionalparameters

parameters?: Parameter[]

Optionalsecrets

secrets?: Record<string, Secret>

serviceName

serviceName: string

OptionalskipHealthCheckGracePeriod

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

OptionalskipTargetGroup

skipTargetGroup?: boolean

Default

false

vpc

vpc: IVpc

Settings

Member Visibility

On This Page

Properties