Struct aws_sdk_ec2::client::fluent_builders::DescribeCustomerGateways

pub struct DescribeCustomerGateways { /* private fields */ }

Fluent builder constructing a request to DescribeCustomerGateways.

Describes one or more of your VPN customer gateways.

For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.

Implementations

impl DescribeCustomerGateways

pub async fn customize(
    self
) -> Result<CustomizableOperation<DescribeCustomerGateways, AwsResponseRetryClassifier>, SdkError<DescribeCustomerGatewaysError>>

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<DescribeCustomerGatewaysOutput, SdkError<DescribeCustomerGatewaysError>>

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 customer_gateway_ids(self, input: impl Into<String>) -> Self

Appends an item to CustomerGatewayIds.

To override the contents of this collection use set_customer_gateway_ids.

One or more customer gateway IDs.

Default: Describes all your customer gateways.

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

One or more customer gateway IDs.

Default: Describes all your customer gateways.

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.

• bgp-asn - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

• customer-gateway-id - The ID of the customer gateway.

• ip-address - The IP address of the customer gateway device's external interface.

• state - The state of the customer gateway (pending | available | deleting | deleted).

• type - The type of customer gateway. Currently, the only supported type is ipsec.1.

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

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

One or more filters.

• bgp-asn - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

• customer-gateway-id - The ID of the customer gateway.

• ip-address - The IP address of the customer gateway device's external interface.

• state - The state of the customer gateway (pending | available | deleting | deleted).

• type - The type of customer gateway. Currently, the only supported type is ipsec.1.

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

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.

Trait Implementations

impl Clone for DescribeCustomerGateways

fn clone(&self) -> DescribeCustomerGateways

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeCustomerGateways

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

Formats the value using the given formatter.