Interface DescribeNetworkInterfacesRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<DescribeNetworkInterfacesRequest.Builder,DescribeNetworkInterfacesRequest>
,Ec2Request.Builder
,SdkBuilder<DescribeNetworkInterfacesRequest.Builder,DescribeNetworkInterfacesRequest>
,SdkPojo
,SdkRequest.Builder
- Enclosing class:
- DescribeNetworkInterfacesRequest
public static interface DescribeNetworkInterfacesRequest.Builder extends Ec2Request.Builder, SdkPojo, CopyableBuilder<DescribeNetworkInterfacesRequest.Builder,DescribeNetworkInterfacesRequest>
-
-
Method Summary
-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.services.ec2.model.Ec2Request.Builder
build
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
filters
DescribeNetworkInterfacesRequest.Builder filters(Collection<Filter> 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 oftrue
means checking is enabled, andfalse
means checking is disabled. The value must befalse
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 isavailable
; if a network interface is attached to an instance the status isin-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 keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
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.
- Parameters:
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 oftrue
means checking is enabled, andfalse
means checking is disabled. The value must befalse
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 isavailable
; if a network interface is attached to an instance the status isin-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 keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
filters
DescribeNetworkInterfacesRequest.Builder filters(Filter... 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 oftrue
means checking is enabled, andfalse
means checking is disabled. The value must befalse
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 isavailable
; if a network interface is attached to an instance the status isin-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 keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
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.
- Parameters:
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 oftrue
means checking is enabled, andfalse
means checking is disabled. The value must befalse
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 isavailable
; if a network interface is attached to an instance the status isin-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 keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
filters
DescribeNetworkInterfacesRequest.Builder filters(Consumer<Filter.Builder>... 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 oftrue
means checking is enabled, andfalse
means checking is disabled. The value must befalse
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 isavailable
; if a network interface is attached to an instance the status isin-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 keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
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.
Filter.Builder
avoiding the need to create one manually viaFilter.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#filters(List
.) - Parameters:
filters
- a consumer that will call methods onFilter.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#filters(java.util.Collection
)
-
-
dryRun
DescribeNetworkInterfacesRequest.Builder dryRun(Boolean dryRun)
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 isUnauthorizedOperation
.- Parameters:
dryRun
- 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 isDryRunOperation
. Otherwise, it isUnauthorizedOperation
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
networkInterfaceIds
DescribeNetworkInterfacesRequest.Builder networkInterfaceIds(Collection<String> networkInterfaceIds)
The network interface IDs.
Default: Describes all your network interfaces.
- Parameters:
networkInterfaceIds
- The network interface IDs.Default: Describes all your network interfaces.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
networkInterfaceIds
DescribeNetworkInterfacesRequest.Builder networkInterfaceIds(String... networkInterfaceIds)
The network interface IDs.
Default: Describes all your network interfaces.
- Parameters:
networkInterfaceIds
- The network interface IDs.Default: Describes all your network interfaces.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextToken
DescribeNetworkInterfacesRequest.Builder nextToken(String nextToken)
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
- Parameters:
nextToken
- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxResults
DescribeNetworkInterfacesRequest.Builder maxResults(Integer 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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
DescribeNetworkInterfacesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
overrideConfiguration
DescribeNetworkInterfacesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
-