Struct aws_sdk_ec2::input::describe_network_interfaces_input::Builder

pub struct Builder { /* private fields */ }

A builder for DescribeNetworkInterfacesInput.

Implementations

impl Builder

pub fn filters(self, input: Filter) -> Self

Appends an item to filters.

To override the contents of this collection use set_filters.

One or more filters.

• addresses.private-ip-address - The private IPv4 addresses associated with the network interface.

• addresses.primary - Whether the private IPv4 address is the primary IP address 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.association.owner-id - The owner ID of the addresses associated with the network interface.

• association.association-id - The association ID returned when the network interface was associated with an IPv4 address.

• association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your 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.attachment-id - The ID of the interface attachment.

• attachment.attach-time - The time that the network interface was attached to an instance.

• 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.

• group-name - The name 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 | efa | 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-ip-address - The private IPv4 address or addresses of the network interface.

• private-dns-name - The private DNS name of the network interface (IPv4).

• 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: - 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.

Examples found in repository

src/client.rs (line 43729)

        pub fn filters(mut self, input: crate::model::Filter) -> Self {
            self.inner = self.inner.filters(input);
            self
        }

pub fn set_filters(self, input: Option<Vec<Filter>>) -> Self

One or more filters.

• addresses.private-ip-address - The private IPv4 addresses associated with the network interface.

• addresses.primary - Whether the private IPv4 address is the primary IP address 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.association.owner-id - The owner ID of the addresses associated with the network interface.

• association.association-id - The association ID returned when the network interface was associated with an IPv4 address.

• association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your 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.attachment-id - The ID of the interface attachment.

• attachment.attach-time - The time that the network interface was attached to an instance.

• 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.

• group-name - The name 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 | efa | 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-ip-address - The private IPv4 address or addresses of the network interface.

• private-dns-name - The private DNS name of the network interface (IPv4).

• 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: - 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.

Examples found in repository

src/client.rs (line 43780)

        pub fn set_filters(
            mut self,
            input: std::option::Option<std::vec::Vec<crate::model::Filter>>,
        ) -> Self {
            self.inner = self.inner.set_filters(input);
            self
        }

pub fn dry_run(self, input: bool) -> Self

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.

Examples found in repository

src/client.rs (line 43785)

        pub fn dry_run(mut self, input: bool) -> Self {
            self.inner = self.inner.dry_run(input);
            self
        }

pub fn set_dry_run(self, input: Option<bool>) -> Self

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.

Examples found in repository

src/client.rs (line 43790)

        pub fn set_dry_run(mut self, input: std::option::Option<bool>) -> Self {
            self.inner = self.inner.set_dry_run(input);
            self
        }

pub fn network_interface_ids(self, input: impl Into<String>) -> Self

Appends an item to network_interface_ids.

To override the contents of this collection use set_network_interface_ids.

The network interface IDs.

Default: Describes all your network interfaces.

Examples found in repository

src/client.rs (line 43800)

        pub fn network_interface_ids(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.network_interface_ids(input.into());
            self
        }

pub fn set_network_interface_ids(self, input: Option<Vec<String>>) -> Self

The network interface IDs.

Default: Describes all your network interfaces.

Examples found in repository

src/client.rs (line 43809)

        pub fn set_network_interface_ids(
            mut self,
            input: std::option::Option<std::vec::Vec<std::string::String>>,
        ) -> Self {
            self.inner = self.inner.set_network_interface_ids(input);
            self
        }

pub fn next_token(self, input: impl Into<String>) -> Self

The token to retrieve the next page of results.

Examples found in repository

src/client.rs (line 43814)

        pub fn next_token(mut self, input: impl Into<std::string::String>) -> Self {
            self.inner = self.inner.next_token(input.into());
            self
        }

pub fn set_next_token(self, input: Option<String>) -> Self

The token to retrieve the next page of results.

Examples found in repository

src/client.rs (line 43819)

        pub fn set_next_token(mut self, input: std::option::Option<std::string::String>) -> Self {
            self.inner = self.inner.set_next_token(input);
            self
        }

