Documentation

ec2_vpc_subnet - Manage subnets in AWS virtual private clouds

New in version 2.0.

Synopsis

Manage subnets in AWS virtual private clouds

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
      az
      		 no
        The availability zone for the subnet. Only required when state=present.
        cidr
        		 no
          The CIDR block for the subnet. E.g. 10.0.0.0/16. Only required when state=present.
          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 present
                  • present
                  • absent
                  Create or remove the subnet
                  tags
                  		 no
                    A dict of tags to apply to the subnet. Any tags currently applied to the subnet and not present here will be removed.

                    aliases: resource_tags
                    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
                      VPC ID of the VPC in which to create the subnet.

                      Examples

                      # Note: These examples do not set authentication details, see the AWS Guide for details.

- name: Create subnet for database servers
  ec2_vpc_subnet:
    state: present
    vpc_id: vpc-123456
    cidr: 10.0.1.16/28
    resource_tags:
      Name: Database Subnet
  register: database_subnet

- name: Remove subnet for database servers
  ec2_vpc_subnet:
    state: absent
    vpc_id: vpc-123456
    cidr: 10.0.1.16/28

                      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.