software.amazon.awssdk.services.imagebuilder.model

Interface CreateImagePipelineRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateImagePipelineRequest.Builder,CreateImagePipelineRequest>, ImagebuilderRequest.Builder, SdkBuilder<CreateImagePipelineRequest.Builder,CreateImagePipelineRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateImagePipelineRequest

public static interface CreateImagePipelineRequest.Builder
extends ImagebuilderRequest.Builder, SdkPojo, CopyableBuilder<CreateImagePipelineRequest.Builder,CreateImagePipelineRequest>

Method Summary

Modifier and Type	Method and Description
CreateImagePipelineRequest.Builder	clientToken(String clientToken) The idempotency token used to make this request idempotent.
CreateImagePipelineRequest.Builder	description(String description) The description of the image pipeline.
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.
CreateImagePipelineRequest.Builder	enhancedImageMetadataEnabled(Boolean enhancedImageMetadataEnabled) Collects additional information about the image being created, including the operating system (OS) version and package list.
CreateImagePipelineRequest.Builder	imageRecipeArn(String imageRecipeArn) The Amazon Resource Name (ARN) of the image recipe that will be used to configure images created by this image pipeline.
default CreateImagePipelineRequest.Builder	imageTestsConfiguration(Consumer<ImageTestsConfiguration.Builder> imageTestsConfiguration) The image test configuration of the image pipeline.
CreateImagePipelineRequest.Builder	imageTestsConfiguration(ImageTestsConfiguration imageTestsConfiguration) The image test configuration of the image pipeline.
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.
CreateImagePipelineRequest.Builder	name(String name) The name of the image pipeline.
CreateImagePipelineRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
CreateImagePipelineRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
default CreateImagePipelineRequest.Builder	schedule(Consumer<Schedule.Builder> schedule) The schedule of the image pipeline.
CreateImagePipelineRequest.Builder	schedule(Schedule schedule) The schedule of the image pipeline.
CreateImagePipelineRequest.Builder	status(PipelineStatus status) The status of the image pipeline.
CreateImagePipelineRequest.Builder	status(String status) The status of the image pipeline.
CreateImagePipelineRequest.Builder	tags(Map<String,String> tags) The tags of the image pipeline.

Methods inherited from interface software.amazon.awssdk.services.imagebuilder.model.ImagebuilderRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

name

CreateImagePipelineRequest.Builder name(String 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

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

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 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:

imageTestsConfiguration(ImageTestsConfiguration)

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

CreateImagePipelineRequest.Builder schedule(Schedule 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

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

The schedule of the image pipeline.

This is a convenience 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:

schedule(Schedule)

status

CreateImagePipelineRequest.Builder status(String 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:

PipelineStatus, PipelineStatus

status

CreateImagePipelineRequest.Builder status(PipelineStatus 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:

PipelineStatus, PipelineStatus

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.

clientToken

CreateImagePipelineRequest.Builder clientToken(String clientToken)

The idempotency token used to make this request idempotent.

Parameters:

clientToken - The idempotency token used to make this request idempotent.

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.