Class: Ansible::Ruby::Modules::Route53_health_check

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/cloud/amazon/route53_health_check.rb

Overview

Creates and deletes DNS Health checks in Amazons Route53 service Only the port, resource_path, string_match and request_interval are considered when updating existing health-checks.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#failure_threshold ⇒ 1, ...

Returns The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa.

Returns:

  • (1, 2, 3, 4, 5, 6, 7, 8, 9, 10) —

    The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa.



43
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/route53_health_check.rb', line 43

attribute :failure_threshold

#fqdn ⇒ String?

Returns Domain name of the endpoint to check. Either this or ‘ip_address` has to be provided. When both are given the `fqdn` is used in the `Host:` header of the HTTP request.

Returns:

  • (String, nil) —

    Domain name of the endpoint to check. Either this or ‘ip_address` has to be provided. When both are given the `fqdn` is used in the `Host:` header of the HTTP request.



31
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/route53_health_check.rb', line 31

attribute :fqdn

#ip_address ⇒ Object?

Returns IP address of the end-point to check. Either this or ‘fqdn` has to be provided.

Returns:

  • (Object, nil) —

    IP address of the end-point to check. Either this or ‘fqdn` has to be provided.



17
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/route53_health_check.rb', line 17

attribute :ip_address

#port ⇒ Object?

Returns The port on the endpoint on which you want Amazon Route 53 to perform health checks. Required for TCP checks.

Returns:

  • (Object, nil) —

    The port on the endpoint on which you want Amazon Route 53 to perform health checks. Required for TCP checks.



20
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/route53_health_check.rb', line 20

attribute :port

#request_interval ⇒ 10, 30

Returns The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health-check request.

Returns:

  • (10, 30) —

    The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health-check request.



39
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/route53_health_check.rb', line 39

attribute :request_interval

#resource_path ⇒ String?

Returns The path that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example the file /docs/route53-health-check.html.,Required for all checks except TCP.,The path must begin with a /,Maximum 255 characters.

Returns:

  • (String, nil) —

    The path that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example the file /docs/route53-health-check.html.,Required for all checks except TCP.,The path must begin with a /,Maximum 255 characters.



27
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/route53_health_check.rb', line 27

attribute :resource_path

#state ⇒ :present, :absent

Returns Specifies the action to take.

Returns:

  • (:present, :absent) —

    Specifies the action to take.



13
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/route53_health_check.rb', line 13

attribute :state

#string_match ⇒ String?

Returns If the check type is HTTP_STR_MATCH or HTTP_STR_MATCH, the string that you want Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the first 5120 bytes of the response body, Amazon Route 53 considers the resource healthy.

Returns:

  • (String, nil) —

    If the check type is HTTP_STR_MATCH or HTTP_STR_MATCH, the string that you want Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the first 5120 bytes of the response body, Amazon Route 53 considers the resource healthy.



35
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/route53_health_check.rb', line 35

attribute :string_match

#type ⇒ :HTTP, ...

Returns The type of health check that you want to create, which indicates how Amazon Route 53 determines whether an endpoint is healthy.

Returns:

  • (:HTTP, :HTTPS, :HTTP_STR_MATCH, :HTTPS_STR_MATCH, :TCP) —

    The type of health check that you want to create, which indicates how Amazon Route 53 determines whether an endpoint is healthy.



23
 
# File 'lib/ansible/ruby/modules/generated/cloud/amazon/route53_health_check.rb', line 23

attribute :type