W3cubDocs

/Ansible

ec2_vpc_net - Configure AWS virtual private clouds

New in version 2.0.

Synopsis

  • Create or terminate AWS virtual private clouds. This module has a dependency on python-boto.

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
cidr_block
 yes
The CIDR of the VPC
dhcp_opts_id
 no
the id of the DHCP options to use for this vpc
dns_hostnames
 no True
  • yes
  • no
Whether to enable AWS hostname support.
dns_support
 no True
  • yes
  • no
Whether to enable AWS DNS support.
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.
multi_ok
 no
By default the module will not create another VPC if there is another VPC with the same name and CIDR block. Specify this as true if you want duplicate VPCs created.
name
 yes
The name to give your VPC. This is used in combination with the cidr_block parameter to determine if a VPC already exists.
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
The state of the VPC. Either absent or present.
tags
 no None
The tags you want attached to the VPC. This is independent of the name value, note if you pass a 'Name' key it would override the Name of the VPC if it's different.
aliases: resource_tags
tenancy
 no default
  • default
  • dedicated
Whether to be default or dedicated tenancy. This cannot be changed after the VPC has been created.
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.

Examples

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

# Create a VPC with dedicate tenancy and a couple of tags

- ec2_vpc_net:
    name: Module_dev2
    cidr_block: 10.10.0.0/16
    region: us-east-1
    tags:
      module: ec2_vpc_net
      this: works
    tenancy: dedicated

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name description returned type sample
vpc.state
state of the VPC
 success string available
vpc.dhcp_options_id
the id of the DHCP options assocaited with this VPC
 success string dopt-67236184
vpc.classic_link_enabled
indicates whether ClassicLink is enabled
 success boolean False
vpc.tags
tags attached to the VPC, includes name
 success dict {'Name': 'My VPC', 'env': 'staging'}
vpc.id
VPC resource id
 success string vpc-b883b2c4
vpc.cidr_block
The CIDR of the VPC
 success string 10.0.0.0/16
vpc.instance_tenancy
indicates whther VPC uses default or dedicated tenancy
 success string default
vpc.is_default
indicates whether this is the default VPC
 success boolean False

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
  • Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See http://boto.readthedocs.org/en/latest/boto_config_tut.html
  • 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

Status

This module is flagged as stableinterface which means that the maintainers for this module guarantee that no backward incompatible interface changes will be made.

Maintenance Info

For more information about Red Hat’s this support of this module, please refer to this knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>

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

© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/ec2_vpc_net_module.html