Package software.amazon.awssdk.services.ec2.model

Interface DescribeCustomerGatewaysRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<DescribeCustomerGatewaysRequest.Builder,DescribeCustomerGatewaysRequest>, Ec2Request.Builder, SdkBuilder<DescribeCustomerGatewaysRequest.Builder,DescribeCustomerGatewaysRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
DescribeCustomerGatewaysRequest
public static interface DescribeCustomerGatewaysRequest.Builder extends Ec2Request.Builder, SdkPojo, CopyableBuilder<DescribeCustomerGatewaysRequest.Builder,DescribeCustomerGatewaysRequest>

  • Method Details

    • customerGatewayIds

      DescribeCustomerGatewaysRequest.Builder customerGatewayIds(Collection<String> customerGatewayIds)

      One or more customer gateway IDs.

      Default: Describes all your customer gateways.

      Parameters:
      customerGatewayIds - One or more customer gateway IDs.

      Default: Describes all your customer gateways.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customerGatewayIds

      DescribeCustomerGatewaysRequest.Builder customerGatewayIds(String... customerGatewayIds)

      One or more customer gateway IDs.

      Default: Describes all your customer gateways.

      Parameters:
      customerGatewayIds - One or more customer gateway IDs.

      Default: Describes all your customer gateways.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      DescribeCustomerGatewaysRequest.Builder filters(Collection<Filter> 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:<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 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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      DescribeCustomerGatewaysRequest.Builder filters(Filter... 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:<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 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.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      DescribeCustomerGatewaysRequest.Builder filters(Consumer<Filter.Builder>... 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:<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 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.

      This is a convenience method that creates an instance of the Filter.Builder avoiding the need to create one manually via Filter.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filters(List<Filter>).

      Parameters:
      filters - a consumer that will call methods on Filter.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • dryRun

      DescribeCustomerGatewaysRequest.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 is UnauthorizedOperation.

      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 is DryRunOperation. Otherwise, it is UnauthorizedOperation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      DescribeCustomerGatewaysRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      DescribeCustomerGatewaysRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.