CfnApplicationStatusCheckProps
- class aws_cdk.aws_ec2.CfnApplicationStatusCheckProps(*, port, protocol, aggregation=None, device_index=None, failure_threshold=None, health_check_paths=None, initialization_grace_period_seconds=None, interval=None, ip_scope=None, ip_version=None, path=None, status_code_matcher=None, success_threshold=None, tags=None, timeout=None)
Bases:
objectProperties for defining a
CfnApplicationStatusCheck.- Parameters:
port (
Union[int,float]) – The port used for the health check.protocol (
str) – The network protocol used for the health check.aggregation (
Optional[str]) – Whether this check is included in the rolled-up application status.device_index (
Union[int,float,None]) – The network interface device index used for the health check.failure_threshold (
Union[int,float,None]) – The number of consecutive failed probes required to mark the instance unhealthy.health_check_paths (
Union[IResolvable,Sequence[Union[IResolvable,HealthCheckPathProperty,Dict[str,Any]]],None]) – The source/destination network paths used for the health check.initialization_grace_period_seconds (
Union[int,float,None]) – Seconds to wait after instance launch before beginning health checks.interval (
Union[int,float,None]) – The interval, in seconds, between health check probes.ip_scope (
Optional[str]) – The IP scope used for the health check.ip_version (
Optional[str]) – The IP version used for the health check.path (
Optional[str]) – The HTTP path used for the health check.status_code_matcher (
Optional[str]) – The HTTP status codes considered successful (e.g., “200-299”).success_threshold (
Union[int,float,None]) – The number of consecutive successful probes required to mark the instance healthy.tags (
Optional[Sequence[Union[CfnTag,Dict[str,Any]]]]) – Tags to apply to the application status check.timeout (
Union[int,float,None]) – The timeout, in seconds, for each health check probe.
- See:
- ExampleMetadata:
fixture=_generated
Example:
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 )
Attributes
- aggregation
Whether this check is included in the rolled-up application status.
- device_index
The network interface device index used for the health check.
- failure_threshold
The number of consecutive failed probes required to mark the instance unhealthy.
- health_check_paths
The source/destination network paths used for the health check.
- initialization_grace_period_seconds
Seconds to wait after instance launch before beginning health checks.
- interval
The interval, in seconds, between health check probes.
- ip_scope
The IP scope used for the health check.
- ip_version
The IP version used for the health check.
- path
The HTTP path used for the health check.
- port
The port used for the health check.
- protocol
The network protocol used for the health check.
- status_code_matcher
The HTTP status codes considered successful (e.g., “200-299”).
- success_threshold
The number of consecutive successful probes required to mark the instance healthy.
- tags
Tags to apply to the application status check.
- timeout
The timeout, in seconds, for each health check probe.