Interface CreateImageRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateImageRequest.Builder,CreateImageRequest>, ImagebuilderRequest.Builder, SdkBuilder<CreateImageRequest.Builder,CreateImageRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateImageRequest
@Mutable @NotThreadSafe 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. You must specify either this property or containerRecipeArn, but not both.

      Parameters:
      imageRecipeArn - The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed. You must specify either this property or containerRecipeArn, but not both.
      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. You must specify either this property or imageRecipeArn, but not both.

      Parameters:
      containerRecipeArn - The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested. You must specify either this property or imageRecipeArn, but not both.
      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 the image build. If you don't specify a distribution configuration, Image Builder creates the output image only in the account and Amazon Web Services Region where the build runs.

      Parameters:
      distributionConfigurationArn - The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of the image build. If you don't specify a distribution configuration, Image Builder creates the output image only in the account and Amazon Web Services Region where the build runs.
      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)

      Settings that determine whether Image Builder runs tests on the image after building it. Image tests are enabled by default.

      Parameters:
      imageTestsConfiguration - Settings that determine whether Image Builder runs tests on the image after building it. Image tests are enabled by default.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • imageTestsConfiguration

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

      Settings that determine whether Image Builder runs tests on the image after building it. Image tests are enabled by default.

      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)

      Specifies whether to collect additional information about the image being created, including the operating system (OS) version and package list. Defaults to true.

      Parameters:
      enhancedImageMetadataEnabled - Specifies whether to collect additional information about the image being created, including the operating system (OS) version and package list. Defaults to true.
      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)

      A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time. If you retry a request with the same client token, Image Builder returns the original response without running the operation again. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

      Parameters:
      clientToken - A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time. If you retry a request with the same client token, Image Builder returns the original response without running the operation again. 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)

      Settings for vulnerability scans that Amazon Inspector runs during image creation. For AMI output, Amazon Inspector scans the test instance. For container output, Amazon Inspector scans the container image that Image Builder pushes to the Amazon ECR repository specified in ecrConfiguration.

      Parameters:
      imageScanningConfiguration - Settings for vulnerability scans that Amazon Inspector runs during image creation. For AMI output, Amazon Inspector scans the test instance. For container output, Amazon Inspector scans the container image that Image Builder pushes to the Amazon ECR repository specified in ecrConfiguration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • imageScanningConfiguration

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

      Settings for vulnerability scans that Amazon Inspector runs during image creation. For AMI output, Amazon Inspector scans the test instance. For container output, Amazon Inspector scans the container image that Image Builder pushes to the Amazon ECR repository specified in ecrConfiguration.

      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)

      The array of workflow configuration objects for the build. If you specify workflows, they replace the default workflows that Image Builder otherwise runs for the build, and you must also provide an executionRole.

      Parameters:
      workflows - The array of workflow configuration objects for the build. If you specify workflows, they replace the default workflows that Image Builder otherwise runs for the build, and you must also provide an executionRole.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • workflows

      CreateImageRequest.Builder workflows(WorkflowConfiguration... workflows)

      The array of workflow configuration objects for the build. If you specify workflows, they replace the default workflows that Image Builder otherwise runs for the build, and you must also provide an executionRole.

      Parameters:
      workflows - The array of workflow configuration objects for the build. If you specify workflows, they replace the default workflows that Image Builder otherwise runs for the build, and you must also provide an executionRole.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • workflows

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

      The array of workflow configuration objects for the build. If you specify workflows, they replace the default workflows that Image Builder otherwise runs for the build, and you must also provide an executionRole.

      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. This property is required if you specify workflows. If you don't provide a role, Image Builder uses the Image Builder service-linked role in your account, and creates it if it doesn't exist.

      Parameters:
      executionRole - The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions. This property is required if you specify workflows. If you don't provide a role, Image Builder uses the Image Builder service-linked role in your account, and creates it if it doesn't exist.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • loggingConfiguration

      CreateImageRequest.Builder loggingConfiguration(ImageLoggingConfiguration loggingConfiguration)

      The CloudWatch Logs log group where Image Builder sends the image build logs. If you specify a log group name outside of the /aws/imagebuilder/ namespace, you must also provide an executionRole that has permission to write to that log group.

      Parameters:
      loggingConfiguration - The CloudWatch Logs log group where Image Builder sends the image build logs. If you specify a log group name outside of the /aws/imagebuilder/ namespace, you must also provide an executionRole that has permission to write to that log group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • loggingConfiguration

      default CreateImageRequest.Builder loggingConfiguration(Consumer<ImageLoggingConfiguration.Builder> loggingConfiguration)

      The CloudWatch Logs log group where Image Builder sends the image build logs. If you specify a log group name outside of the /aws/imagebuilder/ namespace, you must also provide an executionRole that has permission to write to that log group.

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

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

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

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