Try SpotterConfigure AWS virtual private clouds
| "added in version" 2.0 of ansible.builtin"
Authors: Jonathan Davila (@defionscode), Sloane Hertel (@s-hertel)
stableinterface | supported by core
pipInstall with pip install ansible==2.5.12
Create, modify, and terminate AWS virtual private clouds.
# 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
name:
description:
- The name to give your VPC. This is used in combination with C(cidr_block) to determine
if a VPC already exists.
required: true
tags:
aliases:
- resource_tags
description:
- 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.
state:
choices:
- present
- absent
default: present
description:
- The state of the VPC. Either absent or present.
region:
aliases:
- aws_region
- ec2_region
description:
- The AWS region to use.
- For global services such as IAM, Route53 and CloudFront, I(region) is ignored.
- The C(AWS_REGION) or C(EC2_REGION) environment variables may also be used.
- See the Amazon AWS documentation for more information U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region).
- The C(ec2_region) alias has been deprecated and will be removed in a release after
2024-12-01
- Support for the C(EC2_REGION) environment variable has been deprecated and will
be removed in a release after 2024-12-01.
type: str
profile:
aliases:
- aws_profile
description:
- A named AWS profile to use for authentication.
- See the AWS documentation for more information about named profiles U(https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html).
- The C(AWS_PROFILE) environment variable may also be used.
- The I(profile) option is mutually exclusive with the I(aws_access_key), I(aws_secret_key)
and I(security_token) options.
type: str
tenancy:
choices:
- default
- dedicated
default: default
description:
- Whether to be default or dedicated tenancy. This cannot be changed after the VPC
has been created.
multi_ok:
default: false
description:
- 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.
access_key:
aliases:
- aws_access_key_id
- aws_access_key
- ec2_access_key
description:
- AWS access key ID.
- See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
- The C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variables
may also be used in decreasing order of preference.
- The I(aws_access_key) and I(profile) options are mutually exclusive.
- The I(aws_access_key_id) alias was added in release 5.1.0 for consistency with the
AWS botocore SDK.
- The I(ec2_access_key) alias has been deprecated and will be removed in a release
after 2024-12-01.
- Support for the C(EC2_ACCESS_KEY) environment variable has been deprecated and will
be removed in a release after 2024-12-01.
type: str
aws_config:
description:
- A dictionary to modify the botocore configuration.
- Parameters can be found in the AWS documentation U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config).
type: dict
cidr_block:
description:
- 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
C(name) to ensure idempotence.
required: true
secret_key:
aliases:
- aws_secret_access_key
- aws_secret_key
- ec2_secret_key
description:
- AWS secret access key.
- See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
- The C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment
variables may also be used in decreasing order of preference.
- The I(secret_key) and I(profile) options are mutually exclusive.
- The I(aws_secret_access_key) alias was added in release 5.1.0 for consistency with
the AWS botocore SDK.
- The I(ec2_secret_key) alias has been deprecated and will be removed in a release
after 2024-12-01.
- Support for the C(EC2_SECRET_KEY) environment variable has been deprecated and will
be removed in a release after 2024-12-01.
type: str
dns_support:
choices:
- 'yes'
- 'no'
default: true
description:
- Whether to enable AWS DNS support.
purge_cidrs:
choices:
- 'yes'
- 'no'
default: false
description:
- Remove CIDRs that are associated with the VPC and are not specified in C(cidr_block).
version_added: '2.5'
version_added_collection: ansible.builtin
dhcp_opts_id:
description:
- the id of the DHCP options to use for this vpc
endpoint_url:
aliases:
- ec2_url
- aws_endpoint_url
- s3_url
description:
- URL to connect to instead of the default AWS endpoints. While this can be used
to connection to other AWS-compatible services the amazon.aws and community.aws
collections are only tested against AWS.
- The C(AWS_URL) or C(EC2_URL) environment variables may also be used, in decreasing
order of preference.
- The I(ec2_url) and I(s3_url) aliases have been deprecated and will be removed in
a release after 2024-12-01.
- Support for the C(EC2_URL) environment variable has been deprecated and will be
removed in a release after 2024-12-01.
type: str
aws_ca_bundle:
description:
- The location of a CA Bundle to use when validating SSL certificates.
- The C(AWS_CA_BUNDLE) environment variable may also be used.
type: path
dns_hostnames:
choices:
- 'yes'
- 'no'
default: true
description:
- Whether to enable AWS hostname support.
session_token:
aliases:
- aws_session_token
- security_token
- aws_security_token
- access_token
description:
- AWS STS session token for use with temporary credentials.
- See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys).
- The C(AWS_SESSION_TOKEN), C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment
variables may also be used in decreasing order of preference.
- The I(security_token) and I(profile) options are mutually exclusive.
- Aliases I(aws_session_token) and I(session_token) were added in release 3.2.0, with
the parameter being renamed from I(security_token) to I(session_token) in release
6.0.0.
- The I(security_token), I(aws_security_token), and I(access_token) aliases have been
deprecated and will be removed in a release after 2024-12-01.
- Support for the C(EC2_SECRET_KEY) and C(AWS_SECURITY_TOKEN) environment variables
has been deprecated and will be removed in a release after 2024-12-01.
type: str
validate_certs:
default: true
description:
- When set to C(false), SSL certificates will not be validated for communication with
the AWS APIs.
- Setting I(validate_certs=false) is strongly discouraged, as an alternative, consider
setting I(aws_ca_bundle) instead.
type: bool
debug_botocore_endpoint_logs:
default: false
description:
- Use a C(botocore.endpoint) logger to parse the unique (rather than total) C("resource:action")
API calls made during a task, outputing the set to the resource_actions key in the
task results. Use the C(aws_resource_action) callback to output to total list made
during a playbook.
- The C(ANSIBLE_DEBUG_BOTOCORE_LOGS) environment variable may also be used.
type: bool
vpc:
contains:
cidr_block:
description: The CIDR of the VPC
returned: always
sample: 10.0.0.0/16
type: string
cidr_block_association_set:
description: IPv4 CIDR blocks associated with the VPC
returned: success
sample:
cidr_block_association_set:
- association_id: vpc-cidr-assoc-97aeeefd
cidr_block: 20.0.0.0/24
cidr_block_state:
state: associated
type: list
classic_link_enabled:
description: indicates whether ClassicLink is enabled
returned: always
sample: null
type: NoneType
dhcp_options_id:
description: the id of the DHCP options assocaited with this VPC
returned: always
sample: dopt-0fb8bd6b
type: string
id:
description: VPC resource id
returned: always
sample: vpc-c2e00da5
type: string
instance_tenancy:
description: indicates whether VPC uses default or dedicated tenancy
returned: always
sample: default
type: string
is_default:
description: indicates whether this is the default VPC
returned: always
sample: false
type: bool
state:
description: state of the VPC
returned: always
sample: available
type: string
tags:
contains:
Name:
description: name tag for the VPC
returned: always
sample: pk_vpc4
type: string
description: tags attached to the VPC, includes name
returned: always
type: complex
description: info about the VPC that was created or deleted
returned: always
type: complex