Documentation

route53_zone - add or delete Route53 zones

New in version 2.0.

Synopsis

Creates and deletes Route53 private and public zones

Requirements (on host that executes module)

  • python >= 2.6
  • boto

Options

parameter required default choices comments
aws_access_key
no
    AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.

    aliases: ec2_access_key, access_key
    aws_secret_key
    no
      AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.

      aliases: ec2_secret_key, secret_key
      comment
      no
        Comment associated with the zone
        ec2_url
        no
          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.
          profile
          (added in 1.6)
          no
            uses a boto profile. Only works with boto >= 2.24.0
            region
            no
              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 http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region

              aliases: aws_region, ec2_region
              security_token
              (added in 1.6)
              no
                AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.

                aliases: access_token
                state
                no True
                • present
                • absent
                whether or not the zone should exist or not
                validate_certs
                (added in 1.5)
                no yes
                • yes
                • no
                When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
                vpc_id
                no
                  The VPC ID the zone should be a part of (if this is going to be a private zone)
                  vpc_region
                  no
                    The VPC Region the zone should be a part of (if this is going to be a private zone)
                    zone
                    yes
                      The DNS zone record (eg: foo.com.)

                      Examples

                      # create a public zone
                      - route53_zone: zone=example.com state=present comment="this is an example"
                      
                      # delete a public zone
                      - route53_zone: zone=example.com state=absent
                      
                      - name: private zone for devel
                        route53_zome: zone=devel.example.com state=present vpc_id={{myvpc_id}} comment='developer domain'
                      
                      # 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
                      
                      - debug: var=zone_out
                      

                      Notes

                      Note

                      If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence AWS_URL or EC2_URL, AWS_ACCESS_KEY_ID or AWS_ACCESS_KEY or EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY or AWS_SECRET_KEY or EC2_SECRET_KEY, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN, AWS_REGION or EC2_REGION

                      Note

                      Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See http://boto.readthedocs.org/en/latest/boto_config_tut.html

                      Note

                      AWS_REGION or EC2_REGION can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file

                      This is an Extras Module

                      For more information on what this means please read Extras Modules

                      For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.