Skip to content

ApplicationStatusCheckResponseObject

Source code in docs_src/capo_ec2/types/application_status_check_response_object.py
class ApplicationStatusCheckResponseObject(TypedDict, closed=True):
    application_status_check_id: NotRequired[
        "capo_ec2.types.application_status_check_id.ApplicationStatusCheckId"
    ]
    """<p>The ID of the application status check.</p>"""
    aggregation: NotRequired[
        "capo_ec2.types.aggregation_status_enum.AggregationStatusEnum"
    ]
    """<p>The aggregation setting for the application status check. When set to <code>included</code>, the result of this check contributes to the instance-level application status. When set to <code>excluded</code>, the check runs independently and does not affect the instance-level status.</p>"""
    health_check_paths: NotRequired[
        "capo_ec2.types.health_check_path_response_list.HealthCheckPathResponseList"
    ]
    """<p>The health check paths for the application status check.</p>"""
    protocol: NotRequired["capo_ec2.types.network_protocol_enum.NetworkProtocolEnum"]
    """<p>The protocol used for the health check.</p>"""
    port: NotRequired["capo_ec2.types.integer.Integer"]
    """<p>The port used for the health check.</p>"""
    path: NotRequired["capo_ec2.types.string.String"]
    """<p>The URL path used for the health check HTTP request.</p>"""
    device_index: NotRequired["capo_ec2.types.integer.Integer"]
    """<p>The index of the network device used for the health check. The value is greater than or equal to 0.</p>"""
    ip_version: NotRequired["capo_ec2.types.ip_version_enum.IpVersionEnum"]
    """<p>The IP version used for the health check.</p>"""
    ip_scope: NotRequired["capo_ec2.types.ip_scope_enum.IpScopeEnum"]
    """<p>The IP scope used for the health check.</p>"""
    interval: NotRequired["capo_ec2.types.integer.Integer"]
    """<p>The interval, in seconds, between health checks. Valid value: 60.</p>"""
    timeout: NotRequired["capo_ec2.types.integer.Integer"]
    """<p>The amount of time, in seconds, to wait for a health check response. Valid values: 1 to 30.</p>"""
    failure_threshold: NotRequired["capo_ec2.types.integer.Integer"]
    """<p>The number of consecutive failed health checks before the application status is considered impaired. The value must be greater than 0.</p>"""
    success_threshold: NotRequired["capo_ec2.types.integer.Integer"]
    """<p>The number of consecutive successful health checks before the application status is considered healthy. The value must be greater than 0.</p>"""
    status_code_matcher: NotRequired["capo_ec2.types.string.String"]
    """<p>The comma-separated list of individual HTTP status codes or ranges that indicate a successful health check response.</p>"""
    initialization_grace_period_seconds: NotRequired[
        "capo_ec2.types.initialization_grace_period_seconds.InitializationGracePeriodSeconds"
    ]
    """<p>The number of seconds to wait before starting health checks after an instance is launched. Valid values: 1 to 600.</p>"""
    last_updated_at: NotRequired[
        "capo_ec2.types.millisecond_date_time.MillisecondDateTime"
    ]
    """<p>The date and time when the application status check was last updated.</p>"""
    target_tag_associations: NotRequired[
        "capo_ec2.types.custom_key_value_pair_response_set.CustomKeyValuePairResponseSet"
    ]
    """<p>The <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html">tags</a> associated with the application status check. Instances with these tags are automatically monitored by this check.</p>"""
    tags: NotRequired["capo_ec2.types.tag_list.TagList"]
    """<p>The tags assigned to the application status check.</p>"""
    creation_time: NotRequired[
        "capo_ec2.types.millisecond_date_time.MillisecondDateTime"
    ]
    """<p>The date and time when the application status check was created.</p>"""
    modify_time: NotRequired["capo_ec2.types.millisecond_date_time.MillisecondDateTime"]
    """<p>The date and time when the application status check was last modified.</p>"""
    deletion_time: NotRequired[
        "capo_ec2.types.millisecond_date_time.MillisecondDateTime"
    ]
    """<p>The date and time when the application status check was deleted.</p>"""

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. When set to excluded, the check runs independently and does not affect the instance-level status.

application_status_check_id instance-attribute

application_status_check_id: NotRequired[ApplicationStatusCheckId]

The ID of the application status check.

creation_time instance-attribute

creation_time: NotRequired[MillisecondDateTime]

The date and time when the application status check was created.

deletion_time instance-attribute

deletion_time: NotRequired[MillisecondDateTime]

The date and time when the application status check was deleted.

device_index instance-attribute

device_index: NotRequired[Integer]

The index of the network device used for the health check. The value is greater than or equal to 0.

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[HealthCheckPathResponseList]

The health check paths for the application status check.

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 used for the health check.

ip_version instance-attribute

ip_version: NotRequired[IpVersionEnum]

The IP version used for the health check.

last_updated_at instance-attribute

last_updated_at: NotRequired[MillisecondDateTime]

The date and time when the application status check was last updated.

modify_time instance-attribute

modify_time: NotRequired[MillisecondDateTime]

The date and time when the application status check was last modified.

path instance-attribute

path: NotRequired[String]

The URL path used for the health check HTTP request.

port instance-attribute

port: NotRequired[Integer]

The port used for the health check.

protocol instance-attribute

protocol: NotRequired[NetworkProtocolEnum]

The protocol used for the health check.

status_code_matcher instance-attribute

status_code_matcher: NotRequired[String]

The comma-separated list of individual HTTP status codes or ranges that indicate a successful health check response.

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.

tags instance-attribute

tags: NotRequired[TagList]

The tags assigned to the application status check.

target_tag_associations instance-attribute

target_tag_associations: NotRequired[CustomKeyValuePairResponseSet]

The tags associated with the application status check. Instances with these tags are automatically monitored by this check.

timeout instance-attribute

timeout: NotRequired[Integer]

The amount of time, in seconds, to wait for a health check response. Valid values: 1 to 30.