CreateApplicationStatusCheckRequest
¶
Source code in docs_src/capo_ec2/types/create_application_status_check_request.py
aggregation
instance-attribute
¶
aggregation: NotRequired[AggregationStatusEnum]
The aggregation setting for the application status check. When set to included, the result of this check contributes to the instance-level application status reported by DescribeApplicationStatus. When set to excluded, the check runs independently and does not affect the instance-level status. Valid values: included | excluded.
client_token
instance-attribute
¶
client_token: NotRequired[String]
A unique, case-sensitive identifier that you provide to ensure that the operation completes no more than one time. If you retry a request with the same token, the service ignores the request but does not return an error. For more information, see Ensuring idempotency.
device_index
instance-attribute
¶
device_index: NotRequired[Integer]
The index of the network device to use for the health check. The value must be greater than or equal to 0.
dry_run
instance-attribute
¶
dry_run: NotRequired[Boolean]
Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
failure_threshold
instance-attribute
¶
failure_threshold: NotRequired[Integer]
The number of consecutive failed health checks before the application status is considered impaired. The value must be greater than 0.
health_check_paths
instance-attribute
¶
health_check_paths: NotRequired[HealthCheckPathRequestList]
The health check paths to use for the application status check. Health check paths define the network path from a source subnet to one or more destination subnets for cross-Availability Zone or Availability Zone to Local Zone health checking. If omitted, health checks are performed in the same subnet as the instance.
initialization_grace_period_seconds
instance-attribute
¶
initialization_grace_period_seconds: NotRequired[InitializationGracePeriodSeconds]
The number of seconds to wait before starting health checks after an instance is launched. Valid values: 1 to 600.
interval
instance-attribute
¶
interval: NotRequired[Integer]
The interval, in seconds, between health checks. Valid value: 60.
ip_scope
instance-attribute
¶
ip_scope: NotRequired[IpScopeEnum]
The IP scope to use for the health check. Valid value: private.
ip_version
instance-attribute
¶
ip_version: NotRequired[IpVersionEnum]
The IP version to use for the health check. Valid values: ipv4 and ipv6.
path
instance-attribute
¶
path: NotRequired[String]
The URL path to use for the health check HTTP request (for example, /health or /status).
port
instance-attribute
¶
port: NotRequired[PortNumber]
The port to use for the health check. Valid values: 1 to 65535.
protocol
instance-attribute
¶
protocol: NotRequired[NetworkProtocolEnum]
The protocol to use for the health check. Valid values: http | https.
status_code_matcher
instance-attribute
¶
status_code_matcher: NotRequired[String]
The HTTP status codes that indicate a successful health check response. Specify a comma-separated list of individual status codes or ranges, for example, 200,202,300-399. For a range, the first value must be less than the second value. Maximum length: 64 characters. Default: 200.
success_threshold
instance-attribute
¶
success_threshold: NotRequired[Integer]
The number of consecutive successful health checks before the application status is considered healthy. The value must be greater than 0.
tag_specifications
instance-attribute
¶
tag_specifications: NotRequired[TagSpecificationList]
The tags to apply to the application status check.