Interface CreateImagePipelineRequest.Builder

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

  • Method Details

    • name

      CreateImagePipelineRequest.Builder name(String name)

      The name of the image pipeline. Pipeline names must be unique to your account in each Amazon Web Services Region. Image Builder generates the pipeline ARN from a normalized form of the name, so names that differ only in case, spaces, or underscores count as the same name.

      Parameters:
      name - The name of the image pipeline. Pipeline names must be unique to your account in each Amazon Web Services Region. Image Builder generates the pipeline ARN from a normalized form of the name, so names that differ only in case, spaces, or underscores count as the same name.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      CreateImagePipelineRequest.Builder description(String description)

      The description of the image pipeline.

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

    • imageRecipeArn

      CreateImagePipelineRequest.Builder imageRecipeArn(String imageRecipeArn)

      The Amazon Resource Name (ARN) of the image recipe that configures images created by this image pipeline. You must specify either this property or containerRecipeArn, but not both.

      Parameters:
      imageRecipeArn - The Amazon Resource Name (ARN) of the image recipe that configures images created by this image pipeline. 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

      CreateImagePipelineRequest.Builder containerRecipeArn(String containerRecipeArn)

      The Amazon Resource Name (ARN) of the container recipe that is used to configure images created by this container pipeline. You must specify either this property or imageRecipeArn, but not both.

      Parameters:
      containerRecipeArn - The Amazon Resource Name (ARN) of the container recipe that is used to configure images created by this container pipeline. 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.

    • infrastructureConfigurationArn

      CreateImagePipelineRequest.Builder infrastructureConfigurationArn(String infrastructureConfigurationArn)

      The Amazon Resource Name (ARN) of the infrastructure configuration that builds images created by this image pipeline.

      Parameters:
      infrastructureConfigurationArn - The Amazon Resource Name (ARN) of the infrastructure configuration that builds images created by this image pipeline.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • distributionConfigurationArn

      CreateImagePipelineRequest.Builder distributionConfigurationArn(String distributionConfigurationArn)

      The Amazon Resource Name (ARN) of the distribution configuration that configures and distributes images created by this image pipeline.

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

    • imageTestsConfiguration

      CreateImagePipelineRequest.Builder imageTestsConfiguration(ImageTestsConfiguration imageTestsConfiguration)

      Specifies the test settings that Image Builder applies to images that this pipeline creates. If you don't provide test settings, Image Builder stores a default configuration with image tests enabled.

      Parameters:
      imageTestsConfiguration - Specifies the test settings that Image Builder applies to images that this pipeline creates. If you don't provide test settings, Image Builder stores a default configuration with image tests enabled.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • imageTestsConfiguration

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

      Specifies the test settings that Image Builder applies to images that this pipeline creates. If you don't provide test settings, Image Builder stores a default configuration with image tests enabled.

      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

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

    • schedule

      CreateImagePipelineRequest.Builder schedule(Schedule schedule)

      The schedule of the image pipeline. If you don't provide a schedule, the pipeline runs only when you call StartImagePipelineExecution.

      Parameters:
      schedule - The schedule of the image pipeline. If you don't provide a schedule, the pipeline runs only when you call StartImagePipelineExecution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • schedule

      default CreateImagePipelineRequest.Builder schedule(Consumer<Schedule.Builder> schedule)

      The schedule of the image pipeline. If you don't provide a schedule, the pipeline runs only when you call StartImagePipelineExecution.

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

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

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

    • status

      CreateImagePipelineRequest.Builder status(String status)

      The status of the image pipeline. If you don't specify a status, it defaults to ENABLED. A disabled pipeline doesn't run on its schedule, but you can still start builds manually.

      Parameters:
      status - The status of the image pipeline. If you don't specify a status, it defaults to ENABLED. A disabled pipeline doesn't run on its schedule, but you can still start builds manually.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      CreateImagePipelineRequest.Builder status(PipelineStatus status)

      The status of the image pipeline. If you don't specify a status, it defaults to ENABLED. A disabled pipeline doesn't run on its schedule, but you can still start builds manually.

      Parameters:
      status - The status of the image pipeline. If you don't specify a status, it defaults to ENABLED. A disabled pipeline doesn't run on its schedule, but you can still start builds manually.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

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

      The tags of the image pipeline.

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

    • imageTags

      CreateImagePipelineRequest.Builder imageTags(Map<String,String> imageTags)

      The tags that Image Builder applies to the Image Builder image resource that this pipeline's scheduled executions create. These tags don't apply to the output AMI. To tag output AMIs, use amiTags in the pipeline's distribution configuration.

      Parameters:
      imageTags - The tags that Image Builder applies to the Image Builder image resource that this pipeline's scheduled executions create. These tags don't apply to the output AMI. To tag output AMIs, use amiTags in the pipeline's distribution configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientToken

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

      CreateImagePipelineRequest.Builder imageScanningConfiguration(ImageScanningConfiguration imageScanningConfiguration)

      Contains settings for vulnerability scans that Amazon Inspector runs against the test instance during image creation.

      Parameters:
      imageScanningConfiguration - Contains settings for vulnerability scans that Amazon Inspector runs against the test instance during image creation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • imageScanningConfiguration

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

      Contains settings for vulnerability scans that Amazon Inspector runs against the test instance during image creation.

      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

      CreateImagePipelineRequest.Builder workflows(Collection<WorkflowConfiguration> workflows)

      The array of workflow configuration objects for builds that this pipeline starts. You must also specify executionRole when you provide workflows.

      Parameters:
      workflows - The array of workflow configuration objects for builds that this pipeline starts. You must also specify executionRole when you provide workflows.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • workflows

      CreateImagePipelineRequest.Builder workflows(WorkflowConfiguration... workflows)

      The array of workflow configuration objects for builds that this pipeline starts. You must also specify executionRole when you provide workflows.

      Parameters:
      workflows - The array of workflow configuration objects for builds that this pipeline starts. You must also specify executionRole when you provide workflows.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • workflows

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

      The array of workflow configuration objects for builds that this pipeline starts. You must also specify executionRole when you provide workflows.

      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

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

    • loggingConfiguration

      CreateImagePipelineRequest.Builder loggingConfiguration(PipelineLoggingConfiguration loggingConfiguration)

      Specifies the logging configuration for the image pipeline. Use this to define custom CloudWatch Logs log groups for your pipeline execution logs and image build logs. The service manages log groups with names starting with /aws/imagebuilder/ using the service-linked role. For custom log group names outside of this prefix, you must also provide an executionRole.

      Parameters:
      loggingConfiguration - Specifies the logging configuration for the image pipeline. Use this to define custom CloudWatch Logs log groups for your pipeline execution logs and image build logs. The service manages log groups with names starting with /aws/imagebuilder/ using the service-linked role. For custom log group names outside of this prefix, you must also provide an executionRole.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • loggingConfiguration

      default CreateImagePipelineRequest.Builder loggingConfiguration(Consumer<PipelineLoggingConfiguration.Builder> loggingConfiguration)

      Specifies the logging configuration for the image pipeline. Use this to define custom CloudWatch Logs log groups for your pipeline execution logs and image build logs. The service manages log groups with names starting with /aws/imagebuilder/ using the service-linked role. For custom log group names outside of this prefix, you must also provide an executionRole.

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

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

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

    • dryRun

      CreateImagePipelineRequest.Builder dryRun(Boolean dryRun)

      Validates the required permissions and request parameters without performing the operation. If validation succeeds, the operation returns a DryRunOperationException error response.

      Parameters:
      dryRun - Validates the required permissions and request parameters without performing the operation. If validation succeeds, the operation returns a DryRunOperationException error response.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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