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

Interface SearchTransitGatewayRoutesRequest.Builder

    • Method Detail

      • transitGatewayRouteTableId

        SearchTransitGatewayRoutesRequest.Builder transitGatewayRouteTableId​(String transitGatewayRouteTableId)

        The ID of the transit gateway route table.

        Parameters:
        transitGatewayRouteTableId - The ID of the transit gateway route table.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • filters

        SearchTransitGatewayRoutesRequest.Builder filters​(Collection<Filter> filters)

        One or more filters. The possible values are:

        • attachment.transit-gateway-attachment-id- The id of the transit gateway attachment.

        • attachment.resource-id - The resource id of the transit gateway attachment.

        • attachment.resource-type - The attachment resource type. Valid values are vpc | vpn | direct-connect-gateway | peering | connect.

        • prefix-list-id - The ID of the prefix list.

        • route-search.exact-match - The exact match of the specified filter.

        • route-search.longest-prefix-match - The longest prefix that matches the route.

        • route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter.

        • route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29.

        • state - The state of the route (active | blackhole).

        • type - The type of route (propagated | static).

        Parameters:
        filters - One or more filters. The possible values are:

        • attachment.transit-gateway-attachment-id- The id of the transit gateway attachment.

        • attachment.resource-id - The resource id of the transit gateway attachment.

        • attachment.resource-type - The attachment resource type. Valid values are vpc | vpn | direct-connect-gateway | peering | connect.

        • prefix-list-id - The ID of the prefix list.

        • route-search.exact-match - The exact match of the specified filter.

        • route-search.longest-prefix-match - The longest prefix that matches the route.

        • route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter.

        • route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29.

        • state - The state of the route (active | blackhole).

        • type - The type of route (propagated | static).

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

      • filters

        SearchTransitGatewayRoutesRequest.Builder filters​(Filter... filters)

        One or more filters. The possible values are:

        • attachment.transit-gateway-attachment-id- The id of the transit gateway attachment.

        • attachment.resource-id - The resource id of the transit gateway attachment.

        • attachment.resource-type - The attachment resource type. Valid values are vpc | vpn | direct-connect-gateway | peering | connect.

        • prefix-list-id - The ID of the prefix list.

        • route-search.exact-match - The exact match of the specified filter.

        • route-search.longest-prefix-match - The longest prefix that matches the route.

        • route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter.

        • route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29.

        • state - The state of the route (active | blackhole).

        • type - The type of route (propagated | static).

        Parameters:
        filters - One or more filters. The possible values are:

        • attachment.transit-gateway-attachment-id- The id of the transit gateway attachment.

        • attachment.resource-id - The resource id of the transit gateway attachment.

        • attachment.resource-type - The attachment resource type. Valid values are vpc | vpn | direct-connect-gateway | peering | connect.

        • prefix-list-id - The ID of the prefix list.

        • route-search.exact-match - The exact match of the specified filter.

        • route-search.longest-prefix-match - The longest prefix that matches the route.

        • route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter.

        • route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29.

        • state - The state of the route (active | blackhole).

        • type - The type of route (propagated | static).

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

      • filters

        SearchTransitGatewayRoutesRequest.Builder filters​(Consumer<Filter.Builder>... filters)

        One or more filters. The possible values are:

        • attachment.transit-gateway-attachment-id- The id of the transit gateway attachment.

        • attachment.resource-id - The resource id of the transit gateway attachment.

        • attachment.resource-type - The attachment resource type. Valid values are vpc | vpn | direct-connect-gateway | peering | connect.

        • prefix-list-id - The ID of the prefix list.

        • route-search.exact-match - The exact match of the specified filter.

        • route-search.longest-prefix-match - The longest prefix that matches the route.

        • route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter.

        • route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29.

        • state - The state of the route (active | blackhole).

        • type - The type of route (propagated | static).

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

        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:
        #filters(java.util.Collection)

      • maxResults

        SearchTransitGatewayRoutesRequest.Builder maxResults​(Integer maxResults)

        The maximum number of routes to return. If a value is not provided, the default is 1000.

        Parameters:
        maxResults - The maximum number of routes to return. If a value is not provided, the default is 1000.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dryRun

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