Package software.amazon.awscdk.services.imagebuilder

Class CfnContainerRecipeProps.Builder

java.lang.Object

software.amazon.awscdk.services.imagebuilder.CfnContainerRecipeProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnContainerRecipeProps>

Enclosing interface:

CfnContainerRecipeProps

@Stability(Stable)
public static final class CfnContainerRecipeProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnContainerRecipeProps>

A builder for CfnContainerRecipeProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnContainerRecipeProps	build()	Builds the configured instance.
CfnContainerRecipeProps.Builder	components(List<? extends Object> components)	Sets the value of CfnContainerRecipeProps.getComponents()
CfnContainerRecipeProps.Builder	components(IResolvable components)	Sets the value of CfnContainerRecipeProps.getComponents()
CfnContainerRecipeProps.Builder	containerType(String containerType)	Sets the value of CfnContainerRecipeProps.getContainerType()
CfnContainerRecipeProps.Builder	description(String description)	Sets the value of CfnContainerRecipeProps.getDescription()
CfnContainerRecipeProps.Builder	dockerfileTemplateData(String dockerfileTemplateData)	Sets the value of CfnContainerRecipeProps.getDockerfileTemplateData()
CfnContainerRecipeProps.Builder	dockerfileTemplateUri(String dockerfileTemplateUri)	Sets the value of CfnContainerRecipeProps.getDockerfileTemplateUri()
CfnContainerRecipeProps.Builder	imageOsVersionOverride(String imageOsVersionOverride)	Sets the value of CfnContainerRecipeProps.getImageOsVersionOverride()
CfnContainerRecipeProps.Builder	instanceConfiguration(IResolvable instanceConfiguration)	Sets the value of CfnContainerRecipeProps.getInstanceConfiguration()
CfnContainerRecipeProps.Builder	instanceConfiguration(CfnContainerRecipe.InstanceConfigurationProperty instanceConfiguration)	Sets the value of CfnContainerRecipeProps.getInstanceConfiguration()
CfnContainerRecipeProps.Builder	kmsKeyId(String kmsKeyId)	Sets the value of CfnContainerRecipeProps.getKmsKeyId()
CfnContainerRecipeProps.Builder	name(String name)	Sets the value of CfnContainerRecipeProps.getName()
CfnContainerRecipeProps.Builder	parentImage(String parentImage)	Sets the value of CfnContainerRecipeProps.getParentImage()
CfnContainerRecipeProps.Builder	platformOverride(String platformOverride)	Sets the value of CfnContainerRecipeProps.getPlatformOverride()
CfnContainerRecipeProps.Builder	tags(Map<String,String> tags)	Sets the value of CfnContainerRecipeProps.getTags()
CfnContainerRecipeProps.Builder	targetRepository(IResolvable targetRepository)	Sets the value of CfnContainerRecipeProps.getTargetRepository()
CfnContainerRecipeProps.Builder	targetRepository(CfnContainerRecipe.TargetContainerRepositoryProperty targetRepository)	Sets the value of CfnContainerRecipeProps.getTargetRepository()
CfnContainerRecipeProps.Builder	version(String version)	Sets the value of CfnContainerRecipeProps.getVersion()
CfnContainerRecipeProps.Builder	workingDirectory(String workingDirectory)	Sets the value of CfnContainerRecipeProps.getWorkingDirectory()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

components

@Stability(Stable)
public CfnContainerRecipeProps.Builder components(IResolvable components)

Sets the value of CfnContainerRecipeProps.getComponents()

Parameters:

components - Build and test components that are included in the container recipe. This parameter is required. Recipes require a minimum of one build component, and can have a maximum of 20 build and test components in any combination.

Returns:

this

components

@Stability(Stable)
public CfnContainerRecipeProps.Builder components(List<? extends Object> components)

Sets the value of CfnContainerRecipeProps.getComponents()

Parameters:

components - Build and test components that are included in the container recipe. This parameter is required. Recipes require a minimum of one build component, and can have a maximum of 20 build and test components in any combination.

Returns:

this

containerType

@Stability(Stable)
public CfnContainerRecipeProps.Builder containerType(String containerType)

Sets the value of CfnContainerRecipeProps.getContainerType()

