Interface DescribeImageReferencesRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<DescribeImageReferencesRequest.Builder,
,DescribeImageReferencesRequest> Ec2Request.Builder
,SdkBuilder<DescribeImageReferencesRequest.Builder,
,DescribeImageReferencesRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
DescribeImageReferencesRequest
-
Method Summary
Modifier and TypeMethodDescriptionChecks whether you have the required permissions for the action, without actually making the request, and provides an error response.The IDs of the images to check for resource references.imageIds
(Collection<String> imageIds) The IDs of the images to check for resource references.includeAllResourceTypes
(Boolean includeAllResourceTypes) Specifies whether to check all supported Amazon Web Services resource types for image references.maxResults
(Integer maxResults) The maximum number of items to return for this request.The token returned from a previous paginated request.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.resourceTypes
(Collection<ResourceTypeRequest> resourceTypes) The Amazon Web Services resource types to check for image references.resourceTypes
(Consumer<ResourceTypeRequest.Builder>... resourceTypes) The Amazon Web Services resource types to check for image references.resourceTypes
(ResourceTypeRequest... resourceTypes) The Amazon Web Services resource types to check for image references.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, sdkFieldNameToField, sdkFields
-
Method Details
-
imageIds
The IDs of the images to check for resource references.
- Parameters:
imageIds
- The IDs of the images to check for resource references.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
imageIds
The IDs of the images to check for resource references.
- Parameters:
imageIds
- The IDs of the images to check for resource references.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
includeAllResourceTypes
Specifies whether to check all supported Amazon Web Services resource types for image references. When specified, default values are applied for
ResourceTypeOptions
. For the default values, see How AMI reference checks work in the Amazon EC2 User Guide. If you also specifyResourceTypes
withResourceTypeOptions
, your specified values override the default values.Supported resource types:
ec2:Instance
|ec2:LaunchTemplate
|ssm:Parameter
|imagebuilder:ImageRecipe
|imagebuilder:ContainerRecipe
Either
IncludeAllResourceTypes
orResourceTypes
must be specified.- Parameters:
includeAllResourceTypes
- Specifies whether to check all supported Amazon Web Services resource types for image references. When specified, default values are applied forResourceTypeOptions
. For the default values, see How AMI reference checks work in the Amazon EC2 User Guide. If you also specifyResourceTypes
withResourceTypeOptions
, your specified values override the default values.Supported resource types:
ec2:Instance
|ec2:LaunchTemplate
|ssm:Parameter
|imagebuilder:ImageRecipe
|imagebuilder:ContainerRecipe
Either
IncludeAllResourceTypes
orResourceTypes
must be specified.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
resourceTypes
The Amazon Web Services resource types to check for image references.
Either
IncludeAllResourceTypes
orResourceTypes
must be specified.- Parameters:
resourceTypes
- The Amazon Web Services resource types to check for image references.Either
IncludeAllResourceTypes
orResourceTypes
must be specified.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
resourceTypes
The Amazon Web Services resource types to check for image references.
Either
IncludeAllResourceTypes
orResourceTypes
must be specified.- Parameters:
resourceTypes
- The Amazon Web Services resource types to check for image references.Either
IncludeAllResourceTypes
orResourceTypes
must be specified.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
resourceTypes
DescribeImageReferencesRequest.Builder resourceTypes(Consumer<ResourceTypeRequest.Builder>... resourceTypes) The Amazon Web Services resource types to check for image references.
Either
This is a convenience method that creates an instance of theIncludeAllResourceTypes
orResourceTypes
must be specified.ResourceTypeRequest.Builder
avoiding the need to create one manually viaResourceTypeRequest.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toresourceTypes(List<ResourceTypeRequest>)
.- Parameters:
resourceTypes
- a consumer that will call methods onResourceTypeRequest.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
nextToken
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
- Parameters:
nextToken
- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.- 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.
-
maxResults
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
- Parameters:
maxResults
- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
DescribeImageReferencesRequest.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
DescribeImageReferencesRequest.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.
-