Struct aws_sdk_ec2::operation::describe_customer_gateways::DescribeCustomerGatewaysInput

#[non_exhaustive]
pub struct DescribeCustomerGatewaysInput {
    pub customer_gateway_ids: Option<Vec<String>>,
    pub filters: Option<Vec<Filter>>,
    pub dry_run: Option<bool>,
}

Contains the parameters for DescribeCustomerGateways.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

customer_gateway_ids: Option<Vec<String>>

One or more customer gateway IDs.

Default: Describes all your customer gateways.

filters: Option<Vec<Filter>>

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.

dry_run: Option<bool>

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.

Implementations

impl DescribeCustomerGatewaysInput

pub fn customer_gateway_ids(&self) -> &[String]

One or more customer gateway IDs.

Default: Describes all your customer gateways.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .customer_gateway_ids.is_none().

pub fn filters(&self) -> &[Filter]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .filters.is_none().

pub fn dry_run(&self) -> Option<bool>

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.

impl DescribeCustomerGatewaysInput

pub fn builder() -> DescribeCustomerGatewaysInputBuilder

Creates a new builder-style object to manufacture DescribeCustomerGatewaysInput.

Trait Implementations

impl Clone for DescribeCustomerGatewaysInput

fn clone(&self) -> DescribeCustomerGatewaysInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeCustomerGatewaysInput

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

Formats the value using the given formatter.

impl PartialEq for DescribeCustomerGatewaysInput

fn eq(&self, other: &DescribeCustomerGatewaysInput) -> 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 DescribeCustomerGatewaysInput