CfnApplicationStatusCheckProps Struct
Properties for defining a CfnApplicationStatusCheck.
Example
ts
// 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,
};
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ec2 as ec2
cfn_application_status_check_props = ec2.CfnApplicationStatusCheckProps(
port=123,
protocol="protocol",
# the properties below are optional
aggregation="aggregation",
device_index=123,
failure_threshold=123,
health_check_paths=[ec2.CfnApplicationStatusCheck.HealthCheckPathProperty(
destinations=[ec2.CfnApplicationStatusCheck.HealthCheckPathDestinationProperty(
security_group_id="securityGroupId",
subnet_id="subnetId"
)],
source=ec2.CfnApplicationStatusCheck.HealthCheckPathSourceProperty(
security_group_id="securityGroupId",
subnet_id="subnetId"
)
)],
initialization_grace_period_seconds=123,
interval=123,
ip_scope="ipScope",
ip_version="ipVersion",
path="path",
status_code_matcher="statusCodeMatcher",
success_threshold=123,
tags=[CfnTag(
key="key",
value="value"
)],
timeout=123
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.ec2.*;
CfnApplicationStatusCheckProps cfnApplicationStatusCheckProps = CfnApplicationStatusCheckProps.builder()
.port(123)
.protocol("protocol")
// the properties below are optional
.aggregation("aggregation")
.deviceIndex(123)
.failureThreshold(123)
.healthCheckPaths(List.of(HealthCheckPathProperty.builder()
.destinations(List.of(HealthCheckPathDestinationProperty.builder()
.securityGroupId("securityGroupId")
.subnetId("subnetId")
.build()))
.source(HealthCheckPathSourceProperty.builder()
.securityGroupId("securityGroupId")
.subnetId("subnetId")
.build())
.build()))
.initializationGracePeriodSeconds(123)
.interval(123)
.ipScope("ipScope")
.ipVersion("ipVersion")
.path("path")
.statusCodeMatcher("statusCodeMatcher")
.successThreshold(123)
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.timeout(123)
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.EC2;
var cfnApplicationStatusCheckProps = new CfnApplicationStatusCheckProps {
Port = 123,
Protocol = "protocol",
// the properties below are optional
Aggregation = "aggregation",
DeviceIndex = 123,
FailureThreshold = 123,
HealthCheckPaths = new [] { new HealthCheckPathProperty {
Destinations = new [] { new HealthCheckPathDestinationProperty {
SecurityGroupId = "securityGroupId",
SubnetId = "subnetId"
} },
Source = new HealthCheckPathSourceProperty {
SecurityGroupId = "securityGroupId",
SubnetId = "subnetId"
}
} },
InitializationGracePeriodSeconds = 123,
Interval = 123,
IpScope = "ipScope",
IpVersion = "ipVersion",
Path = "path",
StatusCodeMatcher = "statusCodeMatcher",
SuccessThreshold = 123,
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
Timeout = 123
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnApplicationStatusCheckProps := &CfnApplicationStatusCheckProps{
Port: jsii.Number(123),
Protocol: jsii.String("protocol"),
// the properties below are optional
Aggregation: jsii.String("aggregation"),
DeviceIndex: jsii.Number(123),
FailureThreshold: jsii.Number(123),
HealthCheckPaths: []interface{}{
&HealthCheckPathProperty{
Destinations: []interface{}{
&HealthCheckPathDestinationProperty{
SecurityGroupId: jsii.String("securityGroupId"),
SubnetId: jsii.String("subnetId"),
},
},
Source: &HealthCheckPathSourceProperty{
SecurityGroupId: jsii.String("securityGroupId"),
SubnetId: jsii.String("subnetId"),
},
},
},
InitializationGracePeriodSeconds: jsii.Number(123),
Interval: jsii.Number(123),
IpScope: jsii.String("ipScope"),
IpVersion: jsii.String("ipVersion"),
Path: jsii.String("path"),
StatusCodeMatcher: jsii.String("statusCodeMatcher"),
SuccessThreshold: jsii.Number(123),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
Timeout: jsii.Number(123),
}
Properties
aggregationoptionalstringaggregationoptionalstraggregationoptionalStringAggregationoptionalstringAggregationoptional*string#Whether this check is included in the rolled-up application status.
deviceIndexoptionalnumberdevice_indexoptionalint | floatdeviceIndexoptionalNumberDeviceIndexoptionaldoubleDeviceIndexoptional*float64#The network interface device index used for the health check.
failureThresholdoptionalnumberfailure_thresholdoptionalint | floatfailureThresholdoptionalNumberFailureThresholdoptionaldoubleFailureThresholdoptional*float64#The number of consecutive failed probes required to mark the instance unhealthy.
healthCheckPathsoptionalIResolvable | IResolvable | CfnApplicationStatusCheck.HealthCheckPathProperty[]health_check_pathsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, HealthCheckPathProperty]]]healthCheckPathsoptionalIResolvableHealthCheckPathsoptionalIResolvableHealthCheckPathsoptionalinterface{}#The source/destination network paths used for the health check.
initializationGracePeriodSecondsoptionalnumberinitialization_grace_period_secondsoptionalint | floatinitializationGracePeriodSecondsoptionalNumberInitializationGracePeriodSecondsoptionaldoubleInitializationGracePeriodSecondsoptional*float64#Seconds to wait after instance launch before beginning health checks.
intervaloptionalnumberintervaloptionalint | floatintervaloptionalNumberIntervaloptionaldoubleIntervaloptional*float64#The interval, in seconds, between health check probes.
ipScopeoptionalstringip_scopeoptionalstripScopeoptionalStringIpScopeoptionalstringIpScopeoptional*string#The IP scope used for the health check.
ipVersionoptionalstringip_versionoptionalstripVersionoptionalStringIpVersionoptionalstringIpVersionoptional*string#The IP version used for the health check.
The HTTP path used for the health check.
The port used for the health check.
The network protocol used for the health check.
statusCodeMatcheroptionalstringstatus_code_matcheroptionalstrstatusCodeMatcheroptionalStringStatusCodeMatcheroptionalstringStatusCodeMatcheroptional*string#The HTTP status codes considered successful (e.g., "200-299").
successThresholdoptionalnumbersuccess_thresholdoptionalint | floatsuccessThresholdoptionalNumberSuccessThresholdoptionaldoubleSuccessThresholdoptional*float64#The number of consecutive successful probes required to mark the instance healthy.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#Tags to apply to the application status check.
timeoutoptionalnumbertimeoutoptionalint | floattimeoutoptionalNumberTimeoutoptionaldoubleTimeoutoptional*float64#The timeout, in seconds, for each health check probe.