Class: Aws::EC2::Types::ModifyApplicationStatusCheckRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

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 reported by DescribeApplicationStatus. When set to excluded, the check runs independently and does not affect the instance-level status. Valid values: included | excluded.

Returns:

  • (String)


67149
67150
67151
67152
67153
67154
67155
67156
67157
67158
67159
67160
67161
67162
67163
67164
67165
67166
67167
67168
67169
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 67149

class ModifyApplicationStatusCheckRequest < 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,
  :client_token,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#application_status_check_id ⇒ String

The ID of the application status check to modify.

Returns:

  • (String)


67149
67150
67151
67152
67153
67154
67155
67156
67157
67158
67159
67160
67161
67162
67163
67164
67165
67166
67167
67168
67169
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 67149

class ModifyApplicationStatusCheckRequest < 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,
  :client_token,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ 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.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


67149
67150
67151
67152
67153
67154
67155
67156
67157
67158
67159
67160
67161
67162
67163
67164
67165
67166
67167
67168
67169
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 67149

class ModifyApplicationStatusCheckRequest < 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,
  :client_token,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#device_index ⇒ Integer

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

Returns:

  • (Integer)


67149
67150
67151
67152
67153
67154
67155
67156
67157
67158
67159
67160
67161
67162
67163
67164
67165
67166
67167
67168
67169
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 67149

class ModifyApplicationStatusCheckRequest < 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,
  :client_token,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#dry_run ⇒ 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.

Returns:

  • (Boolean)


67149
67150
67151
67152
67153
67154
67155
67156
67157
67158
67159
67160
67161
67162
67163
67164
67165
67166
67167
67168
67169
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 67149

class ModifyApplicationStatusCheckRequest < 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,
  :client_token,
  :dry_run)
  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)


67149
67150
67151
67152
67153
67154
67155
67156
67157
67158
67159
67160
67161
67162
67163
67164
67165
67166
67167
67168
67169
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 67149

class ModifyApplicationStatusCheckRequest < 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,
  :client_token,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#health_check_paths ⇒ Array<Types::HealthCheckPathRequestObject>

The health check paths to use for the application status check.



67149
67150
67151
67152
67153
67154
67155
67156
67157
67158
67159
67160
67161
67162
67163
67164
67165
67166
67167
67168
67169
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 67149

class ModifyApplicationStatusCheckRequest < 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,
  :client_token,
  :dry_run)
  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)


67149
67150
67151
67152
67153
67154
67155
67156
67157
67158
67159
67160
67161
67162
67163
67164
67165
67166
67167
67168
67169
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 67149

class ModifyApplicationStatusCheckRequest < 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,
  :client_token,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#interval ⇒ Integer

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

Returns:

  • (Integer)


67149
67150
67151
67152
67153
67154
67155
67156
67157
67158
67159
67160
67161
67162
67163
67164
67165
67166
67167
67168
67169
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 67149

class ModifyApplicationStatusCheckRequest < 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,
  :client_token,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#ip_scope ⇒ String

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

Returns:

  • (String)


67149
67150
67151
67152
67153
67154
67155
67156
67157
67158
67159
67160
67161
67162
67163
67164
67165
67166
67167
67168
67169
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 67149

class ModifyApplicationStatusCheckRequest < 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,
  :client_token,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#ip_version ⇒ String

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

Returns:

  • (String)


67149
67150
67151
67152
67153
67154
67155
67156
67157
67158
67159
67160
67161
67162
67163
67164
67165
67166
67167
67168
67169
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 67149

class ModifyApplicationStatusCheckRequest < 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,
  :client_token,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#path ⇒ String

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

Returns:

  • (String)


67149
67150
67151
67152
67153
67154
67155
67156
67157
67158
67159
67160
67161
67162
67163
67164
67165
67166
67167
67168
67169
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 67149

class ModifyApplicationStatusCheckRequest < 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,
  :client_token,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#port ⇒ Integer

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

Returns:

  • (Integer)


67149
67150
67151
67152
67153
67154
67155
67156
67157
67158
67159
67160
67161
67162
67163
67164
67165
67166
67167
67168
67169
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 67149

class ModifyApplicationStatusCheckRequest < 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,
  :client_token,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#protocol ⇒ String

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

Returns:

  • (String)


67149
67150
67151
67152
67153
67154
67155
67156
67157
67158
67159
67160
67161
67162
67163
67164
67165
67166
67167
67168
67169
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 67149

class ModifyApplicationStatusCheckRequest < 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,
  :client_token,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#status_code_matcher ⇒ 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.

Returns:

  • (String)


67149
67150
67151
67152
67153
67154
67155
67156
67157
67158
67159
67160
67161
67162
67163
67164
67165
67166
67167
67168
67169
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 67149

class ModifyApplicationStatusCheckRequest < 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,
  :client_token,
  :dry_run)
  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)


67149
67150
67151
67152
67153
67154
67155
67156
67157
67158
67159
67160
67161
67162
67163
67164
67165
67166
67167
67168
67169
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 67149

class ModifyApplicationStatusCheckRequest < 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,
  :client_token,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end

#timeout ⇒ 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.

Returns:

  • (Integer)


67149
67150
67151
67152
67153
67154
67155
67156
67157
67158
67159
67160
67161
67162
67163
67164
67165
67166
67167
67168
67169
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 67149

class ModifyApplicationStatusCheckRequest < 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,
  :client_token,
  :dry_run)
  SENSITIVE = []
  include Aws::Structure
end