secondary_interfaces

Creates, updates, deletes, gets or lists a secondary_interfaces resource.

Overview

Name	secondary_interfaces
Type	Resource
Id	aws.ec2.secondary_interfaces

Fields

The following fields are returned by SELECT queries:

describe_secondary_interfaces

Name	Datatype	Description
attachment	string	The attachment information for the secondary interface.
availability_zone	string	The Availability Zone of the secondary interface.
availability_zone_id	string	The ID of the Availability Zone of the secondary interface.
mac_address	string	The MAC address of the secondary interface.
owner_id	string	The ID of the Amazon Web Services account that owns the secondary interface.
private_ipv_4_addresses	string	The private IPv4 addresses associated with the secondary interface.
secondary_interface_arn	string	The Amazon Resource Name (ARN) of the secondary interface.
secondary_interface_id	string	The ID of the secondary interface.
secondary_interface_type	string	The type of secondary interface.
secondary_network_id	string	The ID of the secondary network.
secondary_network_type	string	The type of the secondary network.
secondary_subnet_id	string	The ID of the secondary subnet.
source_dest_check	boolean	Indicates whether source/destination checking is enabled.
status	string	The status of the secondary interface.
tags	string	The tags assigned to the secondary interface.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_secondary_interfaces	select	region	DryRun, Filter, MaxResults, NextToken, SecondaryInterfaceId	Describes one or more of your secondary interfaces.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
DryRun	boolean	Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Filter	array	The filters. attachment.attachment-id - The ID of the secondary interface attachment. attachment.instance-id - The ID of the instance to which the secondary interface is attached. attachment.instance-owner-id - The ID of the Amazon Web Services account that owns the instance to which the secondary interface is attached. attachment.status - The attachment status (attaching | attached | detaching | detached). private-ipv4-addresses.private-ip-address - The private IPv4 address associated with the secondary interface. owner-id - The ID of the Amazon Web Services account that owns the secondary interface. secondary-interface-arn - The ARN of the secondary interface. secondary-interface-id - The ID of the secondary interface. secondary-interface-type - The type of secondary interface (secondary). secondary-network-id - The ID of the secondary network. secondary-network-type - The type of the secondary network (rdma). secondary-subnet-id - The ID of the secondary subnet. status - The status of the secondary interface (available | in-use). tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
MaxResults	integer	The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
NextToken	string	The token for the next page of results.
SecondaryInterfaceId	array	The IDs of the secondary interfaces.

SELECT examples

describe_secondary_interfaces

Describes one or more of your secondary interfaces.

SELECT
attachment,
availability_zone,
availability_zone_id,
mac_address,
owner_id,
private_ipv_4_addresses,
secondary_interface_arn,
secondary_interface_id,
secondary_interface_type,
secondary_network_id,
secondary_network_type,
secondary_subnet_id,
source_dest_check,
status,
tags
FROM aws.ec2.secondary_interfaces
WHERE region = '{{ region }}' -- required
AND DryRun = '{{ DryRun }}'
AND Filter = '{{ Filter }}'
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
AND SecondaryInterfaceId = '{{ SecondaryInterfaceId }}'
;