Package software.amazon.awscdk.services.ec2

Interface CfnApplicationStatusCheckProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnApplicationStatusCheckProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)",
           date="2026-09-10T17:51:43.421Z")
@Stability(Stable)
public interface CfnApplicationStatusCheckProps
extends software.amazon.jsii.JsiiSerializable

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 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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-applicationstatuscheck.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnApplicationStatusCheckProps.Builder	A builder for CfnApplicationStatusCheckProps
static final class	CfnApplicationStatusCheckProps.Jsii$Proxy	An implementation for CfnApplicationStatusCheckProps

Method Summary

Modifier and Type	Method	Description
static CfnApplicationStatusCheckProps.Builder	builder()
default String	getAggregation()	Whether this check is included in the rolled-up application status.
default Number	getDeviceIndex()	The network interface device index used for the health check.
default Number	getFailureThreshold()	The number of consecutive failed probes required to mark the instance unhealthy.
default Object	getHealthCheckPaths()	The source/destination network paths used for the health check.
default Number	getInitializationGracePeriodSeconds()	Seconds to wait after instance launch before beginning health checks.
default Number	getInterval()	The interval, in seconds, between health check probes.
default String	getIpScope()	The IP scope used for the health check.
default String	getIpVersion()	The IP version used for the health check.
default String	getPath()	The HTTP path used for the health check.
Number	getPort()	The port used for the health check.
String	getProtocol()	The network protocol used for the health check.
default String	getStatusCodeMatcher()	The HTTP status codes considered successful (e.g., "200-299").
default Number	getSuccessThreshold()	The number of consecutive successful probes required to mark the instance healthy.
default List<CfnTag>	getTags()	Tags to apply to the application status check.
default Number	getTimeout()	The timeout, in seconds, for each health check probe.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPort

@Stability(Stable)
@NotNull
Number getPort()

The port used for the health check.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-applicationstatuscheck.html#cfn-ec2-applicationstatuscheck-port

getProtocol

@Stability(Stable)
@NotNull
String getProtocol()

The network protocol used for the health check.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-applicationstatuscheck.html#cfn-ec2-applicationstatuscheck-protocol

getAggregation

@Stability(Stable)
@Nullable
default String getAggregation()

Whether this check is included in the rolled-up application status.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-applicationstatuscheck.html#cfn-ec2-applicationstatuscheck-aggregation

getDeviceIndex

@Stability(Stable)
@Nullable
default Number getDeviceIndex()

The network interface device index used for the health check.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-applicationstatuscheck.html#cfn-ec2-applicationstatuscheck-deviceindex

getFailureThreshold

@Stability(Stable)
@Nullable
default Number getFailureThreshold()

The number of consecutive failed probes required to mark the instance unhealthy.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-applicationstatuscheck.html#cfn-ec2-applicationstatuscheck-failurethreshold

getHealthCheckPaths

@Stability(Stable)
@Nullable
default Object getHealthCheckPaths()

The source/destination network paths used for the health check.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnApplicationStatusCheck.HealthCheckPathProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-applicationstatuscheck.html#cfn-ec2-applicationstatuscheck-healthcheckpaths

getInitializationGracePeriodSeconds

@Stability(Stable)
@Nullable
default Number getInitializationGracePeriodSeconds()

Seconds to wait after instance launch before beginning health checks.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-applicationstatuscheck.html#cfn-ec2-applicationstatuscheck-initializationgraceperiodseconds

getInterval

@Stability(Stable)
@Nullable
default Number getInterval()

The interval, in seconds, between health check probes.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-applicationstatuscheck.html#cfn-ec2-applicationstatuscheck-interval

getIpScope

@Stability(Stable)
@Nullable
default String getIpScope()

The IP scope used for the health check.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-applicationstatuscheck.html#cfn-ec2-applicationstatuscheck-ipscope

getIpVersion

@Stability(Stable)
@Nullable
default String getIpVersion()

The IP version used for the health check.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-applicationstatuscheck.html#cfn-ec2-applicationstatuscheck-ipversion

getPath

@Stability(Stable)
@Nullable
default String getPath()

The HTTP path used for the health check.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-applicationstatuscheck.html#cfn-ec2-applicationstatuscheck-path

getStatusCodeMatcher

@Stability(Stable)
@Nullable
default String getStatusCodeMatcher()

The HTTP status codes considered successful (e.g., "200-299").

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-applicationstatuscheck.html#cfn-ec2-applicationstatuscheck-statuscodematcher

getSuccessThreshold

@Stability(Stable)
@Nullable
default Number getSuccessThreshold()

The number of consecutive successful probes required to mark the instance healthy.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-applicationstatuscheck.html#cfn-ec2-applicationstatuscheck-successthreshold

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

Tags to apply to the application status check.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-applicationstatuscheck.html#cfn-ec2-applicationstatuscheck-tags

getTimeout

@Stability(Stable)
@Nullable
default Number getTimeout()

The timeout, in seconds, for each health check probe.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-applicationstatuscheck.html#cfn-ec2-applicationstatuscheck-timeout

builder

@Stability(Stable)
static CfnApplicationStatusCheckProps.Builder builder()

Returns:

a CfnApplicationStatusCheckProps.Builder of CfnApplicationStatusCheckProps