software.amazon.awssdk.services.imagebuilder.model

Interface CreateContainerRecipeRequest.Builder

All Superinterfaces:

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

Enclosing class:

CreateContainerRecipeRequest

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

Method Summary

Modifier and Type	Method and Description
CreateContainerRecipeRequest.Builder	clientToken(String clientToken) The client token used to make this request idempotent.
CreateContainerRecipeRequest.Builder	components(Collection<ComponentConfiguration> components) Components for build and test that are included in the container recipe.
CreateContainerRecipeRequest.Builder	components(ComponentConfiguration... components) Components for build and test that are included in the container recipe.
CreateContainerRecipeRequest.Builder	components(Consumer<ComponentConfiguration.Builder>... components) Components for build and test that are included in the container recipe.
CreateContainerRecipeRequest.Builder	containerType(ContainerType containerType) The type of container to create.
CreateContainerRecipeRequest.Builder	containerType(String containerType) The type of container to create.
CreateContainerRecipeRequest.Builder	description(String description) The description of the container recipe.
CreateContainerRecipeRequest.Builder	dockerfileTemplateData(String dockerfileTemplateData) The Dockerfile template used to build your image as an inline data blob.
CreateContainerRecipeRequest.Builder	dockerfileTemplateUri(String dockerfileTemplateUri) The Amazon S3 URI for the Dockerfile that will be used to build your container image.
CreateContainerRecipeRequest.Builder	imageOsVersionOverride(String imageOsVersionOverride) Specifies the operating system version for the base image.
default CreateContainerRecipeRequest.Builder	instanceConfiguration(Consumer<InstanceConfiguration.Builder> instanceConfiguration) A group of options that can be used to configure an instance for building and testing container images.
CreateContainerRecipeRequest.Builder	instanceConfiguration(InstanceConfiguration instanceConfiguration) A group of options that can be used to configure an instance for building and testing container images.
CreateContainerRecipeRequest.Builder	kmsKeyId(String kmsKeyId) Identifies which KMS key is used to encrypt the container image.
CreateContainerRecipeRequest.Builder	name(String name) The name of the container recipe.
CreateContainerRecipeRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateContainerRecipeRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateContainerRecipeRequest.Builder	parentImage(String parentImage) The base image for the container recipe.
CreateContainerRecipeRequest.Builder	platformOverride(Platform platformOverride) Specifies the operating system platform when you use a custom base image.
CreateContainerRecipeRequest.Builder	platformOverride(String platformOverride) Specifies the operating system platform when you use a custom base image.
CreateContainerRecipeRequest.Builder	semanticVersion(String semanticVersion) The semantic version of the container recipe.
CreateContainerRecipeRequest.Builder	tags(Map<String,String> tags) Tags that are attached to the container recipe.
default CreateContainerRecipeRequest.Builder	targetRepository(Consumer<TargetContainerRepository.Builder> targetRepository) The destination repository for the container image.
CreateContainerRecipeRequest.Builder	targetRepository(TargetContainerRepository targetRepository) The destination repository for the container image.
CreateContainerRecipeRequest.Builder	workingDirectory(String workingDirectory) The working directory for use during build and test workflows.

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

containerType

CreateContainerRecipeRequest.Builder containerType(String containerType)

The type of container to create.

Parameters:

containerType - The type of container to create.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ContainerType, ContainerType

containerType

CreateContainerRecipeRequest.Builder containerType(ContainerType containerType)

The type of container to create.

Parameters:

containerType - The type of container to create.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ContainerType, ContainerType

name

CreateContainerRecipeRequest.Builder name(String name)

The name of the container recipe.

Parameters:

name - The name of the container recipe.

Returns:

Returns a reference to this object so that method calls can be chained together.

description

CreateContainerRecipeRequest.Builder description(String description)

The description of the container recipe.

Parameters:

description - The description of the container recipe.

Returns:

Returns a reference to this object so that method calls can be chained together.

semanticVersion

CreateContainerRecipeRequest.Builder semanticVersion(String semanticVersion)

The semantic version of the container recipe. This version follows the semantic version syntax.

The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.

Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.

Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.

Parameters:

semanticVersion - The semantic version of the container recipe. This version follows the semantic version syntax.

The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.

Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.

Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.

Returns:

Returns a reference to this object so that method calls can be chained together.

components

CreateContainerRecipeRequest.Builder components(Collection<ComponentConfiguration> components)

Components for build and test that are included in the container recipe.

Parameters:

components - Components for build and test that are included in the container recipe.

Returns:

