Skip to content

ModifyApplicationStatusCheckRequest

Source code in docs_src/capo_ec2/types/modify_application_status_check_request.py
class ModifyApplicationStatusCheckRequest(TypedDict, closed=True):
    application_status_check_id: NotRequired[
        "capo_ec2.types.application_status_check_id.ApplicationStatusCheckId"
    ]
    """<p>The ID of the application status check to modify.</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 reported by <code>DescribeApplicationStatus</code>. When set to <code>excluded</code>, the check runs independently and does not affect the instance-level status. Valid values: <code>included</code> | <code>excluded</code>.</p>"""
    health_check_paths: NotRequired[
        "capo_ec2.types.health_check_path_request_list.HealthCheckPathRequestList"
    ]
    """<p>The health check paths to use for the application status check.</p>"""
    protocol: NotRequired["capo_ec2.types.network_protocol_enum.NetworkProtocolEnum"]
    """<p>The protocol to use for the health check. Valid values: <code>http</code> | <code>https</code>.</p>"""
    port: NotRequired["capo_ec2.types.port_number.PortNumber"]
    """<p>The port to use for the health check. Valid values: 1 to 65535.</p>"""
    path: NotRequired["capo_ec2.types.string.String"]
    """<p>The URL path to use for the health check HTTP request (for example, <code>/health</code> or <code>/status</code>).</p>"""
    device_index: NotRequired["capo_ec2.types.integer.Integer"]
    """<p>The index of the network device to use for the health check. The value must be greater than or equal to 0.</p>"""
    ip_version: NotRequired["capo_ec2.types.ip_version_enum.IpVersionEnum"]
    """<p>The IP version to use for the health check. Valid values: <code>ipv4</code> and <code>ipv6</code>.</p>"""
    ip_scope: NotRequired["capo_ec2.types.ip_scope_enum.IpScopeEnum"]
    """<p>The IP scope to use for the health check. Valid value: <code>private</code>.</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 before considering it failed. Valid values: 1 to 30. The value must be less than <code>Interval</code>.</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 HTTP status codes that indicate a successful health check response. Specify a comma-separated list of individual status codes or ranges, for example, <code>200,202,300-399</code>. For a range, the first value must be less than the second value. Maximum length: 64 characters.</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>"""
    client_token: NotRequired["capo_ec2.types.string.String"]
    """<p>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 <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.</p>"""
    dry_run: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</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 reported by DescribeApplicationStatus. When set to excluded, the check runs independently and does not affect the instance-level status. Valid values: included | excluded.

application_status_check_id instance-attribute

application_status_check_id: NotRequired[ApplicationStatusCheckId]

The ID of the application status check to modify.

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.

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.

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.

timeout instance-attribute

timeout: NotRequired[Integer]

The amount of time, in seconds, to wait for a health check response before considering it failed. Valid values: 1 to 30. The value must be less than Interval.