ansible.builtin.route53_zone (v2.3.3.0-1) — module

add or delete Route53 zones

| "added in version" 2.0 of ansible.builtin"

Authors: Christopher Troup (@minichate)

stableinterface | supported by community

Install Ansible via pip

Install with pip install ansible==2.3.3.0.post1

Description

Creates and deletes Route53 private and public zones


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# create a public zone
- route53_zone:
    zone: example.com
    state: present
    comment: this is an example
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# delete a public zone
- route53_zone:
    zone: example.com
    state: absent
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: private zone for devel
  route53_zone:
    zone: devel.example.com
    state: present
    vpc_id: '{{ myvpc_id }}'
    comment: developer domain
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# more complex example
- name: register output after creating zone in parameterized region
  route53_zone:
    vpc_id: '{{ vpc.vpc_id }}'
    vpc_region: '{{ ec2_region }}'
    zone: '{{ vpc_dns_zone }}'
    state: present
  register: zone_out
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- debug:
    var: zone_out

Inputs

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

state:
    choices:
    - present
    - absent
    default: true
    description:
    - whether or not the zone should exist or not
    required: false

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:
    default: null
    description:
    - The VPC ID the zone should be a part of (if this is going to be a private zone)
    required: false

comment:
    default: ''
    description:
    - Comment associated with the zone
    required: false

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:
    - The I(profile) option is mutually exclusive with the I(aws_access_key), I(aws_secret_key)
      and I(security_token) options.
    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).
    type: dict

vpc_region:
    default: null
    description:
    - The VPC Region the zone should be a part of (if this is going to be a private zone)
    required: false

aws_ca_bundle:
    description:
    - The location of a CA Bundle to use when validating SSL certificates.
    - '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.
    - The I(aws_access_key) and I(profile) options are mutually exclusive.
    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.
    - The I(aws_secret_key) and I(profile) options are mutually exclusive.
    type: str

security_token:
    aliases:
    - aws_session_token
    - session_token
    - 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.
    - The I(security_token) and I(profile) options are mutually exclusive.
    - Aliases I(aws_session_token) and I(session_token) have been added in version 3.2.0.
    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

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: string
name:
  description: hosted zone name
  returned: when hosted zone exists
  sample: private.local.
  type: string
private_zone:
  description: whether hosted zone is private or public
  returned: when hosted zone exists
  sample: true
  type: bool
vpc_id:
  description: id of vpc attached to private hosted zone
  returned: for private hosted zone
  sample: vpc-1d36c84f
  type: string
vpc_region:
  description: region of vpc attached to private hosted zone
  returned: for private hosted zone
  sample: eu-west-1
  type: string
zone_id:
  description: hosted zone id
  returned: when hosted zone exists
  sample: Z6JQG9820BEFMW
  type: string