Interface DescribeCarrierGatewaysRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<DescribeCarrierGatewaysRequest.Builder,
,DescribeCarrierGatewaysRequest> Ec2Request.Builder
,SdkBuilder<DescribeCarrierGatewaysRequest.Builder,
,DescribeCarrierGatewaysRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
DescribeCarrierGatewaysRequest
-
Method Summary
Modifier and TypeMethodDescriptioncarrierGatewayIds
(String... carrierGatewayIds) One or more carrier gateway IDs.carrierGatewayIds
(Collection<String> carrierGatewayIds) One or more carrier gateway IDs.Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.filters
(Collection<Filter> filters) One or more filters.filters
(Consumer<Filter.Builder>... filters) One or more filters.One or more filters.maxResults
(Integer maxResults) The maximum number of results to return with a single call.The token for the next page of results.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.ec2.model.Ec2Request.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
carrierGatewayIds
One or more carrier gateway IDs.
- Parameters:
carrierGatewayIds
- One or more carrier gateway IDs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
carrierGatewayIds
One or more carrier gateway IDs.
- Parameters:
carrierGatewayIds
- One or more carrier gateway IDs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filters
One or more filters.
-
carrier-gateway-id
- The ID of the carrier gateway. -
state
- The state of the carrier gateway (pending
|failed
|available
|deleting
|deleted
). -
owner-id
- The Amazon Web Services account ID of the owner of the carrier gateway. -
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 keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
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 associated with the carrier gateway.
- Parameters:
filters
- One or more filters.-
carrier-gateway-id
- The ID of the carrier gateway. -
state
- The state of the carrier gateway (pending
|failed
|available
|deleting
|deleted
). -
owner-id
- The Amazon Web Services account ID of the owner of the carrier gateway. -
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 keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
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 associated with the carrier gateway.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
filters
One or more filters.
-
carrier-gateway-id
- The ID of the carrier gateway. -
state
- The state of the carrier gateway (pending
|failed
|available
|deleting
|deleted
). -
owner-id
- The Amazon Web Services account ID of the owner of the carrier gateway. -
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 keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
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 associated with the carrier gateway.
- Parameters:
filters
- One or more filters.-
carrier-gateway-id
- The ID of the carrier gateway. -
state
- The state of the carrier gateway (pending
|failed
|available
|deleting
|deleted
). -
owner-id
- The Amazon Web Services account ID of the owner of the carrier gateway. -
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 keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
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 associated with the carrier gateway.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
filters
One or more filters.
-
carrier-gateway-id
- The ID of the carrier gateway. -
state
- The state of the carrier gateway (pending
|failed
|available
|deleting
|deleted
). -
owner-id
- The Amazon Web Services account ID of the owner of the carrier gateway. -
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 keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
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 associated with the carrier gateway.
Filter.Builder
avoiding the need to create one manually viaFilter.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofilters(List<Filter>)
.- Parameters:
filters
- a consumer that will call methods onFilter.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
maxResults
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned
nextToken
value.- Parameters:
maxResults
- The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returnednextToken
value.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextToken
The token for the next page of results.
- Parameters:
nextToken
- The token for the next page of results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 isUnauthorizedOperation
.- 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 isDryRunOperation
. Otherwise, it isUnauthorizedOperation
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
DescribeCarrierGatewaysRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
DescribeCarrierGatewaysRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-