Returns a reference to this object so that method calls can be chained together.

components

CreateContainerRecipeRequest.Builder components(ComponentConfiguration... components)

Components for build and test that are included in the container recipe.

Parameters:

components - Components for build and test that are included in the container recipe.

Returns:

Returns a reference to this object so that method calls can be chained together.

components

CreateContainerRecipeRequest.Builder components(Consumer<ComponentConfiguration.Builder>... components)

Components for build and test that are included in the container recipe.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #components(List).

Parameters:

components - a consumer that will call methods on ComponentConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#components(java.util.Collection)

instanceConfiguration

CreateContainerRecipeRequest.Builder instanceConfiguration(InstanceConfiguration instanceConfiguration)

A group of options that can be used to configure an instance for building and testing container images.

Parameters:

instanceConfiguration - A group of options that can be used to configure an instance for building and testing container images.

Returns:

Returns a reference to this object so that method calls can be chained together.

instanceConfiguration

default CreateContainerRecipeRequest.Builder instanceConfiguration(Consumer<InstanceConfiguration.Builder> instanceConfiguration)

A group of options that can be used to configure an instance for building and testing container images.

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

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

Parameters:

instanceConfiguration - a consumer that will call methods on InstanceConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

instanceConfiguration(InstanceConfiguration)

dockerfileTemplateData

CreateContainerRecipeRequest.Builder dockerfileTemplateData(String dockerfileTemplateData)

The Dockerfile template used to build your image as an inline data blob.

Parameters:

dockerfileTemplateData - The Dockerfile template used to build your image as an inline data blob.

Returns:

Returns a reference to this object so that method calls can be chained together.

dockerfileTemplateUri

CreateContainerRecipeRequest.Builder dockerfileTemplateUri(String dockerfileTemplateUri)

The Amazon S3 URI for the Dockerfile that will be used to build your container image.

Parameters:

dockerfileTemplateUri - The Amazon S3 URI for the Dockerfile that will be used to build your container image.

Returns:

Returns a reference to this object so that method calls can be chained together.

platformOverride

CreateContainerRecipeRequest.Builder platformOverride(String platformOverride)

Specifies the operating system platform when you use a custom base image.

Parameters:

platformOverride - Specifies the operating system platform when you use a custom base image.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Platform, Platform

platformOverride

CreateContainerRecipeRequest.Builder platformOverride(Platform platformOverride)

Specifies the operating system platform when you use a custom base image.

Parameters:

platformOverride - Specifies the operating system platform when you use a custom base image.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Platform, Platform

imageOsVersionOverride

CreateContainerRecipeRequest.Builder imageOsVersionOverride(String imageOsVersionOverride)

Specifies the operating system version for the base image.

Parameters:

imageOsVersionOverride - Specifies the operating system version for the base image.

Returns:

Returns a reference to this object so that method calls can be chained together.

parentImage

CreateContainerRecipeRequest.Builder parentImage(String parentImage)

The base image for the container recipe.

Parameters:

parentImage - The base image for the container recipe.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

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

Tags that are attached to the container recipe.

Parameters:

tags - Tags that are attached to the container recipe.

Returns:

Returns a reference to this object so that method calls can be chained together.

workingDirectory

CreateContainerRecipeRequest.Builder workingDirectory(String workingDirectory)

The working directory for use during build and test workflows.

Parameters:

workingDirectory - The working directory for use during build and test workflows.

Returns:

Returns a reference to this object so that method calls can be chained together.

targetRepository

CreateContainerRecipeRequest.Builder targetRepository(TargetContainerRepository targetRepository)

The destination repository for the container image.

Parameters:

targetRepository - The destination repository for the container image.

Returns:

Returns a reference to this object so that method calls can be chained together.

targetRepository

default CreateContainerRecipeRequest.Builder targetRepository(Consumer<TargetContainerRepository.Builder> targetRepository)

The destination repository for the container image.

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

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

Parameters:

targetRepository - a consumer that will call methods on TargetContainerRepository.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

targetRepository(TargetContainerRepository)

kmsKeyId

CreateContainerRecipeRequest.Builder kmsKeyId(String kmsKeyId)

Identifies which KMS key is used to encrypt the container image.

Parameters:

kmsKeyId - Identifies which KMS key is used to encrypt the container image.

Returns:

Returns a reference to this object so that method calls can be chained together.

clientToken

CreateContainerRecipeRequest.Builder clientToken(String clientToken)

The client token used to make this request idempotent.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

CreateContainerRecipeRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateContainerRecipeRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder