ec2_vpc_net - Configure AWS virtual private clouds¶

New in version 2.0.

Synopsis
- Requirements
Parameters
Notes
Examples
Return Values
Status
Maintenance
- Support
- Author

Synopsis ¶

Create, modify, and terminate AWS virtual private clouds.

Requirements ¶

The below requirements are needed on the host that executes this module.

boto
boto3
botocore
python >= 2.6

Parameters ¶

Parameter	Choices/Defaults	Comments
aws_access_key		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		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 required		The primary CIDR of the VPC. After 2.5 a list of CIDRs can be provided. The first in the list will be used as the primary CIDR and is used in conjunction with the `name` to ensure idempotence.
dhcp_opts_id		the id of the DHCP options to use for this vpc
dns_hostnames bool	Choices: no yes ←	Whether to enable AWS hostname support.
dns_support bool	Choices: no yes ←	Whether to enable AWS DNS support.
ec2_url		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	Default: 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 required		The name to give your VPC. This is used in combination with `cidr_block` to determine if a VPC already exists.
profile (added in 1.6)		Uses a boto profile. Only works with boto >= 2.24.0.
purge_cidrs bool (added in 2.5)	Choices: no ← yes	Remove CIDRs that are associated with the VPC and are not specified in `cidr_block`.
region		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)		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	Choices: present ← absent	The state of the VPC. Either absent or present.
tags		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	Choices: default ← dedicated	Whether to be default or dedicated tenancy. This cannot be changed after the VPC has been created.
validate_certs bool (added in 1.5)	Choices: no yes ←	When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.

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 https://boto.readthedocs.io/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

Examples ¶

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

- name: create a VPC with dedicated 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, the following are the fields unique to this module:

Key			Returned	Description
vpc complex			always	info about the VPC that was created or deleted
	instance_tenancy string		always	indicates whether VPC uses default or dedicated tenancy Sample: default
	cidr_block_association_set list		success	IPv4 CIDR blocks associated with the VPC Sample: {'cidr_block_association_set': [{'association_id': 'vpc-cidr-assoc-97aeeefd', 'cidr_block': '20.0.0.0/24', 'cidr_block_state': {'state': 'associated'}}]}
	classic_link_enabled NoneType		always	indicates whether ClassicLink is enabled
	tags complex		always	tags attached to the VPC, includes name
		Name string	always	name tag for the VPC Sample: pk_vpc4
	id string		always	VPC resource id Sample: vpc-c2e00da5
	is_default bool		always	indicates whether this is the default VPC
	state string		always	state of the VPC Sample: available
	cidr_block string		always	The CIDR of the VPC Sample: 10.0.0.0/16
	dhcp_options_id string		always	the id of the DHCP options assocaited with this VPC Sample: dopt-0fb8bd6b

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 ¶

This module is flagged as core which means that it is maintained by the Ansible Core Team. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Core Team, see here.

Support ¶

For more information about Red Hat’s support of this module, please refer to this Knowledge Base article

Author ¶

Jonathan Davila (@defionscode)
Sloane Hertel (@s-hertel)

Hint

If you notice any issues in this documentation you can edit this document to improve it.