Try SpotterManage health-checks in Amazons Route53 DNS service
| "added in version" 1.0.0 of community.aws"
Authors: zimbatm (@zimbatm)
Install with ansible-galaxy collection install community.aws:==3.4.0
collections:
- name: community.aws
version: 3.4.0Creates 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.
- name: Create a health-check for host1.example.com and use it in record
community.aws.route53_health_check:
state: present
fqdn: host1.example.com
type: HTTP_STR_MATCH
resource_path: /
string_match: "Hello"
request_interval: 10
failure_threshold: 2
register: my_health_check
- community.aws.route53:
action: create
zone: "example.com"
type: CNAME
record: "www.example.com"
value: host1.example.com
ttl: 30
# Routing policy
identifier: "host1@www"
weight: 100
health_check: "{{ my_health_check.health_check.id }}"
- name: Delete health-check
community.aws.route53_health_check:
state: absent
fqdn: host1.example.com
fqdn:
description:
- Domain name of the endpoint to check. Either this or I(ip_address) has to be provided.
When both are given the I(fqdn) is used in the C(Host:) header of the HTTP request.
type: str
port:
description:
- The port on the endpoint on which you want Amazon Route 53 to perform health checks.
Required for TCP checks.
type: int
tags:
description:
- A hash/dictionary of tags to set on the health check.
type: dict
version_added: 2.1.0
version_added_collection: community.aws
type:
choices:
- HTTP
- HTTPS
- HTTP_STR_MATCH
- HTTPS_STR_MATCH
- TCP
description:
- The type of health check that you want to create, which indicates how Amazon Route
53 determines whether an endpoint is healthy.
required: true
type: str
state:
choices:
- present
- absent
default: present
description:
- Specifies the action to take.
type: str
region:
aliases:
- aws_region
- ec2_region
description:
- The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION
environment variable, if any, is used. See U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region)
type: str
ec2_url:
aliases:
- aws_endpoint_url
- endpoint_url
description:
- URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will
use EC2 endpoints). Ignored for modules where region is required. Must be specified
for all other modules if region is not used. If not set then the value of the EC2_URL
environment variable, if any, is used.
type: str
profile:
aliases:
- aws_profile
description:
- Using I(profile) will override I(aws_access_key), I(aws_secret_key) and I(security_token)
and support for passing them at the same time as I(profile) has been deprecated.
- I(aws_access_key), I(aws_secret_key) and I(security_token) will be made mutually
exclusive with I(profile) after 2022-06-01.
type: str
disabled:
description:
- Stops Route 53 from performing health checks.
- See the AWS documentation for more details on the exact implications. U(https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/health-checks-creating-values.html)
- Defaults to C(true) when creating a new health check.
type: bool
version_added: 2.1.0
version_added_collection: community.aws
aws_config:
description:
- A dictionary to modify the botocore configuration.
- Parameters can be found at U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config).
- Only the 'user_agent' key is used for boto modules. See U(http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto)
for more boto configuration.
type: dict
ip_address:
description:
- IP address of the end-point to check. Either this or I(fqdn) has to be provided.
- IP addresses must be publicly routable.
type: str
purge_tags:
default: false
description:
- Delete any tags not specified in I(tags).
type: bool
version_added: 2.1.0
version_added_collection: community.aws
string_match:
description:
- 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.
type: str
aws_ca_bundle:
description:
- The location of a CA Bundle to use when validating SSL certificates.
- Not used by boto 2 based modules.
- 'Note: The CA Bundle is read ''module'' side and may need to be explicitly copied
from the controller if not run locally.'
type: path
resource_path:
description:
- 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.
- Mutually exclusive with I(type='TCP').
- The path must begin with a /
- Maximum 255 characters.
type: str
aws_access_key:
aliases:
- ec2_access_key
- access_key
description:
- C(AWS access key). If not set then the value of the C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY)
or C(EC2_ACCESS_KEY) environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(aws_access_key) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
aws_secret_key:
aliases:
- ec2_secret_key
- secret_key
description:
- C(AWS secret key). If not set then the value of the C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY),
or C(EC2_SECRET_KEY) environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(aws_secret_key) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
security_token:
aliases:
- aws_security_token
- access_token
description:
- C(AWS STS security token). If not set then the value of the C(AWS_SECURITY_TOKEN)
or C(EC2_SECURITY_TOKEN) environment variable is used.
- If I(profile) is set this parameter is ignored.
- Passing the I(security_token) and I(profile) options at the same time has been deprecated
and the options will be made mutually exclusive after 2022-06-01.
type: str
validate_certs:
default: true
description:
- When set to "no", SSL certificates will not be validated for communication with
the AWS APIs.
type: bool
request_interval:
choices:
- 10
- 30
default: 30
description:
- 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.
type: int
failure_threshold:
choices:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
description:
- 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.
- Will default to C(3) if not specified on creation.
type: int
debug_botocore_endpoint_logs:
default: 'no'
description:
- Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action"
API calls made during a task, outputing the set to the resource_actions key in the
task results. Use the aws_resource_action callback to output to total list made
during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also
be used.
type: bool
health_check:
contains:
action:
description: The action performed by the module.
returned: When a change is or would be made.
sample: updated
type: str
health_check_config:
contains:
disabled:
description: Whether the health check has been disabled or not.
returned: When the health check exists.
sample: false
type: bool
failure_threshold:
description:
- 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.
returned: When the health check exists.
sample: 3
type: int
fully_qualified_domain_name:
description: The FQDN configured for the health check to test.
returned: When the health check exists and an FQDN is configured.
sample: updated
type: str
ip_address:
description: The IPv4 or IPv6 IP address of the endpoint to be queried.
returned: When the health check exists and a specific IP address is configured.
sample: ''
type: str
port:
description: The port on the endpoint that the health check will query.
returned: When the health check exists.
sample: updated
type: str
request_interval:
description: The number of seconds between health check queries.
returned: When the health check exists.
sample: 30
type: int
resource_path:
description: The URI path to query when performing an HTTP/HTTPS based health
check.
returned: When the health check exists and a resource path has been configured.
sample: /healthz
type: str
search_string:
description: A string that must be present in the response for a health
check to be considered successful.
returned: When the health check exists and a search string has been configured.
sample: ALIVE
type: str
type:
description: The type of the health check.
returned: When the health check exists.
sample: HTTPS_STR_MATCH
type: str
description:
- Detailed information about the health check.
- May contain additional values from Route 53 health check features not yet
supported by this module.
returned: When the health check exists.
type: dict
health_check_version:
description: The version number of the health check.
returned: When the health check exists.
sample: 14
type: int
id:
description: The Unique ID assigned by AWS to the health check.
returned: When the health check exists.
sample: 50ec8a13-9623-4c66-9834-dd8c5aedc9ba
type: str
tags:
description: A dictionary representing the tags on the health check.
returned: When the health check exists.
sample: '{"my_key": "my_value"}'
type: dict
description: Information about the health check.
returned: success
type: dict