Interface DescribeImageReferencesRequest.Builder

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

  • Method Details

    • imageIds

      DescribeImageReferencesRequest.Builder imageIds(Collection<String> 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

      DescribeImageReferencesRequest.Builder imageIds(String... 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

      DescribeImageReferencesRequest.Builder includeAllResourceTypes(Boolean 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 specify ResourceTypes with ResourceTypeOptions, your specified values override the default values.

      Supported resource types: ec2:Instance | ec2:LaunchTemplate | ssm:Parameter | imagebuilder:ImageRecipe | imagebuilder:ContainerRecipe

      Either IncludeAllResourceTypes or ResourceTypes 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 for ResourceTypeOptions. For the default values, see How AMI reference checks work in the Amazon EC2 User Guide. If you also specify ResourceTypes with ResourceTypeOptions, your specified values override the default values.

      Supported resource types: ec2:Instance | ec2:LaunchTemplate | ssm:Parameter | imagebuilder:ImageRecipe | imagebuilder:ContainerRecipe

      Either IncludeAllResourceTypes or ResourceTypes must be specified.

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

    • resourceTypes

      DescribeImageReferencesRequest.Builder resourceTypes(Collection<ResourceTypeRequest> resourceTypes)

      The Amazon Web Services resource types to check for image references.

      Either IncludeAllResourceTypes or ResourceTypes must be specified.

      Parameters:
      resourceTypes - The Amazon Web Services resource types to check for image references.

      Either IncludeAllResourceTypes or ResourceTypes must be specified.

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

    • resourceTypes

      DescribeImageReferencesRequest.Builder resourceTypes(ResourceTypeRequest... resourceTypes)

      The Amazon Web Services resource types to check for image references.

      Either IncludeAllResourceTypes or ResourceTypes must be specified.

      Parameters:
      resourceTypes - The Amazon Web Services resource types to check for image references.

      Either IncludeAllResourceTypes or ResourceTypes 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 IncludeAllResourceTypes or ResourceTypes must be specified.

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

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

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

    • nextToken

      DescribeImageReferencesRequest.Builder nextToken(String 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

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

    • maxResults

      DescribeImageReferencesRequest.Builder maxResults(Integer 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 interface AwsRequest.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 interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.