software.amazon.awssdk.services.imagebuilder.model

Interface ContainerRecipe.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ContainerRecipe.Builder,ContainerRecipe>, SdkBuilder<ContainerRecipe.Builder,ContainerRecipe>, SdkPojo

Enclosing class:

ContainerRecipe

public static interface ContainerRecipe.Builder
extends SdkPojo, CopyableBuilder<ContainerRecipe.Builder,ContainerRecipe>

Method Summary

Modifier and Type	Method and Description
ContainerRecipe.Builder	arn(String arn) The Amazon Resource Name (ARN) of the container recipe.
ContainerRecipe.Builder	components(Collection<ComponentConfiguration> components) Components for build and test that are included in the container recipe.
ContainerRecipe.Builder	components(ComponentConfiguration... components) Components for build and test that are included in the container recipe.
ContainerRecipe.Builder	components(Consumer<ComponentConfiguration.Builder>... components) Components for build and test that are included in the container recipe.
ContainerRecipe.Builder	containerType(ContainerType containerType) Specifies the type of container, such as Docker.
ContainerRecipe.Builder	containerType(String containerType) Specifies the type of container, such as Docker.
ContainerRecipe.Builder	dateCreated(String dateCreated) The date when this container recipe was created.
ContainerRecipe.Builder	description(String description) The description of the container recipe.
ContainerRecipe.Builder	dockerfileTemplateData(String dockerfileTemplateData) Dockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside.
ContainerRecipe.Builder	encrypted(Boolean encrypted) A flag that indicates if the target container is encrypted.
default ContainerRecipe.Builder	instanceConfiguration(Consumer<InstanceConfiguration.Builder> instanceConfiguration) A group of options that can be used to configure an instance for building and testing container images.
ContainerRecipe.Builder	instanceConfiguration(InstanceConfiguration instanceConfiguration) A group of options that can be used to configure an instance for building and testing container images.
ContainerRecipe.Builder	kmsKeyId(String kmsKeyId) Identifies which KMS key is used to encrypt the container image for distribution to the target Region.
ContainerRecipe.Builder	name(String name) The name of the container recipe.
ContainerRecipe.Builder	owner(String owner) The owner of the container recipe.
ContainerRecipe.Builder	parentImage(String parentImage) The base image for the container recipe.
ContainerRecipe.Builder	platform(Platform platform) The system platform for the container, such as Windows or Linux.
ContainerRecipe.Builder	platform(String platform) The system platform for the container, such as Windows or Linux.
ContainerRecipe.Builder	tags(Map<String,String> tags) Tags that are attached to the container recipe.
default ContainerRecipe.Builder	targetRepository(Consumer<TargetContainerRepository.Builder> targetRepository) The destination repository for the container image.
ContainerRecipe.Builder	targetRepository(TargetContainerRepository targetRepository) The destination repository for the container image.
ContainerRecipe.Builder	version(String version) The semantic version of the container recipe.
ContainerRecipe.Builder	workingDirectory(String workingDirectory) The working directory for use during build and test workflows.

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

arn

ContainerRecipe.Builder arn(String arn)

The Amazon Resource Name (ARN) of the container recipe.

Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:

1. Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.

2. Version ARNs have only the first three nodes: <major>.<minor>.<patch>

3. Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.

Parameters:

arn - The Amazon Resource Name (ARN) of the container recipe.

Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that object as follows:

1. Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off entirely, or they are specified as wildcards, for example: x.x.x.

2. Version ARNs have only the first three nodes: <major>.<minor>.<patch>

3. Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.

Returns:

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

containerType

ContainerRecipe.Builder containerType(String containerType)

Specifies the type of container, such as Docker.

Parameters:

containerType - Specifies the type of container, such as Docker.

Returns:

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

See Also:

ContainerType, ContainerType

containerType

ContainerRecipe.Builder containerType(ContainerType containerType)

Specifies the type of container, such as Docker.

Parameters:

containerType - Specifies the type of container, such as Docker.

Returns:

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

See Also:

ContainerType, ContainerType

name

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

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

platform

ContainerRecipe.Builder platform(String platform)

The system platform for the container, such as Windows or Linux.

Parameters:

platform - The system platform for the container, such as Windows or Linux.

Returns:

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

See Also:

Platform, Platform

platform

ContainerRecipe.Builder platform(Platform platform)

The system platform for the container, such as Windows or Linux.

Parameters:

platform - The system platform for the container, such as Windows or Linux.

Returns:

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

See Also:

Platform, Platform

owner

ContainerRecipe.Builder owner(String owner)

The owner of the container recipe.

Parameters:

owner - The owner of the container recipe.

Returns:

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

version

ContainerRecipe.Builder version(String version)

The semantic version of the container recipe.

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.

Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.

Parameters:

version - The semantic version of the container recipe.

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.

Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.

Returns:

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

components

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

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

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

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

ContainerRecipe.Builder dockerfileTemplateData(String dockerfileTemplateData)

Dockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside. The template data consists of contextual variables where Image Builder places build information or scripts, based on your container image recipe.

Parameters:

dockerfileTemplateData - Dockerfiles are text documents that are used to build Docker containers, and ensure that they contain all of the elements required by the application running inside. The template data consists of contextual variables where Image Builder places build information or scripts, based on your container image recipe.

Returns:

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

kmsKeyId

ContainerRecipe.Builder kmsKeyId(String kmsKeyId)

Identifies which KMS key is used to encrypt the container image for distribution to the target Region.

Parameters:

kmsKeyId - Identifies which KMS key is used to encrypt the container image for distribution to the target Region.

Returns:

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

encrypted

ContainerRecipe.Builder encrypted(Boolean encrypted)

A flag that indicates if the target container is encrypted.

Parameters:

encrypted - A flag that indicates if the target container is encrypted.

Returns:

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

parentImage

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

dateCreated

ContainerRecipe.Builder dateCreated(String dateCreated)

The date when this container recipe was created.

Parameters:

dateCreated - The date when this container recipe was created.

Returns:

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

tags

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

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

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