Class: Aws::EC2::Types::ApplicationStatusCheckResponseObject

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::ApplicationStatusCheckResponseObject

Defined in:

gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Describes an application status check.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #aggregation ⇒ String

  The aggregation setting for the application status check.

• #application_status_check_id ⇒ String

  The ID of the application status check.

• #creation_time ⇒ Time

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

• #deletion_time ⇒ Time

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

• #device_index ⇒ Integer

  The index of the network device used for the health check.

• #failure_threshold ⇒ Integer

  The number of consecutive failed health checks before the application status is considered impaired.

• #health_check_paths ⇒ Array<Types::HealthCheckPathResponseObject>

  The health check paths for the application status check.

• #initialization_grace_period_seconds ⇒ Integer

  The number of seconds to wait before starting health checks after an instance is launched.

• #interval ⇒ Integer

  The interval, in seconds, between health checks.

• #ip_scope ⇒ String

  The IP scope used for the health check.

• #ip_version ⇒ String

  The IP version used for the health check.

• #last_updated_at ⇒ Time

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

• #modify_time ⇒ Time

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

• #path ⇒ String

  The URL path used for the health check HTTP request.

• #port ⇒ Integer

  The port used for the health check.

• #protocol ⇒ String

  The protocol used for the health check.

• #status_code_matcher ⇒ String

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

• #success_threshold ⇒ Integer

  The number of consecutive successful health checks before the application status is considered healthy.

• #tags ⇒ Array<Types::Tag>

  The tags assigned to the application status check.

• #target_tag_associations ⇒ Array<Types::CustomTagKeyValueResponsePair>

  The [tags][1] associated with the application status check.

• #timeout ⇒ Integer

  The amount of time, in seconds, to wait for a health check response.

Instance Attribute Details

#aggregation ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 2082

class ApplicationStatusCheckResponseObject < Struct.new(
  :application_status_check_id,
  :aggregation,
  :health_check_paths,
  :protocol,
  :port,
  :path,
  :device_index,
  :ip_version,
  :ip_scope,
  :interval,
  :timeout,
  :failure_threshold,
  :success_threshold,
  :status_code_matcher,
  :initialization_grace_period_seconds,
  :last_updated_at,
  :target_tag_associations,
  :tags,
  :creation_time,
  :modify_time,
  :deletion_time)
  SENSITIVE = []
  include Aws::Structure
end

#application_status_check_id ⇒ String

The ID of the application status check.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 2082

class ApplicationStatusCheckResponseObject < Struct.new(
  :application_status_check_id,
  :aggregation,
  :health_check_paths,
  :protocol,
  :port,
  :path,
  :device_index,
  :ip_version,
  :ip_scope,
  :interval,
  :timeout,
  :failure_threshold,
  :success_threshold,
  :status_code_matcher,
  :initialization_grace_period_seconds,
  :last_updated_at,
  :target_tag_associations,
  :tags,
  :creation_time,
  :modify_time,
  :deletion_time)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time ⇒ Time

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

Returns:

• (Time)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 2082

class ApplicationStatusCheckResponseObject < Struct.new(
  :application_status_check_id,
  :aggregation,
  :health_check_paths,
  :protocol,
  :port,
  :path,
  :device_index,
  :ip_version,
  :ip_scope,
  :interval,
  :timeout,
  :failure_threshold,
  :success_threshold,
  :status_code_matcher,
  :initialization_grace_period_seconds,
  :last_updated_at,
  :target_tag_associations,
  :tags,
  :creation_time,
  :modify_time,
  :deletion_time)
  SENSITIVE = []
  include Aws::Structure
end

#deletion_time ⇒ Time

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

Returns:

• (Time)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 2082

class ApplicationStatusCheckResponseObject < Struct.new(
  :application_status_check_id,
  :aggregation,
  :health_check_paths,
  :protocol,
  :port,
  :path,
  :device_index,
  :ip_version,
  :ip_scope,
  :interval,
  :timeout,
  :failure_threshold,
  :success_threshold,
  :status_code_matcher,
  :initialization_grace_period_seconds,
  :last_updated_at,
  :target_tag_associations,
  :tags,
  :creation_time,
  :modify_time,
  :deletion_time)
  SENSITIVE = []
  include Aws::Structure
end

#device_index ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 2082

class ApplicationStatusCheckResponseObject < Struct.new(
  :application_status_check_id,
  :aggregation,
  :health_check_paths,
  :protocol,
  :port,
  :path,
  :device_index,
  :ip_version,
  :ip_scope,
  :interval,
  :timeout,
  :failure_threshold,
  :success_threshold,
  :status_code_matcher,
  :initialization_grace_period_seconds,
  :last_updated_at,
  :target_tag_associations,
  :tags,
  :creation_time,
  :modify_time,
  :deletion_time)
  SENSITIVE = []
  include Aws::Structure
end

#failure_threshold ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 2082

