ec2_internet_gateway_info – List EC2 Internet Gateways¶
Retrieve information about AWS EC2 Internet Gateways.
Examples¶
- name: List all internet gateways in the region
ec2_internet_gateway_info:
- name: List only specific internet gateways
ec2_internet_gateway_info:
ids:
- igw-13a244t23
- igw-a862nf0sd
- name: List the internet gateway attached to a VPC
ec2_internet_gateway_info:
vpc: vpc-2jdb5kd83fs
See Also¶
Parameters¶
- auth (optional)
Parameters for authenticating with the AWS service. Each of them may be defined via environment variables.
type: dict- access_key (optional)
The AWS access key ID. If not set, the value of the AWS_ACCESS_KEY environment variable will be checked.
Mutually exclusive with profile.
type: str- profile (optional)
The name of the AWS profile configured with
aws configure
.Can be used instead of explicitly specifying your access credentials and region.
Use
default
to use the default profile.Mutually exclusive with access_key and secret_key.
type: str- region (optional)
The name of the AWS region.
If not set, the value of the AWS_REGION environment variable will be checked.
If you set a profile that specifies a default region, that region is used and you can omit this parameter. Use this parameter to override the profile’s default region.
type: str- secret_key (optional)
The AWS secret access key. If not set, the value of the AWS_SECRET_KEY environment variable will be checked.
Mutually exclusive with profile.
type: str- url (optional)
The URL to the AWS service related to the resource. By default, this is automatically determined through the region parameter.
If not set explicitly, the value of the AWS_<SERVICE>_URL environment variable will be used.
The services currently supported are EC2 and S3.
type: str
- filters (optional)
Filters to use when querying AWS resources. They must be provided as key/value pairs.
Keys and values are case-sensitive and must be strings.
Each key can have multiple values, provided as a list. Within these values, any value must match for the AWS resource to be included.
When multiple filters are provided, the result contains AWS resources matching all of them.
If a filter is specified in
filters
and also in another top-level parameter, the filter in the top-level parameter has precedence. The two are not merged.If a module accepts a top-level parameter for querying the AWS resources, and you also specify the filter it corresponds to via
filters
, the top-level parameter has precedence.type: dict- ids (optional)
Perform the operation for the specified resources.
type: list- names (optional)
Limit the results to the resources with specified names.
type: list- vpc (optional)
ID of the VPC to which the internet gateway is attached.
type: str
Return Values¶
- objects (success), list,
A list of objects representing EC2 Internet Gateways.
- id (always), str, igw-841b9271gd
ID of the internet gateway
- vpc (always), str, vpc-2w7hs924hs
ID of the VPC the internet gateway is attached to, or None.
- tags (always), dict, {‘environment’: ‘staging’, ‘Name’: ‘my-gateway’}
Tags associated with the internet gateway.