amazon.aws.ec2_vpc_subnet module – Manage subnets in AWS virtual private clouds
Note
This module is part of the amazon.aws collection (version 3.5.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install amazon.aws
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: amazon.aws.ec2_vpc_subnet
.
New in amazon.aws 1.0.0
Synopsis
Manage subnets in AWS virtual private clouds.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.6
boto3 >= 1.16.0
botocore >= 1.19.0
Parameters
Parameter |
Comments |
---|---|
Specify Choices:
|
|
If profile is set this parameter is ignored. Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. |
|
The location of a CA Bundle to use when validating SSL certificates. Not used by boto 2 based modules. Note: The CA Bundle is read ‘module’ side and may need to be explicitly copied from the controller if not run locally. |
|
A dictionary to modify the botocore configuration. Parameters can be found at https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Only the ‘user_agent’ key is used for boto modules. See http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration. |
|
If profile is set this parameter is ignored. Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. |
|
The availability zone for the subnet. |
|
The CIDR block for the subnet. E.g. 192.0.2.0/24. |
|
Use a botocore.endpoint logger to parse the unique (rather than total) “resource:action” API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used. Choices:
|
|
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. |
|
The IPv6 CIDR block for the subnet. The VPC must have a /56 block assigned and this value must be a valid IPv6 /64 that falls in the VPC range. Required if assign_instances_ipv6=true |
|
Specify Choices:
|
|
Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated. aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01. |
|
Whether or not to remove tags that do not appear in the tags list. Choices:
|
|
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 |
|
If profile is set this parameter is ignored. Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. Aliases aws_session_token and session_token have been added in version 3.2.0. |
|
Create or remove the subnet. Choices:
|
|
A dict of tags to apply to the subnet. Any tags currently applied to the subnet and not present here will be removed. |
|
When set to “no”, SSL certificates will not be validated for communication with the AWS APIs. Choices:
|
|
VPC ID of the VPC in which to create or delete the subnet. |
|
When wait=true and state=present, module will wait for subnet to be in available state before continuing. Choices:
|
|
Number of seconds to wait for subnet to become available wait=True. Default: |
Notes
Note
If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence
AWS_URL
orEC2_URL
,AWS_PROFILE
orAWS_DEFAULT_PROFILE
,AWS_ACCESS_KEY_ID
orAWS_ACCESS_KEY
orEC2_ACCESS_KEY
,AWS_SECRET_ACCESS_KEY
orAWS_SECRET_KEY
orEC2_SECRET_KEY
,AWS_SECURITY_TOKEN
orEC2_SECURITY_TOKEN
,AWS_REGION
orEC2_REGION
,AWS_CA_BUNDLE
When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically
~/.aws/credentials
). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
AWS_REGION
orEC2_REGION
can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
Examples
# Note: These examples do not set authentication details, see the AWS Guide for details.
- name: Create subnet for database servers
amazon.aws.ec2_vpc_subnet:
state: present
vpc_id: vpc-123456
cidr: 10.0.1.16/28
tags:
Name: Database Subnet
register: database_subnet
- name: Remove subnet for database servers
amazon.aws.ec2_vpc_subnet:
state: absent
vpc_id: vpc-123456
cidr: 10.0.1.16/28
- name: Create subnet with IPv6 block assigned
amazon.aws.ec2_vpc_subnet:
state: present
vpc_id: vpc-123456
cidr: 10.1.100.0/24
ipv6_cidr: 2001:db8:0:102::/64
- name: Remove IPv6 block assigned to subnet
amazon.aws.ec2_vpc_subnet:
state: present
vpc_id: vpc-123456
cidr: 10.1.100.0/24
ipv6_cidr: ''
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Dictionary of subnet values Returned: state=present |
|
whether IPv6 address is auto-assigned to new instances Returned: state=present Sample: |
|
Availability zone of the Subnet Returned: state=present Sample: |
|
number of available IPv4 addresses Returned: state=present Sample: |
|
The IPv4 CIDR of the Subnet Returned: state=present Sample: |
|
indicates whether this is the default Subnet for this Availability Zone Returned: state=present Sample: |
|
Subnet resource id Returned: state=present Sample: |
|
The IPv6 association ID for the currently associated CIDR Returned: state=present Sample: |
|
The IPv6 CIDR block actively associated with the Subnet Returned: state=present Sample: |
|
An array of IPv6 cidr block association set information. Returned: state=present |
|
The association ID Returned: always |
|
The IPv6 CIDR block that is associated with the subnet. Returned: always |
|
A hash/dict that contains a single item. The state of the cidr block association. Returned: always |
|
The CIDR block association state. Returned: always |
|
whether public IP is auto-assigned to new instances Returned: state=present Sample: |
|
state of the Subnet Returned: state=present Sample: |
|
tags attached to the Subnet, includes name Returned: state=present Sample: |
|
the id of the VPC where this Subnet exists Returned: state=present Sample: |