interface CfnApplicationStatusCheckProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.EC2.CfnApplicationStatusCheckProps |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awsec2#CfnApplicationStatusCheckProps |
 Java | software.amazon.awscdk.services.ec2.CfnApplicationStatusCheckProps |
 Python | aws_cdk.aws_ec2.CfnApplicationStatusCheckProps |
 TypeScript | aws-cdk-lib » aws_ec2 » CfnApplicationStatusCheckProps |
Properties for defining a CfnApplicationStatusCheck.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
const cfnApplicationStatusCheckProps: ec2.CfnApplicationStatusCheckProps = {
port: 123,
protocol: 'protocol',
// the properties below are optional
aggregation: 'aggregation',
deviceIndex: 123,
failureThreshold: 123,
healthCheckPaths: [{
destinations: [{
securityGroupId: 'securityGroupId',
subnetId: 'subnetId',
}],
source: {
securityGroupId: 'securityGroupId',
subnetId: 'subnetId',
},
}],
initializationGracePeriodSeconds: 123,
interval: 123,
ipScope: 'ipScope',
ipVersion: 'ipVersion',
path: 'path',
statusCodeMatcher: 'statusCodeMatcher',
successThreshold: 123,
tags: [{
key: 'key',
value: 'value',
}],
timeout: 123,
};
Properties
| Name | Type | Description |
|---|---|---|
| port | number | The port used for the health check. |
| protocol | string | The network protocol used for the health check. |
| aggregation? | string | Whether this check is included in the rolled-up application status. |
| device | number | The network interface device index used for the health check. |
| failure | number | The number of consecutive failed probes required to mark the instance unhealthy. |
| health | IResolvable | (IResolvable | Health)[] | The source/destination network paths used for the health check. |
| initialization | number | Seconds to wait after instance launch before beginning health checks. |
| interval? | number | The interval, in seconds, between health check probes. |
| ip | string | The IP scope used for the health check. |
| ip | string | The IP version used for the health check. |
| path? | string | The HTTP path used for the health check. |
| status | string | The HTTP status codes considered successful (e.g., "200-299"). |
| success | number | The number of consecutive successful probes required to mark the instance healthy. |
| tags? | Cfn[] | Tags to apply to the application status check. |
| timeout? | number | The timeout, in seconds, for each health check probe. |
port
Type:
number
The port used for the health check.
protocol
Type:
string
The network protocol used for the health check.
aggregation?
Type:
string
(optional)
Whether this check is included in the rolled-up application status.
deviceIndex?
Type:
number
(optional)
The network interface device index used for the health check.
failureThreshold?
Type:
number
(optional)
The number of consecutive failed probes required to mark the instance unhealthy.
healthCheckPaths?
Type:
IResolvable | (IResolvable | Health)[]
(optional)
The source/destination network paths used for the health check.
initializationGracePeriodSeconds?
Type:
number
(optional)
Seconds to wait after instance launch before beginning health checks.
interval?
Type:
number
(optional)
The interval, in seconds, between health check probes.
ipScope?
Type:
string
(optional)
The IP scope used for the health check.
ipVersion?
Type:
string
(optional)
The IP version used for the health check.
path?
Type:
string
(optional)
The HTTP path used for the health check.
statusCodeMatcher?
Type:
string
(optional)
The HTTP status codes considered successful (e.g., "200-299").
successThreshold?
Type:
number
(optional)
The number of consecutive successful probes required to mark the instance healthy.
tags?
Type:
Cfn[]
(optional)
Tags to apply to the application status check.
timeout?
Type:
number
(optional)
The timeout, in seconds, for each health check probe.