class ApplicationStatusCheckResponseObject < Struct.new(
  :application_status_check_id,
  :aggregation,
  :health_check_paths,
  :protocol,
  :port,
  :path,
  :device_index,
  :ip_version,
  :ip_scope,
  :interval,
  :timeout,
  :failure_threshold,
  :success_threshold,
  :status_code_matcher,
  :initialization_grace_period_seconds,
  :last_updated_at,
  :target_tag_associations,
  :tags,
  :creation_time,
  :modify_time,
  :deletion_time)
  SENSITIVE = []
  include Aws::Structure
end

#health_check_paths ⇒ Array<Types::HealthCheckPathResponseObject>

The health check paths for the application status check.

Returns:

• (Array<Types::HealthCheckPathResponseObject>)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 2082

class ApplicationStatusCheckResponseObject < Struct.new(
  :application_status_check_id,
  :aggregation,
  :health_check_paths,
  :protocol,
  :port,
  :path,
  :device_index,
  :ip_version,
  :ip_scope,
  :interval,
  :timeout,
  :failure_threshold,
  :success_threshold,
  :status_code_matcher,
  :initialization_grace_period_seconds,
  :last_updated_at,
  :target_tag_associations,
  :tags,
  :creation_time,
  :modify_time,
  :deletion_time)
  SENSITIVE = []
  include Aws::Structure
end

#initialization_grace_period_seconds ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 2082

class ApplicationStatusCheckResponseObject < Struct.new(
  :application_status_check_id,
  :aggregation,
  :health_check_paths,
  :protocol,
  :port,
  :path,
  :device_index,
  :ip_version,
  :ip_scope,
  :interval,
  :timeout,
  :failure_threshold,
  :success_threshold,
  :status_code_matcher,
  :initialization_grace_period_seconds,
  :last_updated_at,
  :target_tag_associations,
  :tags,
  :creation_time,
  :modify_time,
  :deletion_time)
  SENSITIVE = []
  include Aws::Structure
end

#interval ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 2082

class ApplicationStatusCheckResponseObject < Struct.new(
  :application_status_check_id,
  :aggregation,
  :health_check_paths,
  :protocol,
  :port,
  :path,
  :device_index,
  :ip_version,
  :ip_scope,
  :interval,
  :timeout,
  :failure_threshold,
  :success_threshold,
  :status_code_matcher,
  :initialization_grace_period_seconds,
  :last_updated_at,
  :target_tag_associations,
  :tags,
  :creation_time,
  :modify_time,
  :deletion_time)
  SENSITIVE = []
  include Aws::Structure
end

#ip_scope ⇒ String

The IP scope used for the health check.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 2082

class ApplicationStatusCheckResponseObject < Struct.new(
  :application_status_check_id,
  :aggregation,
  :health_check_paths,
  :protocol,
  :port,
  :path,
  :device_index,
  :ip_version,
  :ip_scope,
  :interval,
  :timeout,
  :failure_threshold,
  :success_threshold,
  :status_code_matcher,
  :initialization_grace_period_seconds,
  :last_updated_at,
  :target_tag_associations,
  :tags,
  :creation_time,
  :modify_time,
  :deletion_time)
  SENSITIVE = []
  include Aws::Structure
end

#ip_version ⇒ String

The IP version used for the health check.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 2082

class ApplicationStatusCheckResponseObject < Struct.new(
  :application_status_check_id,
  :aggregation,
  :health_check_paths,
  :protocol,
  :port,
  :path,
  :device_index,
  :ip_version,
  :ip_scope,
  :interval,
  :timeout,
  :failure_threshold,
  :success_threshold,
  :status_code_matcher,
  :initialization_grace_period_seconds,
  :last_updated_at,
  :target_tag_associations,
  :tags,
  :creation_time,
  :modify_time,
  :deletion_time)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_at ⇒ Time

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

Returns:

• (Time)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 2082

class ApplicationStatusCheckResponseObject < Struct.new(
  :application_status_check_id,
  :aggregation,
  :health_check_paths,
  :protocol,
  :port,
  :path,
  :device_index,
  :ip_version,
  :ip_scope,
  :interval,
  :timeout,
  :failure_threshold,
  :success_threshold,
  :status_code_matcher,
  :initialization_grace_period_seconds,
  :last_updated_at,
  :target_tag_associations,
  :tags,
  :creation_time,
  :modify_time,
  :deletion_time)
  SENSITIVE = []
  include Aws::Structure
end

#modify_time ⇒ Time

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

Returns:

• (Time)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 2082

class ApplicationStatusCheckResponseObject < Struct.new(
  :application_status_check_id,
  :aggregation,
  :health_check_paths,
  :protocol,
  :port,
  :path,
  :device_index,
  :ip_version,
  :ip_scope,
  :interval,
  :timeout,
  :failure_threshold,
  :success_threshold,
  :status_code_matcher,
  :initialization_grace_period_seconds,
  :last_updated_at,
  :target_tag_associations,
  :tags,
  :creation_time,
  :modify_time,
  :deletion_time)
  SENSITIVE = []
  include Aws::Structure
end

#path ⇒ String

The URL path used for the health check HTTP request.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 2082

