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 Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description CreateImageRequest.BuilderclientToken(String clientToken)Unique, case-sensitive identifier you provide to ensure idempotency of the request.CreateImageRequest.BuildercontainerRecipeArn(String containerRecipeArn)The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.CreateImageRequest.BuilderdistributionConfigurationArn(String distributionConfigurationArn)The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline.CreateImageRequest.BuilderenhancedImageMetadataEnabled(Boolean enhancedImageMetadataEnabled)Collects additional information about the image being created, including the operating system (OS) version and package list.CreateImageRequest.BuilderexecutionRole(String executionRole)The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.CreateImageRequest.BuilderimageRecipeArn(String imageRecipeArn)The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.default CreateImageRequest.BuilderimageScanningConfiguration(Consumer<ImageScanningConfiguration.Builder> imageScanningConfiguration)Contains settings for vulnerability scans.CreateImageRequest.BuilderimageScanningConfiguration(ImageScanningConfiguration imageScanningConfiguration)Contains settings for vulnerability scans.default CreateImageRequest.BuilderimageTestsConfiguration(Consumer<ImageTestsConfiguration.Builder> imageTestsConfiguration)The image tests configuration of the image.CreateImageRequest.BuilderimageTestsConfiguration(ImageTestsConfiguration imageTestsConfiguration)The image tests configuration of the image.CreateImageRequest.BuilderinfrastructureConfigurationArn(String infrastructureConfigurationArn)The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested.CreateImageRequest.BuilderoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)CreateImageRequest.BuilderoverrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)CreateImageRequest.Buildertags(Map<String,String> tags)The tags of the image.CreateImageRequest.Builderworkflows(Collection<WorkflowConfiguration> workflows)Contains an array of workflow configuration objects.CreateImageRequest.Builderworkflows(Consumer<WorkflowConfiguration.Builder>... workflows)Contains an array of workflow configuration objects.CreateImageRequest.Builderworkflows(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 Detail
-
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 theImageTestsConfiguration.Builderavoiding the need to create one manually viaImageTestsConfiguration.builder().When the
Consumercompletes,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:
imageTestsConfiguration(ImageTestsConfiguration)
-
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 theImageScanningConfiguration.Builderavoiding the need to create one manually viaImageScanningConfiguration.builder().When the
Consumercompletes,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:
imageScanningConfiguration(ImageScanningConfiguration)
-
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 theWorkflowConfiguration.Builderavoiding the need to create one manually viaWorkflowConfiguration.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#workflows(List.) - 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:
#workflows(java.util.Collection)
-
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)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
CreateImageRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-