Package software.amazon.awssdk.services.imagebuilder.model

Interface CreateImageRequest.Builder

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

  • Method Details

    • imageRecipeArn

      CreateImageRequest.Builder imageRecipeArn(String imageRecipeArn)

      The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.

      Parameters:
      imageRecipeArn - The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • containerRecipeArn

      CreateImageRequest.Builder containerRecipeArn(String containerRecipeArn)

      The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.

      Parameters:
      containerRecipeArn - The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • distributionConfigurationArn

      CreateImageRequest.Builder distributionConfigurationArn(String distributionConfigurationArn)

      The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline.

      Parameters:
      distributionConfigurationArn - The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • infrastructureConfigurationArn

      CreateImageRequest.Builder infrastructureConfigurationArn(String infrastructureConfigurationArn)

      The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested.

      Parameters:
      infrastructureConfigurationArn - The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • imageTestsConfiguration

      CreateImageRequest.Builder imageTestsConfiguration(ImageTestsConfiguration imageTestsConfiguration)

      The image tests configuration of the image.

      Parameters:
      imageTestsConfiguration - The image tests configuration of the image.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • imageTestsConfiguration

      default CreateImageRequest.Builder imageTestsConfiguration(Consumer<ImageTestsConfiguration.Builder> imageTestsConfiguration)

      The image tests configuration of the image.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to imageTestsConfiguration(ImageTestsConfiguration).

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

    • enhancedImageMetadataEnabled

      CreateImageRequest.Builder enhancedImageMetadataEnabled(Boolean enhancedImageMetadataEnabled)

      Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.

      Parameters:
      enhancedImageMetadataEnabled - Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateImageRequest.Builder tags(Map<String,String> tags)

      The tags of the image.

      Parameters:
      tags - The tags of the image.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientToken

      CreateImageRequest.Builder clientToken(String clientToken)

      Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

      Parameters:
      clientToken - Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • imageScanningConfiguration

      CreateImageRequest.Builder imageScanningConfiguration(ImageScanningConfiguration imageScanningConfiguration)

      Contains settings for vulnerability scans.

      Parameters:
      imageScanningConfiguration - Contains settings for vulnerability scans.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • imageScanningConfiguration

      default CreateImageRequest.Builder imageScanningConfiguration(Consumer<ImageScanningConfiguration.Builder> imageScanningConfiguration)

      Contains settings for vulnerability scans.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to imageScanningConfiguration(ImageScanningConfiguration).

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

    • workflows

      CreateImageRequest.Builder workflows(Collection<WorkflowConfiguration> workflows)

      Contains an array of workflow configuration objects.

      Parameters:
      workflows - Contains an array of workflow configuration objects.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • workflows

      CreateImageRequest.Builder workflows(WorkflowConfiguration... workflows)

      Contains an array of workflow configuration objects.

      Parameters:
      workflows - Contains an array of workflow configuration objects.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • workflows

      CreateImageRequest.Builder workflows(Consumer<WorkflowConfiguration.Builder>... workflows)

      Contains an array of workflow configuration objects.

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

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

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

    • executionRole

      CreateImageRequest.Builder executionRole(String executionRole)

      The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.

      Parameters:
      executionRole - The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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