com.amazonaws.services.ec2.model.DescribeNetworkInterfacesRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.ec2.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
import com.amazonaws.Request;
import com.amazonaws.services.ec2.model.transform.DescribeNetworkInterfacesRequestMarshaller;
/**
*
* Contains the parameters for DescribeNetworkInterfaces.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeNetworkInterfacesRequest extends AmazonWebServiceRequest implements Serializable, Cloneable,
DryRunSupportedRequest {
/**
*
* One or more filters.
*
*
* -
*
* association.allocation-id - The allocation ID returned when you allocated the Elastic IP address
* (IPv4) for your network interface.
*
*
* -
*
* association.association-id - The association ID returned when the network interface was associated
* with an IPv4 address.
*
*
* -
*
* addresses.association.owner-id - The owner ID of the addresses associated with the network
* interface.
*
*
* -
*
* addresses.association.public-ip - The association ID returned when the network interface was
* associated with the Elastic IP address (IPv4).
*
*
* -
*
* addresses.primary - Whether the private IPv4 address is the primary IP address associated with the
* network interface.
*
*
* -
*
* addresses.private-ip-address - The private IPv4 addresses associated with the network interface.
*
*
* -
*
* association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network
* interface.
*
*
* -
*
* association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.
*
*
* -
*
* association.public-dns-name - The public DNS name for the network interface (IPv4).
*
*
* -
*
* attachment.attach-time - The time that the network interface was attached to an instance.
*
*
* -
*
* attachment.attachment-id - The ID of the interface attachment.
*
*
* -
*
* attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is
* terminated.
*
*
* -
*
* attachment.device-index - The device index to which the network interface is attached.
*
*
* -
*
* attachment.instance-id - The ID of the instance to which the network interface is attached.
*
*
* -
*
* attachment.instance-owner-id - The owner ID of the instance to which the network interface is
* attached.
*
*
* -
*
* attachment.status - The status of the attachment (attaching | attached |
* detaching | detached).
*
*
* -
*
* availability-zone - The Availability Zone of the network interface.
*
*
* -
*
* description - The description of the network interface.
*
*
* -
*
* group-id - The ID of a security group associated with the network interface.
*
*
* -
*
* ipv6-addresses.ipv6-address - An IPv6 address associated with the network interface.
*
*
* -
*
* interface-type - The type of network interface (api_gateway_managed |
* aws_codestar_connections_managed | branch | ec2_instance_connect_endpoint
* | efa | efs | gateway_load_balancer |
* gateway_load_balancer_endpoint | global_accelerator_managed | interface |
* iot_rules_managed | lambda | load_balancer | nat_gateway |
* network_load_balancer | quicksight | transit_gateway | trunk
* | vpc_endpoint).
*
*
* -
*
* mac-address - The MAC address of the network interface.
*
*
* -
*
* network-interface-id - The ID of the network interface.
*
*
* -
*
* owner-id - The Amazon Web Services account ID of the network interface owner.
*
*
* -
*
* private-dns-name - The private DNS name of the network interface (IPv4).
*
*
* -
*
* private-ip-address - The private IPv4 address or addresses of the network interface.
*
*
* -
*
* requester-id - The alias or Amazon Web Services account ID of the principal or service that created
* the network interface.
*
*
* -
*
* requester-managed - Indicates whether the network interface is being managed by an Amazon Web
* Service (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
*
*
* -
*
* source-dest-check - Indicates whether the network interface performs source/destination checking. A
* value of true means checking is enabled, and false means checking is disabled. The
* value must be false for the network interface to perform network address translation (NAT) in your
* VPC.
*
*
* -
*
* status - The status of the network interface. If the network interface is not attached to an
* instance, the status is available; if a network interface is attached to an instance the status is
* in-use.
*
*
* -
*
* subnet-id - The ID of the subnet for the network interface.
*
*
* -
*
* 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.
*
*
* -
*
* vpc-id - The ID of the VPC for the network interface.
*
*
*
*/
private com.amazonaws.internal.SdkInternalList filters;
/**
*
* The network interface IDs.
*
*
* Default: Describes all your network interfaces.
*
*/
private com.amazonaws.internal.SdkInternalList networkInterfaceIds;
/**
*
* The token returned from a previous paginated request. Pagination continues from the end of the items returned by
* the previous request.
*
*/
private String nextToken;
/**
*
* The maximum number of items to return for this request. To get the next page of items, make another request with
* the token returned in the output. You cannot specify this parameter and the network interface IDs parameter in
* the same request. For more information, see Pagination.
*
*/
private Integer maxResults;
/**
*
* One or more filters.
*
*
* -
*
* association.allocation-id - The allocation ID returned when you allocated the Elastic IP address
* (IPv4) for your network interface.
*
*
* -
*
* association.association-id - The association ID returned when the network interface was associated
* with an IPv4 address.
*
*
* -
*
* addresses.association.owner-id - The owner ID of the addresses associated with the network
* interface.
*
*
* -
*
* addresses.association.public-ip - The association ID returned when the network interface was
* associated with the Elastic IP address (IPv4).
*
*
* -
*
* addresses.primary - Whether the private IPv4 address is the primary IP address associated with the
* network interface.
*
*
* -
*
* addresses.private-ip-address - The private IPv4 addresses associated with the network interface.
*
*
* -
*
* association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network
* interface.
*
*
* -
*
* association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.
*
*
* -
*
* association.public-dns-name - The public DNS name for the network interface (IPv4).
*
*
* -
*
* attachment.attach-time - The time that the network interface was attached to an instance.
*
*
* -
*
* attachment.attachment-id - The ID of the interface attachment.
*
*
* -
*
* attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is
* terminated.
*
*
* -
*
* attachment.device-index - The device index to which the network interface is attached.
*
*
* -
*
* attachment.instance-id - The ID of the instance to which the network interface is attached.
*
*
* -
*
* attachment.instance-owner-id - The owner ID of the instance to which the network interface is
* attached.
*
*
* -
*
* attachment.status - The status of the attachment (attaching | attached |
* detaching | detached).
*
*
* -
*
* availability-zone - The Availability Zone of the network interface.
*
*
* -
*
* description - The description of the network interface.
*
*
* -
*
* group-id - The ID of a security group associated with the network interface.
*
*
* -
*
* ipv6-addresses.ipv6-address - An IPv6 address associated with the network interface.
*
*
* -
*
* interface-type - The type of network interface (api_gateway_managed |
* aws_codestar_connections_managed | branch | ec2_instance_connect_endpoint
* | efa | efs | gateway_load_balancer |
* gateway_load_balancer_endpoint | global_accelerator_managed | interface |
* iot_rules_managed | lambda | load_balancer | nat_gateway |
* network_load_balancer | quicksight | transit_gateway | trunk
* | vpc_endpoint).
*
*
* -
*
* mac-address - The MAC address of the network interface.
*
*
* -
*
* network-interface-id - The ID of the network interface.
*
*
* -
*
* owner-id - The Amazon Web Services account ID of the network interface owner.
*
*
* -
*
* private-dns-name - The private DNS name of the network interface (IPv4).
*
*
* -
*
* private-ip-address - The private IPv4 address or addresses of the network interface.
*
*
* -
*
* requester-id - The alias or Amazon Web Services account ID of the principal or service that created
* the network interface.
*
*
* -
*
* requester-managed - Indicates whether the network interface is being managed by an Amazon Web
* Service (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
*
*
* -
*
* source-dest-check - Indicates whether the network interface performs source/destination checking. A
* value of true means checking is enabled, and false means checking is disabled. The
* value must be false for the network interface to perform network address translation (NAT) in your
* VPC.
*
*
* -
*
* status - The status of the network interface. If the network interface is not attached to an
* instance, the status is available; if a network interface is attached to an instance the status is
* in-use.
*
*
* -
*
* subnet-id - The ID of the subnet for the network interface.
*
*
* -
*
* 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.
*
*
* -
*
* vpc-id - The ID of the VPC for the network interface.
*
*
*
*
* @return One or more filters.
*
* -
*
* association.allocation-id - The allocation ID returned when you allocated the Elastic IP
* address (IPv4) for your network interface.
*
*
* -
*
* association.association-id - The association ID returned when the network interface was
* associated with an IPv4 address.
*
*
* -
*
* addresses.association.owner-id - The owner ID of the addresses associated with the network
* interface.
*
*
* -
*
* addresses.association.public-ip - The association ID returned when the network interface was
* associated with the Elastic IP address (IPv4).
*
*
* -
*
* addresses.primary - Whether the private IPv4 address is the primary IP address associated
* with the network interface.
*
*
* -
*
* addresses.private-ip-address - The private IPv4 addresses associated with the network
* interface.
*
*
* -
*
* association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the
* network interface.
*
*
* -
*
* association.public-ip - The address of the Elastic IP address (IPv4) bound to the network
* interface.
*
*
* -
*
* association.public-dns-name - The public DNS name for the network interface (IPv4).
*
*
* -
*
* attachment.attach-time - The time that the network interface was attached to an instance.
*
*
* -
*
* attachment.attachment-id - The ID of the interface attachment.
*
*
* -
*
* attachment.delete-on-termination - Indicates whether the attachment is deleted when an
* instance is terminated.
*
*
* -
*
* attachment.device-index - The device index to which the network interface is attached.
*
*
* -
*
* attachment.instance-id - The ID of the instance to which the network interface is attached.
*
*
* -
*
* attachment.instance-owner-id - The owner ID of the instance to which the network interface
* is attached.
*
*
* -
*
* attachment.status - The status of the attachment (attaching |
* attached | detaching | detached).
*
*
* -
*
* availability-zone - The Availability Zone of the network interface.
*
*
* -
*
* description - The description of the network interface.
*
*
* -
*
* group-id - The ID of a security group associated with the network interface.
*
*
* -
*
* ipv6-addresses.ipv6-address - An IPv6 address associated with the network interface.
*
*
* -
*
* interface-type - The type of network interface (api_gateway_managed |
* aws_codestar_connections_managed | branch |
* ec2_instance_connect_endpoint | efa | efs |
* gateway_load_balancer | gateway_load_balancer_endpoint |
* global_accelerator_managed | interface | iot_rules_managed |
* lambda | load_balancer | nat_gateway |
* network_load_balancer | quicksight | transit_gateway |
* trunk | vpc_endpoint).
*
*
* -
*
* mac-address - The MAC address of the network interface.
*
*
* -
*
* network-interface-id - The ID of the network interface.
*
*
* -
*
* owner-id - The Amazon Web Services account ID of the network interface owner.
*
*
* -
*
* private-dns-name - The private DNS name of the network interface (IPv4).
*
*
* -
*
* private-ip-address - The private IPv4 address or addresses of the network interface.
*
*
* -
*
* requester-id - The alias or Amazon Web Services account ID of the principal or service that
* created the network interface.
*
*
* -
*
* requester-managed - Indicates whether the network interface is being managed by an Amazon
* Web Service (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
*
*
* -
*
* source-dest-check - Indicates whether the network interface performs source/destination
* checking. A value of true means checking is enabled, and false means checking
* is disabled. The value must be false for the network interface to perform network address
* translation (NAT) in your VPC.
*
*
* -
*
* status - The status of the network interface. If the network interface is not attached to an
* instance, the status is available; if a network interface is attached to an instance the
* status is in-use.
*
*
* -
*
* subnet-id - The ID of the subnet for the network interface.
*
*
* -
*
* 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.
*
*
* -
*
* vpc-id - The ID of the VPC for the network interface.
*
*
*/
public java.util.List getFilters() {
if (filters == null) {
filters = new com.amazonaws.internal.SdkInternalList();
}
return filters;
}
/**
*
* One or more filters.
*
*
* -
*
* association.allocation-id - The allocation ID returned when you allocated the Elastic IP address
* (IPv4) for your network interface.
*
*
* -
*
* association.association-id - The association ID returned when the network interface was associated
* with an IPv4 address.
*
*
* -
*
* addresses.association.owner-id - The owner ID of the addresses associated with the network
* interface.
*
*
* -
*
* addresses.association.public-ip - The association ID returned when the network interface was
* associated with the Elastic IP address (IPv4).
*
*
* -
*
* addresses.primary - Whether the private IPv4 address is the primary IP address associated with the
* network interface.
*
*
* -
*
* addresses.private-ip-address - The private IPv4 addresses associated with the network interface.
*
*
* -
*
* association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network
* interface.
*
*
* -
*
* association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.
*
*
* -
*
* association.public-dns-name - The public DNS name for the network interface (IPv4).
*
*
* -
*
* attachment.attach-time - The time that the network interface was attached to an instance.
*
*
* -
*
* attachment.attachment-id - The ID of the interface attachment.
*
*
* -
*
* attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is
* terminated.
*
*
* -
*
* attachment.device-index - The device index to which the network interface is attached.
*
*
* -
*
* attachment.instance-id - The ID of the instance to which the network interface is attached.
*
*
* -
*
* attachment.instance-owner-id - The owner ID of the instance to which the network interface is
* attached.
*
*
* -
*
* attachment.status - The status of the attachment (attaching | attached |
* detaching | detached).
*
*
* -
*
* availability-zone - The Availability Zone of the network interface.
*
*
* -
*
* description - The description of the network interface.
*
*
* -
*
* group-id - The ID of a security group associated with the network interface.
*
*
* -
*
* ipv6-addresses.ipv6-address - An IPv6 address associated with the network interface.
*
*
* -
*
* interface-type - The type of network interface (api_gateway_managed |
* aws_codestar_connections_managed | branch | ec2_instance_connect_endpoint
* | efa | efs | gateway_load_balancer |
* gateway_load_balancer_endpoint | global_accelerator_managed | interface |
* iot_rules_managed | lambda | load_balancer | nat_gateway |
* network_load_balancer | quicksight | transit_gateway | trunk
* | vpc_endpoint).
*
*
* -
*
* mac-address - The MAC address of the network interface.
*
*
* -
*
* network-interface-id - The ID of the network interface.
*
*
* -
*
* owner-id - The Amazon Web Services account ID of the network interface owner.
*
*
* -
*
* private-dns-name - The private DNS name of the network interface (IPv4).
*
*
* -
*
* private-ip-address - The private IPv4 address or addresses of the network interface.
*
*
* -
*
* requester-id - The alias or Amazon Web Services account ID of the principal or service that created
* the network interface.
*
*
* -
*
* requester-managed - Indicates whether the network interface is being managed by an Amazon Web
* Service (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
*
*
* -
*
* source-dest-check - Indicates whether the network interface performs source/destination checking. A
* value of true means checking is enabled, and false means checking is disabled. The
* value must be false for the network interface to perform network address translation (NAT) in your
* VPC.
*
*
* -
*
* status - The status of the network interface. If the network interface is not attached to an
* instance, the status is available; if a network interface is attached to an instance the status is
* in-use.
*
*
* -
*
* subnet-id - The ID of the subnet for the network interface.
*
*
* -
*
* 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.
*
*
* -
*
* vpc-id - The ID of the VPC for the network interface.
*
*
*
*
* @param filters
* One or more filters.
*
* -
*
* association.allocation-id - The allocation ID returned when you allocated the Elastic IP
* address (IPv4) for your network interface.
*
*
* -
*
* association.association-id - The association ID returned when the network interface was
* associated with an IPv4 address.
*
*
* -
*
* addresses.association.owner-id - The owner ID of the addresses associated with the network
* interface.
*
*
* -
*
* addresses.association.public-ip - The association ID returned when the network interface was
* associated with the Elastic IP address (IPv4).
*
*
* -
*
* addresses.primary - Whether the private IPv4 address is the primary IP address associated
* with the network interface.
*
*
* -
*
* addresses.private-ip-address - The private IPv4 addresses associated with the network
* interface.
*
*
* -
*
* association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the
* network interface.
*
*
* -
*
* association.public-ip - The address of the Elastic IP address (IPv4) bound to the network
* interface.
*
*
* -
*
* association.public-dns-name - The public DNS name for the network interface (IPv4).
*
*
* -
*
* attachment.attach-time - The time that the network interface was attached to an instance.
*
*
* -
*
* attachment.attachment-id - The ID of the interface attachment.
*
*
* -
*
* attachment.delete-on-termination - Indicates whether the attachment is deleted when an
* instance is terminated.
*
*
* -
*
* attachment.device-index - The device index to which the network interface is attached.
*
*
* -
*
* attachment.instance-id - The ID of the instance to which the network interface is attached.
*
*
* -
*
* attachment.instance-owner-id - The owner ID of the instance to which the network interface is
* attached.
*
*
* -
*
* attachment.status - The status of the attachment (attaching |
* attached | detaching | detached).
*
*
* -
*
* availability-zone - The Availability Zone of the network interface.
*
*
* -
*
* description - The description of the network interface.
*
*
* -
*
* group-id - The ID of a security group associated with the network interface.
*
*
* -
*
* ipv6-addresses.ipv6-address - An IPv6 address associated with the network interface.
*
*
* -
*
* interface-type - The type of network interface (api_gateway_managed |
* aws_codestar_connections_managed | branch |
* ec2_instance_connect_endpoint | efa | efs |
* gateway_load_balancer | gateway_load_balancer_endpoint |
* global_accelerator_managed | interface | iot_rules_managed |
* lambda | load_balancer | nat_gateway |
* network_load_balancer | quicksight | transit_gateway |
* trunk | vpc_endpoint).
*
*
* -
*
* mac-address - The MAC address of the network interface.
*
*
* -
*
* network-interface-id - The ID of the network interface.
*
*
* -
*
* owner-id - The Amazon Web Services account ID of the network interface owner.
*
*
* -
*
* private-dns-name - The private DNS name of the network interface (IPv4).
*
*
* -
*
* private-ip-address - The private IPv4 address or addresses of the network interface.
*
*
* -
*
* requester-id - The alias or Amazon Web Services account ID of the principal or service that
* created the network interface.
*
*
* -
*
* requester-managed - Indicates whether the network interface is being managed by an Amazon Web
* Service (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
*
*
* -
*
* source-dest-check - Indicates whether the network interface performs source/destination
* checking. A value of true means checking is enabled, and false means checking is
* disabled. The value must be false for the network interface to perform network address
* translation (NAT) in your VPC.
*
*
* -
*
* status - The status of the network interface. If the network interface is not attached to an
* instance, the status is available; if a network interface is attached to an instance the
* status is in-use.
*
*
* -
*
* subnet-id - The ID of the subnet for the network interface.
*
*
* -
*
* 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.
*
*
* -
*
* vpc-id - The ID of the VPC for the network interface.
*
*
*/
public void setFilters(java.util.Collection filters) {
if (filters == null) {
this.filters = null;
return;
}
this.filters = new com.amazonaws.internal.SdkInternalList(filters);
}
/**
*
* One or more filters.
*
*
* -
*
* association.allocation-id - The allocation ID returned when you allocated the Elastic IP address
* (IPv4) for your network interface.
*
*
* -
*
* association.association-id - The association ID returned when the network interface was associated
* with an IPv4 address.
*
*
* -
*
* addresses.association.owner-id - The owner ID of the addresses associated with the network
* interface.
*
*
* -
*
* addresses.association.public-ip - The association ID returned when the network interface was
* associated with the Elastic IP address (IPv4).
*
*
* -
*
* addresses.primary - Whether the private IPv4 address is the primary IP address associated with the
* network interface.
*
*
* -
*
* addresses.private-ip-address - The private IPv4 addresses associated with the network interface.
*
*
* -
*
* association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network
* interface.
*
*
* -
*
* association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.
*
*
* -
*
* association.public-dns-name - The public DNS name for the network interface (IPv4).
*
*
* -
*
* attachment.attach-time - The time that the network interface was attached to an instance.
*
*
* -
*
* attachment.attachment-id - The ID of the interface attachment.
*
*
* -
*
* attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is
* terminated.
*
*
* -
*
* attachment.device-index - The device index to which the network interface is attached.
*
*
* -
*
* attachment.instance-id - The ID of the instance to which the network interface is attached.
*
*
* -
*
* attachment.instance-owner-id - The owner ID of the instance to which the network interface is
* attached.
*
*
* -
*
* attachment.status - The status of the attachment (attaching | attached |
* detaching | detached).
*
*
* -
*
* availability-zone - The Availability Zone of the network interface.
*
*
* -
*
* description - The description of the network interface.
*
*
* -
*
* group-id - The ID of a security group associated with the network interface.
*
*
* -
*
* ipv6-addresses.ipv6-address - An IPv6 address associated with the network interface.
*
*
* -
*
* interface-type - The type of network interface (api_gateway_managed |
* aws_codestar_connections_managed | branch | ec2_instance_connect_endpoint
* | efa | efs | gateway_load_balancer |
* gateway_load_balancer_endpoint | global_accelerator_managed | interface |
* iot_rules_managed | lambda | load_balancer | nat_gateway |
* network_load_balancer | quicksight | transit_gateway | trunk
* | vpc_endpoint).
*
*
* -
*
* mac-address - The MAC address of the network interface.
*
*
* -
*
* network-interface-id - The ID of the network interface.
*
*
* -
*
* owner-id - The Amazon Web Services account ID of the network interface owner.
*
*
* -
*
* private-dns-name - The private DNS name of the network interface (IPv4).
*
*
* -
*
* private-ip-address - The private IPv4 address or addresses of the network interface.
*
*
* -
*
* requester-id - The alias or Amazon Web Services account ID of the principal or service that created
* the network interface.
*
*
* -
*
* requester-managed - Indicates whether the network interface is being managed by an Amazon Web
* Service (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
*
*
* -
*
* source-dest-check - Indicates whether the network interface performs source/destination checking. A
* value of true means checking is enabled, and false means checking is disabled. The
* value must be false for the network interface to perform network address translation (NAT) in your
* VPC.
*
*
* -
*
* status - The status of the network interface. If the network interface is not attached to an
* instance, the status is available; if a network interface is attached to an instance the status is
* in-use.
*
*
* -
*
* subnet-id - The ID of the subnet for the network interface.
*
*
* -
*
* 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.
*
*
* -
*
* vpc-id - The ID of the VPC for the network interface.
*
*
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setFilters(java.util.Collection)} or {@link #withFilters(java.util.Collection)} if you want to override
* the existing values.
*
*
* @param filters
* One or more filters.
*
* -
*
* association.allocation-id - The allocation ID returned when you allocated the Elastic IP
* address (IPv4) for your network interface.
*
*
* -
*
* association.association-id - The association ID returned when the network interface was
* associated with an IPv4 address.
*
*
* -
*
* addresses.association.owner-id - The owner ID of the addresses associated with the network
* interface.
*
*
* -
*
* addresses.association.public-ip - The association ID returned when the network interface was
* associated with the Elastic IP address (IPv4).
*
*
* -
*
* addresses.primary - Whether the private IPv4 address is the primary IP address associated
* with the network interface.
*
*
* -
*
* addresses.private-ip-address - The private IPv4 addresses associated with the network
* interface.
*
*
* -
*
* association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the
* network interface.
*
*
* -
*
* association.public-ip - The address of the Elastic IP address (IPv4) bound to the network
* interface.
*
*
* -
*
* association.public-dns-name - The public DNS name for the network interface (IPv4).
*
*
* -
*
* attachment.attach-time - The time that the network interface was attached to an instance.
*
*
* -
*
* attachment.attachment-id - The ID of the interface attachment.
*
*
* -
*
* attachment.delete-on-termination - Indicates whether the attachment is deleted when an
* instance is terminated.
*
*
* -
*
* attachment.device-index - The device index to which the network interface is attached.
*
*
* -
*
* attachment.instance-id - The ID of the instance to which the network interface is attached.
*
*
* -
*
* attachment.instance-owner-id - The owner ID of the instance to which the network interface is
* attached.
*
*
* -
*
* attachment.status - The status of the attachment (attaching |
* attached | detaching | detached).
*
*
* -
*
* availability-zone - The Availability Zone of the network interface.
*
*
* -
*
* description - The description of the network interface.
*
*
* -
*
* group-id - The ID of a security group associated with the network interface.
*
*
* -
*
* ipv6-addresses.ipv6-address - An IPv6 address associated with the network interface.
*
*
* -
*
* interface-type - The type of network interface (api_gateway_managed |
* aws_codestar_connections_managed | branch |
* ec2_instance_connect_endpoint | efa | efs |
* gateway_load_balancer | gateway_load_balancer_endpoint |
* global_accelerator_managed | interface | iot_rules_managed |
* lambda | load_balancer | nat_gateway |
* network_load_balancer | quicksight | transit_gateway |
* trunk | vpc_endpoint).
*
*
* -
*
* mac-address - The MAC address of the network interface.
*
*
* -
*
* network-interface-id - The ID of the network interface.
*
*
* -
*
* owner-id - The Amazon Web Services account ID of the network interface owner.
*
*
* -
*
* private-dns-name - The private DNS name of the network interface (IPv4).
*
*
* -
*
* private-ip-address - The private IPv4 address or addresses of the network interface.
*
*
* -
*
* requester-id - The alias or Amazon Web Services account ID of the principal or service that
* created the network interface.
*
*
* -
*
* requester-managed - Indicates whether the network interface is being managed by an Amazon Web
* Service (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
*
*
* -
*
* source-dest-check - Indicates whether the network interface performs source/destination
* checking. A value of true means checking is enabled, and false means checking is
* disabled. The value must be false for the network interface to perform network address
* translation (NAT) in your VPC.
*
*
* -
*
* status - The status of the network interface. If the network interface is not attached to an
* instance, the status is available; if a network interface is attached to an instance the
* status is in-use.
*
*
* -
*
* subnet-id - The ID of the subnet for the network interface.
*
*
* -
*
* 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.
*
*
* -
*
* vpc-id - The ID of the VPC for the network interface.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeNetworkInterfacesRequest withFilters(Filter... filters) {
if (this.filters == null) {
setFilters(new com.amazonaws.internal.SdkInternalList(filters.length));
}
for (Filter ele : filters) {
this.filters.add(ele);
}
return this;
}
/**
*
* One or more filters.
*
*
* -
*
* association.allocation-id - The allocation ID returned when you allocated the Elastic IP address
* (IPv4) for your network interface.
*
*
* -
*
* association.association-id - The association ID returned when the network interface was associated
* with an IPv4 address.
*
*
* -
*
* addresses.association.owner-id - The owner ID of the addresses associated with the network
* interface.
*
*
* -
*
* addresses.association.public-ip - The association ID returned when the network interface was
* associated with the Elastic IP address (IPv4).
*
*
* -
*
* addresses.primary - Whether the private IPv4 address is the primary IP address associated with the
* network interface.
*
*
* -
*
* addresses.private-ip-address - The private IPv4 addresses associated with the network interface.
*
*
* -
*
* association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network
* interface.
*
*
* -
*
* association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.
*
*
* -
*
* association.public-dns-name - The public DNS name for the network interface (IPv4).
*
*
* -
*
* attachment.attach-time - The time that the network interface was attached to an instance.
*
*
* -
*
* attachment.attachment-id - The ID of the interface attachment.
*
*
* -
*
* attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is
* terminated.
*
*
* -
*
* attachment.device-index - The device index to which the network interface is attached.
*
*
* -
*
* attachment.instance-id - The ID of the instance to which the network interface is attached.
*
*
* -
*
* attachment.instance-owner-id - The owner ID of the instance to which the network interface is
* attached.
*
*
* -
*
* attachment.status - The status of the attachment (attaching | attached |
* detaching | detached).
*
*
* -
*
* availability-zone - The Availability Zone of the network interface.
*
*
* -
*
* description - The description of the network interface.
*
*
* -
*
* group-id - The ID of a security group associated with the network interface.
*
*
* -
*
* ipv6-addresses.ipv6-address - An IPv6 address associated with the network interface.
*
*
* -
*
* interface-type - The type of network interface (api_gateway_managed |
* aws_codestar_connections_managed | branch | ec2_instance_connect_endpoint
* | efa | efs | gateway_load_balancer |
* gateway_load_balancer_endpoint | global_accelerator_managed | interface |
* iot_rules_managed | lambda | load_balancer | nat_gateway |
* network_load_balancer | quicksight | transit_gateway | trunk
* | vpc_endpoint).
*
*
* -
*
* mac-address - The MAC address of the network interface.
*
*
* -
*
* network-interface-id - The ID of the network interface.
*
*
* -
*
* owner-id - The Amazon Web Services account ID of the network interface owner.
*
*
* -
*
* private-dns-name - The private DNS name of the network interface (IPv4).
*
*
* -
*
* private-ip-address - The private IPv4 address or addresses of the network interface.
*
*
* -
*
* requester-id - The alias or Amazon Web Services account ID of the principal or service that created
* the network interface.
*
*
* -
*
* requester-managed - Indicates whether the network interface is being managed by an Amazon Web
* Service (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
*
*
* -
*
* source-dest-check - Indicates whether the network interface performs source/destination checking. A
* value of true means checking is enabled, and false means checking is disabled. The
* value must be false for the network interface to perform network address translation (NAT) in your
* VPC.
*
*
* -
*
* status - The status of the network interface. If the network interface is not attached to an
* instance, the status is available; if a network interface is attached to an instance the status is
* in-use.
*
*
* -
*
* subnet-id - The ID of the subnet for the network interface.
*
*
* -
*
* 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.
*
*
* -
*
* vpc-id - The ID of the VPC for the network interface.
*
*
*
*
* @param filters
* One or more filters.
*
* -
*
* association.allocation-id - The allocation ID returned when you allocated the Elastic IP
* address (IPv4) for your network interface.
*
*
* -
*
* association.association-id - The association ID returned when the network interface was
* associated with an IPv4 address.
*
*
* -
*
* addresses.association.owner-id - The owner ID of the addresses associated with the network
* interface.
*
*
* -
*
* addresses.association.public-ip - The association ID returned when the network interface was
* associated with the Elastic IP address (IPv4).
*
*
* -
*
* addresses.primary - Whether the private IPv4 address is the primary IP address associated
* with the network interface.
*
*
* -
*
* addresses.private-ip-address - The private IPv4 addresses associated with the network
* interface.
*
*
* -
*
* association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the
* network interface.
*
*
* -
*
* association.public-ip - The address of the Elastic IP address (IPv4) bound to the network
* interface.
*
*
* -
*
* association.public-dns-name - The public DNS name for the network interface (IPv4).
*
*
* -
*
* attachment.attach-time - The time that the network interface was attached to an instance.
*
*
* -
*
* attachment.attachment-id - The ID of the interface attachment.
*
*
* -
*
* attachment.delete-on-termination - Indicates whether the attachment is deleted when an
* instance is terminated.
*
*
* -
*
* attachment.device-index - The device index to which the network interface is attached.
*
*
* -
*
* attachment.instance-id - The ID of the instance to which the network interface is attached.
*
*
* -
*
* attachment.instance-owner-id - The owner ID of the instance to which the network interface is
* attached.
*
*
* -
*
* attachment.status - The status of the attachment (attaching |
* attached | detaching | detached).
*
*
* -
*
* availability-zone - The Availability Zone of the network interface.
*
*
* -
*
* description - The description of the network interface.
*
*
* -
*
* group-id - The ID of a security group associated with the network interface.
*
*
* -
*
* ipv6-addresses.ipv6-address - An IPv6 address associated with the network interface.
*
*
* -
*
* interface-type - The type of network interface (api_gateway_managed |
* aws_codestar_connections_managed | branch |
* ec2_instance_connect_endpoint | efa | efs |
* gateway_load_balancer | gateway_load_balancer_endpoint |
* global_accelerator_managed | interface | iot_rules_managed |
* lambda | load_balancer | nat_gateway |
* network_load_balancer | quicksight | transit_gateway |
* trunk | vpc_endpoint).
*
*
* -
*
* mac-address - The MAC address of the network interface.
*
*
* -
*
* network-interface-id - The ID of the network interface.
*
*
* -
*
* owner-id - The Amazon Web Services account ID of the network interface owner.
*
*
* -
*
* private-dns-name - The private DNS name of the network interface (IPv4).
*
*
* -
*
* private-ip-address - The private IPv4 address or addresses of the network interface.
*
*
* -
*
* requester-id - The alias or Amazon Web Services account ID of the principal or service that
* created the network interface.
*
*
* -
*
* requester-managed - Indicates whether the network interface is being managed by an Amazon Web
* Service (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
*
*
* -
*
* source-dest-check - Indicates whether the network interface performs source/destination
* checking. A value of true means checking is enabled, and false means checking is
* disabled. The value must be false for the network interface to perform network address
* translation (NAT) in your VPC.
*
*
* -
*
* status - The status of the network interface. If the network interface is not attached to an
* instance, the status is available; if a network interface is attached to an instance the
* status is in-use.
*
*
* -
*
* subnet-id - The ID of the subnet for the network interface.
*
*
* -
*
* 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.
*
*
* -
*
* vpc-id - The ID of the VPC for the network interface.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeNetworkInterfacesRequest withFilters(java.util.Collection filters) {
setFilters(filters);
return this;
}
/**
*
* The network interface IDs.
*
*
* Default: Describes all your network interfaces.
*
*
* @return The network interface IDs.
*
* Default: Describes all your network interfaces.
*/
public java.util.List getNetworkInterfaceIds() {
if (networkInterfaceIds == null) {
networkInterfaceIds = new com.amazonaws.internal.SdkInternalList();
}
return networkInterfaceIds;
}
/**
*
* The network interface IDs.
*
*
* Default: Describes all your network interfaces.
*
*
* @param networkInterfaceIds
* The network interface IDs.
*
* Default: Describes all your network interfaces.
*/
public void setNetworkInterfaceIds(java.util.Collection networkInterfaceIds) {
if (networkInterfaceIds == null) {
this.networkInterfaceIds = null;
return;
}
this.networkInterfaceIds = new com.amazonaws.internal.SdkInternalList(networkInterfaceIds);
}
/**
*
* The network interface IDs.
*
*
* Default: Describes all your network interfaces.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setNetworkInterfaceIds(java.util.Collection)} or {@link #withNetworkInterfaceIds(java.util.Collection)}
* if you want to override the existing values.
*
*
* @param networkInterfaceIds
* The network interface IDs.
*
* Default: Describes all your network interfaces.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeNetworkInterfacesRequest withNetworkInterfaceIds(String... networkInterfaceIds) {
if (this.networkInterfaceIds == null) {
setNetworkInterfaceIds(new com.amazonaws.internal.SdkInternalList(networkInterfaceIds.length));
}
for (String ele : networkInterfaceIds) {
this.networkInterfaceIds.add(ele);
}
return this;
}
/**
*
* The network interface IDs.
*
*
* Default: Describes all your network interfaces.
*
*
* @param networkInterfaceIds
* The network interface IDs.
*
* Default: Describes all your network interfaces.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeNetworkInterfacesRequest withNetworkInterfaceIds(java.util.Collection networkInterfaceIds) {
setNetworkInterfaceIds(networkInterfaceIds);
return this;
}
/**
*
* The token returned from a previous paginated request. Pagination continues from the end of the items returned by
* the previous request.
*
*
* @param nextToken
* The token returned from a previous paginated request. Pagination continues from the end of the items
* returned by the previous request.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* The token returned from a previous paginated request. Pagination continues from the end of the items returned by
* the previous request.
*
*
* @return The token returned from a previous paginated request. Pagination continues from the end of the items
* returned by the previous request.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* The token returned from a previous paginated request. Pagination continues from the end of the items returned by
* the previous request.
*
*
* @param nextToken
* The token returned from a previous paginated request. Pagination continues from the end of the items
* returned by the previous request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeNetworkInterfacesRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* The maximum number of items to return for this request. To get the next page of items, make another request with
* the token returned in the output. You cannot specify this parameter and the network interface IDs parameter in
* the same request. For more information, see Pagination.
*
*
* @param maxResults
* The maximum number of items to return for this request. To get the next page of items, make another
* request with the token returned in the output. You cannot specify this parameter and the network interface
* IDs parameter in the same request. For more information, see Pagination.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* The maximum number of items to return for this request. To get the next page of items, make another request with
* the token returned in the output. You cannot specify this parameter and the network interface IDs parameter in
* the same request. For more information, see Pagination.
*
*
* @return The maximum number of items to return for this request. To get the next page of items, make another
* request with the token returned in the output. You cannot specify this parameter and the network
* interface IDs parameter in the same request. For more information, see Pagination.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* The maximum number of items to return for this request. To get the next page of items, make another request with
* the token returned in the output. You cannot specify this parameter and the network interface IDs parameter in
* the same request. For more information, see Pagination.
*
*
* @param maxResults
* The maximum number of items to return for this request. To get the next page of items, make another
* request with the token returned in the output. You cannot specify this parameter and the network interface
* IDs parameter in the same request. For more information, see Pagination.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeNetworkInterfacesRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
return this;
}
/**
* This method is intended for internal use only. Returns the marshaled request configured with additional
* parameters to enable operation dry-run.
*/
@Override
public Request getDryRunRequest() {
Request request = new DescribeNetworkInterfacesRequestMarshaller().marshall(this);
request.addParameter("DryRun", Boolean.toString(true));
return request;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getFilters() != null)
sb.append("Filters: ").append(getFilters()).append(",");
if (getNetworkInterfaceIds() != null)
sb.append("NetworkInterfaceIds: ").append(getNetworkInterfaceIds()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribeNetworkInterfacesRequest == false)
return false;
DescribeNetworkInterfacesRequest other = (DescribeNetworkInterfacesRequest) obj;
if (other.getFilters() == null ^ this.getFilters() == null)
return false;
if (other.getFilters() != null && other.getFilters().equals(this.getFilters()) == false)
return false;
if (other.getNetworkInterfaceIds() == null ^ this.getNetworkInterfaceIds() == null)
return false;
if (other.getNetworkInterfaceIds() != null && other.getNetworkInterfaceIds().equals(this.getNetworkInterfaceIds()) == false)
return false;
if (other.getNextToken() == null ^ this.getNextToken() == null)
return false;
if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false)
return false;
if (other.getMaxResults() == null ^ this.getMaxResults() == null)
return false;
if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getFilters() == null) ? 0 : getFilters().hashCode());
hashCode = prime * hashCode + ((getNetworkInterfaceIds() == null) ? 0 : getNetworkInterfaceIds().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
return hashCode;
}
@Override
public DescribeNetworkInterfacesRequest clone() {
return (DescribeNetworkInterfacesRequest) super.clone();
}
}