community.aws.route53_zone (3.4.0) — module

add or delete Route53 zones

| "added in version" 1.0.0 of community.aws"

Authors: Christopher Troup (@minichate)

Install collection

Install with ansible-galaxy collection install community.aws:==3.4.0


Add to requirements.yml

  collections:
    - name: community.aws
      version: 3.4.0

Description

Creates and deletes Route53 private and public zones.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: create a public zone
  community.aws.route53_zone:
    zone: example.com
    comment: this is an example
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: delete a public zone
  community.aws.route53_zone:
    zone: example.com
    state: absent
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: create a private zone
  community.aws.route53_zone:
    zone: devel.example.com
    vpc_id: '{{ myvpc_id }}'
    vpc_region: us-west-2
    comment: developer domain
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: create a public zone associated with a specific reusable delegation set
  community.aws.route53_zone:
    zone: example.com
    comment: reusable delegation set example
    delegation_set_id: A1BCDEF2GHIJKL
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: create a public zone with tags
  community.aws.route53_zone:
    zone: example.com
    comment: this is an example
    tags:
        Owner: Ansible Team
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: modify a public zone, removing all previous tags and adding a new one
  community.aws.route53_zone:
    zone: example.com
    comment: this is an example
    tags:
        Support: Ansible Community
    purge_tags: true

Inputs

    
tags:
    description:
    - A hash/dictionary of tags to add to the new instance or to add/remove from an existing
      one.
    type: dict
    version_added: 2.1.0
    version_added_collection: community.aws

zone:
    description:
    - 'The DNS zone record (eg: foo.com.)'
    required: true
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Whether or not the zone should exist or not.
    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

vpc_id:
    description:
    - The VPC ID the zone should be a part of (if this is going to be a private zone).
    type: str

comment:
    default: ''
    description:
    - Comment associated with the zone.
    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

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

purge_tags:
    default: false
    description:
    - Delete any tags not specified in the task that are on the zone. This means you have
      to specify all the desired tags on each task affecting a zone.
    type: bool
    version_added: 2.1.0
    version_added_collection: community.aws

vpc_region:
    description:
    - The VPC Region the zone should be a part of (if this is going to be a private zone).
    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

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

hosted_zone_id:
    description:
    - The unique zone identifier you want to delete or "all" if there are many zones with
      the same domain name.
    - Required if there are multiple zones identified with the above options.
    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

delegation_set_id:
    description:
    - The reusable delegation set ID to be associated with the zone.
    - Note that you can't associate a reusable delegation set with a private hosted zone.
    type: str

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

Outputs

comment:
  description: optional hosted zone comment
  returned: when hosted zone exists
  sample: Private zone
  type: str
delegation_set_id:
  description: id of the associated reusable delegation set
  returned: for public hosted zones, if they have been associated with a reusable
    delegation set
  sample: A1BCDEF2GHIJKL
  type: str
name:
  description: hosted zone name
  returned: when hosted zone exists
  sample: private.local.
  type: str
private_zone:
  description: whether hosted zone is private or public
  returned: when hosted zone exists
  sample: true
  type: bool
tags:
  description: tags associated with the zone
  returned: when tags are defined
  type: dict
vpc_id:
  description: id of vpc attached to private hosted zone
  returned: for private hosted zone
  sample: vpc-1d36c84f
  type: str
vpc_region:
  description: region of vpc attached to private hosted zone
  returned: for private hosted zone
  sample: eu-west-1
  type: str
zone_id:
  description: hosted zone id
  returned: when hosted zone exists
  sample: Z6JQG9820BEFMW
  type: str