ec2/aws.sdk.kotlin.services.ec2.model/CreateApplicationStatusCheckRequest/Builder

Builder

Properties

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.

clientToken

var clientToken: String?

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.

deviceIndex

var deviceIndex: Int?

The index of the network device to use for the health check. The value must be greater than or equal to 0.

dryRun

var dryRun: 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.

failureThreshold

var failureThreshold: Int?

The number of consecutive failed health checks before the application status is considered impaired. The value must be greater than 0.

healthCheckPaths

var healthCheckPaths: List<HealthCheckPathRequestObject>?

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.

initializationGracePeriodSeconds

var initializationGracePeriodSeconds: Int?

The number of seconds to wait before starting health checks after an instance is launched. Valid values: 1 to 600.

interval

var interval: Int?

The interval, in seconds, between health checks. Valid value: 60.

ipScope

var ipScope: IpScopeEnum?

The IP scope to use for the health check. Valid value: private.

ipVersion

var ipVersion: IpVersionEnum?

The IP version to use for the health check. Valid values: ipv4 and ipv6.

path

var path: String?

The URL path to use for the health check HTTP request (for example, /health or /status).

port

var port: Int?

The port to use for the health check. Valid values: 1 to 65535.

protocol

var protocol: NetworkProtocolEnum?

The protocol to use for the health check. Valid values: http | https.

statusCodeMatcher

var statusCodeMatcher: 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.

successThreshold

var successThreshold: Int?

The number of consecutive successful health checks before the application status is considered healthy. The value must be greater than 0.

tagSpecifications

var tagSpecifications: List<TagSpecification>?

The tags to apply to the application status check.

timeout

var timeout: Int?

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.