Struct aws_sdk_ec2::client::fluent_builders::DescribeSubnets

pub struct DescribeSubnets { /* private fields */ }

Fluent builder constructing a request to DescribeSubnets.

Describes one or more of your subnets.

For more information, see Your VPC and subnets in the Amazon Virtual Private Cloud User Guide.

Implementations

impl DescribeSubnets

pub async fn customize(
    self
) -> Result<CustomizableOperation<DescribeSubnets, AwsResponseRetryClassifier>, SdkError<DescribeSubnetsError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<DescribeSubnetsOutput, SdkError<DescribeSubnetsError>>

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, which can be set when configuring the client.

pub fn into_paginator(self) -> DescribeSubnetsPaginator

Create a paginator for this request

Paginators are used by calling send().await which returns a Stream.

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.

• availability-zone - The Availability Zone for the subnet. You can also use availabilityZone as the filter name.

• availability-zone-id - The ID of the Availability Zone for the subnet. You can also use availabilityZoneId as the filter name.

• available-ip-address-count - The number of IPv4 addresses in the subnet that are available.

• cidr-block - The IPv4 CIDR block of the subnet. The CIDR block you specify must exactly match the subnet's CIDR block for information to be returned for the subnet. You can also use cidr or cidrBlock as the filter names.

• customer-owned-ipv4-pool - The customer-owned IPv4 address pool associated with the subnet.

• default-for-az - Indicates whether this is the default subnet for the Availability Zone (true | false). You can also use defaultForAz as the filter name.

• enable-dns64 - Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations.

• enable-lni-at-device-index - Indicates the device position for local network interfaces in this subnet. For example, 1 indicates local network interfaces in this subnet are the secondary network interface (eth1).

• ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the subnet.

• ipv6-cidr-block-association.association-id - An association ID for an IPv6 CIDR block associated with the subnet.

• ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the subnet.

• ipv6-native - Indicates whether this is an IPv6 only subnet (true | false).

• map-customer-owned-ip-on-launch - Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives a customer-owned IPv4 address.

• map-public-ip-on-launch - Indicates whether instances launched in this subnet receive a public IPv4 address.

• outpost-arn - The Amazon Resource Name (ARN) of the Outpost.

• owner-id - The ID of the Amazon Web Services account that owns the subnet.

• private-dns-name-options-on-launch.hostname-type - The type of hostname to assign to instances in the subnet at launch. For IPv4-only and dual-stack (IPv4 and IPv6) subnets, an instance DNS name can be based on the instance IPv4 address (ip-name) or the instance ID (resource-name). For IPv6 only subnets, an instance DNS name must be based on the instance ID (resource-name).

• private-dns-name-options-on-launch.enable-resource-name-dns-a-record - Indicates whether to respond to DNS queries for instance hostnames with DNS A records.

• private-dns-name-options-on-launch.enable-resource-name-dns-aaaa-record - Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.

• state - The state of the subnet (pending | available).

• subnet-arn - The Amazon Resource Name (ARN) of the subnet.

• subnet-id - The ID of the subnet.

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

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

One or more filters.

• availability-zone - The Availability Zone for the subnet. You can also use availabilityZone as the filter name.

• availability-zone-id - The ID of the Availability Zone for the subnet. You can also use availabilityZoneId as the filter name.

• available-ip-address-count - The number of IPv4 addresses in the subnet that are available.

• cidr-block - The IPv4 CIDR block of the subnet. The CIDR block you specify must exactly match the subnet's CIDR block for information to be returned for the subnet. You can also use cidr or cidrBlock as the filter names.

• customer-owned-ipv4-pool - The customer-owned IPv4 address pool associated with the subnet.

• default-for-az - Indicates whether this is the default subnet for the Availability Zone (true | false). You can also use defaultForAz as the filter name.

• enable-dns64 - Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations.

• enable-lni-at-device-index - Indicates the device position for local network interfaces in this subnet. For example, 1 indicates local network interfaces in this subnet are the secondary network interface (eth1).

• ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the subnet.

• ipv6-cidr-block-association.association-id - An association ID for an IPv6 CIDR block associated with the subnet.

• ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the subnet.

• ipv6-native - Indicates whether this is an IPv6 only subnet (true | false).

• map-customer-owned-ip-on-launch - Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives a customer-owned IPv4 address.

• map-public-ip-on-launch - Indicates whether instances launched in this subnet receive a public IPv4 address.

• outpost-arn - The Amazon Resource Name (ARN) of the Outpost.

• owner-id - The ID of the Amazon Web Services account that owns the subnet.

• private-dns-name-options-on-launch.hostname-type - The type of hostname to assign to instances in the subnet at launch. For IPv4-only and dual-stack (IPv4 and IPv6) subnets, an instance DNS name can be based on the instance IPv4 address (ip-name) or the instance ID (resource-name). For IPv6 only subnets, an instance DNS name must be based on the instance ID (resource-name).

• private-dns-name-options-on-launch.enable-resource-name-dns-a-record - Indicates whether to respond to DNS queries for instance hostnames with DNS A records.

• private-dns-name-options-on-launch.enable-resource-name-dns-aaaa-record - Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.

• state - The state of the subnet (pending | available).

• subnet-arn - The Amazon Resource Name (ARN) of the subnet.

• subnet-id - The ID of the subnet.

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

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

Appends an item to SubnetIds.

To override the contents of this collection use set_subnet_ids.

One or more subnet IDs.

Default: Describes all your subnets.

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

One or more subnet IDs.

Default: Describes all your subnets.

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.

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.

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

The token for the next page of results.

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

The token for the next page of results.

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

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

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

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Trait Implementations

impl Clone for DescribeSubnets

fn clone(&self) -> DescribeSubnets

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeSubnets

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

Formats the value using the given formatter.