pub fn max_results(self, input: i32) -> Self

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results. You cannot specify this parameter and the network interface IDs parameter in the same request.

Examples found in repository

src/client.rs (line 43824)

        pub fn max_results(mut self, input: i32) -> Self {
            self.inner = self.inner.max_results(input);
            self
        }

pub fn set_max_results(self, input: Option<i32>) -> Self

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results. You cannot specify this parameter and the network interface IDs parameter in the same request.

Examples found in repository

src/client.rs (line 43829)

        pub fn set_max_results(mut self, input: std::option::Option<i32>) -> Self {
            self.inner = self.inner.set_max_results(input);
            self
        }

pub fn build(self) -> Result<DescribeNetworkInterfacesInput, BuildError>

Consumes the builder and constructs a DescribeNetworkInterfacesInput.

Examples found in repository

src/client.rs (line 43643)

        pub async fn customize(
            self,
        ) -> std::result::Result<
            crate::operation::customize::CustomizableOperation<
                crate::operation::DescribeNetworkInterfaces,
                aws_http::retry::AwsResponseRetryClassifier,
            >,
            aws_smithy_http::result::SdkError<crate::error::DescribeNetworkInterfacesError>,
        > {
            let handle = self.handle.clone();
            let operation = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            Ok(crate::operation::customize::CustomizableOperation { handle, operation })
        }

        /// Sends the request and returns the response.
        ///
        /// If an error occurs, an `SdkError` will be returned with additional details that
        /// can be matched against.
        ///
        /// By default, any retryable failures will be retried twice. Retry behavior
        /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
        /// set when configuring the client.
        pub async fn send(
            self,
        ) -> std::result::Result<
            crate::output::DescribeNetworkInterfacesOutput,
            aws_smithy_http::result::SdkError<crate::error::DescribeNetworkInterfacesError>,
        > {
            let op = self
                .inner
                .build()
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?
                .make_operation(&self.handle.conf)
                .await
                .map_err(aws_smithy_http::result::SdkError::construction_failure)?;
            self.handle.client.call(op).await
        }

src/paginator.rs (line 6468)

    pub fn send(
        self,
    ) -> impl tokio_stream::Stream<
        Item = std::result::Result<
            crate::output::DescribeNetworkInterfacesOutput,
            aws_smithy_http::result::SdkError<crate::error::DescribeNetworkInterfacesError>,
        >,
    > + Unpin {
        // Move individual fields out of self for the borrow checker
        let builder = self.builder;
        let handle = self.handle;
        aws_smithy_async::future::fn_stream::FnStream::new(move |tx| {
            Box::pin(async move {
                // Build the input for the first time. If required fields are missing, this is where we'll produce an early error.
                let mut input = match builder
                    .build()
                    .map_err(aws_smithy_http::result::SdkError::construction_failure)
                {
                    Ok(input) => input,
                    Err(e) => {
                        let _ = tx.send(Err(e)).await;
                        return;
                    }
                };
                loop {
                    let op = match input
                        .make_operation(&handle.conf)
                        .await
                        .map_err(aws_smithy_http::result::SdkError::construction_failure)
                    {
                        Ok(op) => op,
                        Err(e) => {
                            let _ = tx.send(Err(e)).await;
                            return;
                        }
                    };
                    let resp = handle.client.call(op).await;
                    // If the input member is None or it was an error
                    let done = match resp {
                        Ok(ref resp) => {
                            let new_token = crate::lens::reflens_structure_crate_output_describe_network_interfaces_output_next_token(resp);
                            let is_empty = new_token.map(|token| token.is_empty()).unwrap_or(true);
                            if !is_empty
                                && new_token == input.next_token.as_ref()
                                && self.stop_on_duplicate_token
                            {
                                true
                            } else {
                                input.next_token = new_token.cloned();
                                is_empty
                            }
                        }
                        Err(_) => true,
                    };
                    if tx.send(resp).await.is_err() {
                        // receiving end was dropped
                        return;
                    }
                    if done {
                        return;
                    }
                }
            })
        })
    }

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Builder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

fn eq(&self, other: &Builder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Builder