Interface CreateImagePipelineRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateImagePipelineRequest.Builder,
,CreateImagePipelineRequest> ImagebuilderRequest.Builder
,SdkBuilder<CreateImagePipelineRequest.Builder,
,CreateImagePipelineRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateImagePipelineRequest
-
Method Summary
Modifier and TypeMethodDescriptionclientToken
(String clientToken) Unique, case-sensitive identifier you provide to ensure idempotency of the request.containerRecipeArn
(String containerRecipeArn) The Amazon Resource Name (ARN) of the container recipe that is used to configure images created by this container pipeline.description
(String description) The description of the image pipeline.distributionConfigurationArn
(String distributionConfigurationArn) The Amazon Resource Name (ARN) of the distribution configuration that will be used to configure and distribute images created by this image pipeline.enhancedImageMetadataEnabled
(Boolean enhancedImageMetadataEnabled) Collects additional information about the image being created, including the operating system (OS) version and package list.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.imageRecipeArn
(String imageRecipeArn) The Amazon Resource Name (ARN) of the image recipe that will be used to configure images created by this image pipeline.imageScanningConfiguration
(Consumer<ImageScanningConfiguration.Builder> imageScanningConfiguration) Contains settings for vulnerability scans.imageScanningConfiguration
(ImageScanningConfiguration imageScanningConfiguration) Contains settings for vulnerability scans.imageTestsConfiguration
(Consumer<ImageTestsConfiguration.Builder> imageTestsConfiguration) The image test configuration of the image pipeline.imageTestsConfiguration
(ImageTestsConfiguration imageTestsConfiguration) The image test configuration of the image pipeline.infrastructureConfigurationArn
(String infrastructureConfigurationArn) The Amazon Resource Name (ARN) of the infrastructure configuration that will be used to build images created by this image pipeline.The name of the image pipeline.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.schedule
(Consumer<Schedule.Builder> schedule) The schedule of the image pipeline.The schedule of the image pipeline.The status of the image pipeline.status
(PipelineStatus status) The status of the image pipeline.The tags of the image pipeline.workflows
(Collection<WorkflowConfiguration> workflows) Contains an array of workflow configuration objects.workflows
(Consumer<WorkflowConfiguration.Builder>... workflows) Contains an array of workflow configuration objects.workflows
(WorkflowConfiguration... workflows) Contains an array of workflow configuration objects.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.imagebuilder.model.ImagebuilderRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
name
The name of the image pipeline.
- Parameters:
name
- The name of the image pipeline.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
The Amazon Resource Name (ARN) of the image recipe that will be used to configure images created by this image pipeline.
- Parameters:
imageRecipeArn
- The Amazon Resource Name (ARN) of the image recipe that will be used to configure images created by this image pipeline.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
containerRecipeArn
The Amazon Resource Name (ARN) of the container recipe that is used to configure images created by this container pipeline.
- Parameters:
containerRecipeArn
- The Amazon Resource Name (ARN) of the container recipe that is used to configure images created by this container pipeline.- 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 will be used to build images created by this image pipeline.
- Parameters:
infrastructureConfigurationArn
- The Amazon Resource Name (ARN) of the infrastructure configuration that will be used to build 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 will be used to configure and distribute images created by this image pipeline.
- Parameters:
distributionConfigurationArn
- The Amazon Resource Name (ARN) of the distribution configuration that will be used to configure and distribute 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) The image test configuration of the image pipeline.
- Parameters:
imageTestsConfiguration
- The image test configuration of the image pipeline.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
imageTestsConfiguration
default CreateImagePipelineRequest.Builder imageTestsConfiguration(Consumer<ImageTestsConfiguration.Builder> imageTestsConfiguration) The image test configuration of the image pipeline.
This is a convenience method that creates an instance of theImageTestsConfiguration.Builder
avoiding the need to create one manually viaImageTestsConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toimageTestsConfiguration(ImageTestsConfiguration)
.- Parameters:
imageTestsConfiguration
- a consumer that will call methods onImageTestsConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
enhancedImageMetadataEnabled
CreateImagePipelineRequest.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.
-
schedule
The schedule of the image pipeline.
- Parameters:
schedule
- The schedule of the image pipeline.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
schedule
The schedule of the image pipeline.
This is a convenience method that creates an instance of theSchedule.Builder
avoiding the need to create one manually viaSchedule.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toschedule(Schedule)
.- Parameters:
schedule
- a consumer that will call methods onSchedule.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
status
The status of the image pipeline.
- Parameters:
status
- The status of the image pipeline.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
status
The status of the image pipeline.
- Parameters:
status
- The status of the image pipeline.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-
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
CreateImagePipelineRequest.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 CreateImagePipelineRequest.Builder imageScanningConfiguration(Consumer<ImageScanningConfiguration.Builder> imageScanningConfiguration) Contains settings for vulnerability scans.
This is a convenience method that creates an instance of theImageScanningConfiguration.Builder
avoiding the need to create one manually viaImageScanningConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toimageScanningConfiguration(ImageScanningConfiguration)
.- Parameters:
imageScanningConfiguration
- a consumer that will call methods onImageScanningConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
Contains an array of workflow configuration objects.
This is a convenience method that creates an instance of theWorkflowConfiguration.Builder
avoiding the need to create one manually viaWorkflowConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toworkflows(List<WorkflowConfiguration>)
.- Parameters:
workflows
- a consumer that will call methods onWorkflowConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
CreateImagePipelineRequest.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
CreateImagePipelineRequest.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.
-