class ApplicationStatusCheckResponseObject < Struct.new(
  :application_status_check_id,
  :aggregation,
  :health_check_paths,
  :protocol,
  :port,
  :path,
  :device_index,
  :ip_version,
  :ip_scope,
  :interval,
  :timeout,
  :failure_threshold,
  :success_threshold,
  :status_code_matcher,
  :initialization_grace_period_seconds,
  :last_updated_at,
  :target_tag_associations,
  :tags,
  :creation_time,
  :modify_time,
  :deletion_time)
  SENSITIVE = []
  include Aws::Structure
end

#port ⇒ Integer

The port used for the health check.

Returns:

• (Integer)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 2082

class ApplicationStatusCheckResponseObject < Struct.new(
  :application_status_check_id,
  :aggregation,
  :health_check_paths,
  :protocol,
  :port,
  :path,
  :device_index,
  :ip_version,
  :ip_scope,
  :interval,
  :timeout,
  :failure_threshold,
  :success_threshold,
  :status_code_matcher,
  :initialization_grace_period_seconds,
  :last_updated_at,
  :target_tag_associations,
  :tags,
  :creation_time,
  :modify_time,
  :deletion_time)
  SENSITIVE = []
  include Aws::Structure
end

#protocol ⇒ String

The protocol used for the health check.

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 2082

class ApplicationStatusCheckResponseObject < Struct.new(
  :application_status_check_id,
  :aggregation,
  :health_check_paths,
  :protocol,
  :port,
  :path,
  :device_index,
  :ip_version,
  :ip_scope,
  :interval,
  :timeout,
  :failure_threshold,
  :success_threshold,
  :status_code_matcher,
  :initialization_grace_period_seconds,
  :last_updated_at,
  :target_tag_associations,
  :tags,
  :creation_time,
  :modify_time,
  :deletion_time)
  SENSITIVE = []
  include Aws::Structure
end

#status_code_matcher ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 2082

class ApplicationStatusCheckResponseObject < Struct.new(
  :application_status_check_id,
  :aggregation,
  :health_check_paths,
  :protocol,
  :port,
  :path,
  :device_index,
  :ip_version,
  :ip_scope,
  :interval,
  :timeout,
  :failure_threshold,
  :success_threshold,
  :status_code_matcher,
  :initialization_grace_period_seconds,
  :last_updated_at,
  :target_tag_associations,
  :tags,
  :creation_time,
  :modify_time,
  :deletion_time)
  SENSITIVE = []
  include Aws::Structure
end

#success_threshold ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 2082

class ApplicationStatusCheckResponseObject < Struct.new(
  :application_status_check_id,
  :aggregation,
  :health_check_paths,
  :protocol,
  :port,
  :path,
  :device_index,
  :ip_version,
  :ip_scope,
  :interval,
  :timeout,
  :failure_threshold,
  :success_threshold,
  :status_code_matcher,
  :initialization_grace_period_seconds,
  :last_updated_at,
  :target_tag_associations,
  :tags,
  :creation_time,
  :modify_time,
  :deletion_time)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

The tags assigned to the application status check.

Returns:

• (Array<Types::Tag>)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 2082

class ApplicationStatusCheckResponseObject < Struct.new(
  :application_status_check_id,
  :aggregation,
  :health_check_paths,
  :protocol,
  :port,
  :path,
  :device_index,
  :ip_version,
  :ip_scope,
  :interval,
  :timeout,
  :failure_threshold,
  :success_threshold,
  :status_code_matcher,
  :initialization_grace_period_seconds,
  :last_updated_at,
  :target_tag_associations,
  :tags,
  :creation_time,
  :modify_time,
  :deletion_time)
  SENSITIVE = []
  include Aws::Structure
end

#target_tag_associations ⇒ Array<Types::CustomTagKeyValueResponsePair>

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

Returns:

• (Array<Types::CustomTagKeyValueResponsePair>)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 2082

class ApplicationStatusCheckResponseObject < Struct.new(
  :application_status_check_id,
  :aggregation,
  :health_check_paths,
  :protocol,
  :port,
  :path,
  :device_index,
  :ip_version,
  :ip_scope,
  :interval,
  :timeout,
  :failure_threshold,
  :success_threshold,
  :status_code_matcher,
  :initialization_grace_period_seconds,
  :last_updated_at,
  :target_tag_associations,
  :tags,
  :creation_time,
  :modify_time,
  :deletion_time)
  SENSITIVE = []
  include Aws::Structure
end

#timeout ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 2082

class ApplicationStatusCheckResponseObject < Struct.new(
  :application_status_check_id,
  :aggregation,
  :health_check_paths,
  :protocol,
  :port,
  :path,
  :device_index,
  :ip_version,
  :ip_scope,
  :interval,
  :timeout,
  :failure_threshold,
  :success_threshold,
  :status_code_matcher,
  :initialization_grace_period_seconds,
  :last_updated_at,
  :target_tag_associations,
  :tags,
  :creation_time,
  :modify_time,
  :deletion_time)
  SENSITIVE = []
  include Aws::Structure
end