Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(apprunner): add HealthCheckConfiguration property in Service #27029

Merged
merged 15 commits into from
Sep 27, 2023
50 changes: 50 additions & 0 deletions packages/@aws-cdk/aws-apprunner-alpha/lib/service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -848,6 +848,56 @@ export class GitHubConnection {
}
}

/**
* Describes the settings for the health check that AWS App Runner performs to monitor the health of a service.
*/
export interface HealthCheckConfiguration {
/**
* The number of consecutive checks that must succeed before App Runner decides that the service is healthy.
*
* @default - 1
*/
readonly healthyThreshold?: number;

/**
* The time interval, in seconds, between health checks.
* TODO: CDK Duration
*
* @default - 5
*/
readonly interval?: number;

/**
* The URL that health check requests are sent to.
*
* @default - "/"
*/
readonly path?: string;

/**
* The IP protocol that App Runner uses to perform health checks for your service.
* TODO: Enum
*
* @default - TCP
*/
readonly protocol?: string;

/**
* The time, in seconds, to wait for a health check response before deciding it failed.
* TODO: CDK Duration
*
* @default - 2
*/
readonly timeout?: number;

/**
* The number of consecutive checks that must fail before App Runner decides that the service is unhealthy.
*
* @default - 5
*/
readonly unhealthyThreshold?: number;
}

/**
* Attributes for the App Runner Service
*/
Expand Down
Loading