Skip to content
v2.274.0

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,
};

Properties ​

aggregationstringaggregationstraggregationStringAggregationstringAggregation*string#
Whether this check is included in the rolled-up application status.
deviceIndexnumberdevice_indexint | floatdeviceIndexNumberDeviceIndexdoubleDeviceIndex*float64#
The network interface device index used for the health check.
failureThresholdnumberfailure_thresholdint | floatfailureThresholdNumberFailureThresholddoubleFailureThreshold*float64#
The number of consecutive failed probes required to mark the instance unhealthy.
healthCheckPathsIResolvable | IResolvable | CfnApplicationStatusCheck.HealthCheckPathProperty[]health_check_pathstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, HealthCheckPathProperty]]]healthCheckPathsIResolvableHealthCheckPathsIResolvableHealthCheckPathsinterface{}#
The source/destination network paths used for the health check.
initializationGracePeriodSecondsnumberinitialization_grace_period_secondsint | floatinitializationGracePeriodSecondsNumberInitializationGracePeriodSecondsdoubleInitializationGracePeriodSeconds*float64#
Seconds to wait after instance launch before beginning health checks.
intervalnumberintervalint | floatintervalNumberIntervaldoubleInterval*float64#
The interval, in seconds, between health check probes.
ipScopestringip_scopestripScopeStringIpScopestringIpScope*string#
The IP scope used for the health check.
ipVersionstringip_versionstripVersionStringIpVersionstringIpVersion*string#
The IP version used for the health check.
pathstringpathstrpathStringPathstringPath*string#
The HTTP path used for the health check.
portnumberportint | floatportNumberPortdoublePort*float64required#
The port used for the health check.
protocolstringprotocolstrprotocolStringProtocolstringProtocol*stringrequired#
The network protocol used for the health check.
statusCodeMatcherstringstatus_code_matcherstrstatusCodeMatcherStringStatusCodeMatcherstringStatusCodeMatcher*string#
The HTTP status codes considered successful (e.g., "200-299").
successThresholdnumbersuccess_thresholdint | floatsuccessThresholdNumberSuccessThresholddoubleSuccessThreshold*float64#
The number of consecutive successful probes required to mark the instance healthy.
tagsCfnTag[]tagstyping.List[CfnTag]tagsList<CfnTag>TagsCfnTag[]Tags*[]CfnTag#
Tags to apply to the application status check.
timeoutnumbertimeoutint | floattimeoutNumberTimeoutdoubleTimeout*float64#
The timeout, in seconds, for each health check probe.