Parameters:

containerType - Specifies the type of container, such as Docker. This parameter is required.

Returns:

this

name

@Stability(Stable)
public CfnContainerRecipeProps.Builder name(String name)

Sets the value of CfnContainerRecipeProps.getName()

Parameters:

name - The name of the container recipe. This parameter is required.

Returns:

this

parentImage

@Stability(Stable)
public CfnContainerRecipeProps.Builder parentImage(String parentImage)

Sets the value of CfnContainerRecipeProps.getParentImage()

Parameters:

parentImage - The base image for the container recipe. This parameter is required.

Returns:

this

targetRepository

@Stability(Stable)
public CfnContainerRecipeProps.Builder targetRepository(IResolvable targetRepository)

Sets the value of CfnContainerRecipeProps.getTargetRepository()

Parameters:

targetRepository - The destination repository for the container image. This parameter is required.

Returns:

this

targetRepository

@Stability(Stable)
public CfnContainerRecipeProps.Builder targetRepository(CfnContainerRecipe.TargetContainerRepositoryProperty targetRepository)

Sets the value of CfnContainerRecipeProps.getTargetRepository()

Parameters:

targetRepository - The destination repository for the container image. This parameter is required.

Returns:

this

version

@Stability(Stable)
public CfnContainerRecipeProps.Builder version(String version)

Sets the value of CfnContainerRecipeProps.getVersion()

Parameters:

version - The semantic version of the container recipe. This parameter is required.

The semantic version has four nodes: ../. 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:

this

description

@Stability(Stable)
public CfnContainerRecipeProps.Builder description(String description)

Sets the value of CfnContainerRecipeProps.getDescription()

Parameters:

description - The description of the container recipe.

Returns:

this

dockerfileTemplateData

@Stability(Stable)
public CfnContainerRecipeProps.Builder dockerfileTemplateData(String dockerfileTemplateData)

Sets the value of CfnContainerRecipeProps.getDockerfileTemplateData()

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:

this

dockerfileTemplateUri

@Stability(Stable)
public CfnContainerRecipeProps.Builder dockerfileTemplateUri(String dockerfileTemplateUri)

Sets the value of CfnContainerRecipeProps.getDockerfileTemplateUri()

Parameters:

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

Returns:

this

imageOsVersionOverride

@Stability(Stable)
public CfnContainerRecipeProps.Builder imageOsVersionOverride(String imageOsVersionOverride)

Sets the value of CfnContainerRecipeProps.getImageOsVersionOverride()

Parameters:

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

Returns:

this

instanceConfiguration

@Stability(Stable)
public CfnContainerRecipeProps.Builder instanceConfiguration(IResolvable instanceConfiguration)

Sets the value of CfnContainerRecipeProps.getInstanceConfiguration()

Parameters:

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

Returns:

this

instanceConfiguration

@Stability(Stable)
public CfnContainerRecipeProps.Builder instanceConfiguration(CfnContainerRecipe.InstanceConfigurationProperty instanceConfiguration)

Sets the value of CfnContainerRecipeProps.getInstanceConfiguration()

Parameters:

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

Returns:

this

kmsKeyId

@Stability(Stable)
public CfnContainerRecipeProps.Builder kmsKeyId(String kmsKeyId)

Sets the value of CfnContainerRecipeProps.getKmsKeyId()

Parameters:

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

Returns:

this

platformOverride

@Stability(Stable)
public CfnContainerRecipeProps.Builder platformOverride(String platformOverride)

Sets the value of CfnContainerRecipeProps.getPlatformOverride()

Parameters:

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

Returns:

this

tags

@Stability(Stable)
public CfnContainerRecipeProps.Builder tags(Map<String,String> tags)

Sets the value of CfnContainerRecipeProps.getTags()

Parameters:

tags - Tags that are attached to the container recipe.

Returns:

this

workingDirectory

@Stability(Stable)
public CfnContainerRecipeProps.Builder workingDirectory(String workingDirectory)

Sets the value of CfnContainerRecipeProps.getWorkingDirectory()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public CfnContainerRecipeProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnContainerRecipeProps>

Returns:

a new instance of CfnContainerRecipeProps

Throws:

NullPointerException - if any required attribute was not provided