amazon.aws.ec2_vpc_subnet_info module – Gather information about EC2 VPC subnets in AWS

Note

This module is part of the amazon.aws collection (version 9.0.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_info.

New in amazon.aws 1.0.0

Synopsis

  • Gather information about EC2 VPC subnets in AWS.

Requirements

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

  • python >= 3.6

  • boto3 >= 1.28.0

  • botocore >= 1.31.0

Parameters

Parameter

Comments

access_key

aliases: aws_access_key_id, aws_access_key, ec2_access_key

string

AWS access key ID.

See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

The AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variables may also be used in decreasing order of preference.

The aws_access_key and profile options are mutually exclusive.

The aws_access_key_id alias was added in release 5.1.0 for consistency with the AWS botocore SDK.

The ec2_access_key alias has been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_ACCESS_KEY environment variable has been deprecated and will be removed in a release after 2024-12-01.

aws_ca_bundle

path

The location of a CA Bundle to use when validating SSL certificates.

The AWS_CA_BUNDLE environment variable may also be used.

aws_config

dictionary

A dictionary to modify the botocore configuration.

Parameters can be found in the AWS documentation https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

debug_botocore_endpoint_logs

boolean

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:

  • false ← (default)

  • true

endpoint_url

aliases: ec2_url, aws_endpoint_url, s3_url

string

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 AWS_URL or EC2_URL environment variables may also be used, in decreasing order of preference.

The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_URL environment variable has been deprecated and will be removed in a release after 2024-12-01.

filters

dictionary

A dict of filters to apply. Each dict item consists of a filter key and a filter value. See https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSubnets.html for possible filters.

Default: {}

profile

aliases: aws_profile

string

A named AWS profile to use for authentication.

See the AWS documentation for more information about named profiles https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html.

The AWS_PROFILE environment variable may also be used.

The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.

region

aliases: aws_region, ec2_region

string

The AWS region to use.

For global services such as IAM, Route53 and CloudFront, region is ignored.

The AWS_REGION or EC2_REGION environment variables may also be used.

See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

The ec2_region alias has been deprecated and will be removed in a release after 2024-12-01

Support for the EC2_REGION environment variable has been deprecated and will be removed in a release after 2024-12-01.

secret_key

aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key

string

AWS secret access key.

See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

The AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variables may also be used in decreasing order of preference.

The secret_key and profile options are mutually exclusive.

The aws_secret_access_key alias was added in release 5.1.0 for consistency with the AWS botocore SDK.

The ec2_secret_key alias has been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_SECRET_KEY environment variable has been deprecated and will be removed in a release after 2024-12-01.

session_token

aliases: aws_session_token, security_token, aws_security_token, access_token

string

AWS STS session token for use with temporary credentials.

See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

The AWS_SESSION_TOKEN, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variables may also be used in decreasing order of preference.

The security_token and profile options are mutually exclusive.

Aliases aws_session_token and session_token were added in release 3.2.0, with the parameter being renamed from security_token to session_token in release 6.0.0.

The security_token, aws_security_token, and access_token aliases have been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_SECRET_KEY and AWS_SECURITY_TOKEN environment variables has been deprecated and will be removed in a release after 2024-12-01.

subnet_ids

aliases: subnet_id

list / elements=string

A list of subnet IDs to gather information for.

Default: []

validate_certs

boolean

When set to false, SSL certificates will not be validated for communication with the AWS APIs.

Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead.

Choices:

  • false

  • true ← (default)

Notes

Note

  • Caution: For modules, environment variables and configuration files are read from the Ansible ‘host’ context and not the ‘controller’ context. As such, files may need to be explicitly copied to the ‘host’. For lookup and connection plugins, environment variables and configuration files are read from the Ansible ‘controller’ context and not the ‘host’ context.

  • The AWS SDK (boto3) that Ansible uses may also read defaults for credentials and other settings, such as the region, from its configuration files in the Ansible ‘host’ context (typically ~/.aws/credentials). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.

Examples

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

# Gather information about all VPC subnets
- amazon.aws.ec2_vpc_subnet_info:

# Gather information about a particular VPC subnet using ID
- amazon.aws.ec2_vpc_subnet_info:
    subnet_ids: subnet-00112233

# Gather information about any VPC subnet with a tag key Name and value Example
- amazon.aws.ec2_vpc_subnet_info:
    filters:
      "tag:Name": Example

# Gather information about any VPC subnet within VPC with ID vpc-abcdef00
- amazon.aws.ec2_vpc_subnet_info:
    filters:
      vpc-id: vpc-abcdef00

# Gather information about a set of VPC subnets, publicA, publicB and publicC within a
# VPC with ID vpc-abcdef00 and then use the jinja map function to return the
# subnet_ids as a list.

- amazon.aws.ec2_vpc_subnet_info:
    filters:
      vpc-id: vpc-abcdef00
      "tag:Name": "{{ item }}"
  loop:
    - publicA
    - publicB
    - publicC
  register: subnet_info

- set_fact:
    subnet_ids: "{{ subnet_info.results | sum(attribute='subnets', start=[]) | map(attribute='subnet_id') }}"

Return Values

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

Key

Description

subnets

complex

Returns an array of complex objects as described below.

Returned: success

assign_ipv6_address_on_creation

boolean

whether IPv6 address is auto-assigned to new instances.

Returned: always

Sample: false

availability_zone

string

Availability zone of the Subnet.

Returned: always

Sample: "us-east-1a"

availability_zone_id

string

The AZ ID of the subnet.

Returned: always

Sample: "use1-az6"

available_ip_address_count

string

number of available IPv4 addresses.

Returned: always

Sample: "251"

cidr_block

string

The IPv4 CIDR of the Subnet.

Returned: always

Sample: "10.0.0.0/16"

default_for_az

boolean

indicates whether this is the default Subnet for this Availability Zone.

Returned: always

Sample: false

enable_dns64

boolean

Indicates whether DNS queries made should return synthetic IPv6 addresses for IPv4-only destinations.

Returned: success

Sample: false

id

string

Subnet resource id.

Returned: always

Sample: "subnet-b883b2c4"

ipv6_association_id

string

The IPv6 association ID for the currently associated CIDR.

Returned: always

Sample: "subnet-cidr-assoc-b85c74d2"

ipv6_cidr_block

string

The IPv6 CIDR block actively associated with the Subnet.

Returned: always

Sample: "2001:db8:0:102::/64"

ipv6_cidr_block_association_set

complex

An array of IPv6 cidr block association set information.

Returned: always

association_id

string

The association ID.

Returned: always

ipv6_cidr_block

string

The IPv6 CIDR block that is associated with the subnet.

Returned: always

ipv6_cidr_block_state

dictionary

A hash/dict that contains a single item. The state of the cidr block association.

Returned: always

state

string

The CIDR block association state.

Returned: always

ipv6_native

boolean

Indicates whether this is an IPv6 only subnet.

Returned: success

Sample: false

map_customer_owned_ip_on_launch

boolean

Indicates whether a network interface receives a customer-owned IPv4 address.

Returned: success

Sample: "flase"

map_public_ip_on_launch

boolean

whether public IP is auto-assigned to new instances.

Returned: always

Sample: false

owner_id

string

The ID of the Amazon Web Services account that owns the subnet.

Returned: success

Sample: "12344567"

private_dns_name_options_on_launch

dictionary

The type of hostnames to assign to instances in the subnet at launch.

An instance hostname is based on the IPv4 address or ID of the instance.

Returned: success

Sample: {"enable_resource_name_dns_a_record": false, "enable_resource_name_dns_aaaa_record": false, "hostname_type": "ip-name"}

state

string

state of the Subnet.

Returned: always

Sample: "available"

subnet_arn

string

The Amazon Resource Name (ARN) of the subnet.

Returned: success

Sample: "arn:aws:ec2:us-east-1:xxx:subnet/subnet-xxx"

subnet_id

string

The ID of the Subnet.

Returned: always

tags

dictionary

tags attached to the Subnet, includes name.

Returned: always

Sample: {"Name": "My Subnet", "env": "staging"}

vpc_id

string

the id of the VPC where this Subnet exists.

Returned: always

Sample: "vpc-67236184"

Authors

  • Rob White (@wimnat)