Package software.amazon.awscdk.services.imagebuilder

Class CfnContainerRecipe.Builder

java.lang.Object

software.amazon.awscdk.services.imagebuilder.CfnContainerRecipe.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnContainerRecipe>

Enclosing class:

CfnContainerRecipe

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

A fluent builder for CfnContainerRecipe.

Method Summary

Modifier and Type	Method	Description
CfnContainerRecipe	build()
CfnContainerRecipe.Builder	components(List<? extends Object> components)	Build and test components that are included in the container recipe.
CfnContainerRecipe.Builder	components(IResolvable components)	Build and test components that are included in the container recipe.
CfnContainerRecipe.Builder	containerType(String containerType)	Specifies the type of container, such as Docker.
static CfnContainerRecipe.Builder	create(software.constructs.Construct scope, String id)
CfnContainerRecipe.Builder	description(String description)	The description of the container recipe.
CfnContainerRecipe.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.
CfnContainerRecipe.Builder	dockerfileTemplateUri(String dockerfileTemplateUri)	The S3 URI for the Dockerfile that will be used to build your container image.
CfnContainerRecipe.Builder	imageOsVersionOverride(String imageOsVersionOverride)	Specifies the operating system version for the base image.
CfnContainerRecipe.Builder	instanceConfiguration(IResolvable instanceConfiguration)	A group of options that can be used to configure an instance for building and testing container images.
CfnContainerRecipe.Builder	instanceConfiguration(CfnContainerRecipe.InstanceConfigurationProperty instanceConfiguration)	A group of options that can be used to configure an instance for building and testing container images.
CfnContainerRecipe.Builder	kmsKeyId(String kmsKeyId)	Identifies which KMS key is used to encrypt the container image for distribution to the target Region.
CfnContainerRecipe.Builder	name(String name)	The name of the container recipe.
CfnContainerRecipe.Builder	parentImage(String parentImage)	The base image for the container recipe.
CfnContainerRecipe.Builder	platformOverride(String platformOverride)	Specifies the operating system platform when you use a custom base image.
CfnContainerRecipe.Builder	tags(Map<String,String> tags)	Tags that are attached to the container recipe.
CfnContainerRecipe.Builder	targetRepository(IResolvable targetRepository)	The destination repository for the container image.
CfnContainerRecipe.Builder	targetRepository(CfnContainerRecipe.TargetContainerRepositoryProperty targetRepository)	The destination repository for the container image.
CfnContainerRecipe.Builder	version(String version)	The semantic version of the container recipe.
CfnContainerRecipe.Builder	workingDirectory(String workingDirectory)	The working directory for use during build and test workflows.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnContainerRecipe.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnContainerRecipe.Builder.

components

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

Build and test components that are included in the container recipe.

Recipes require a minimum of one build component, and can have a maximum of 20 build and test components in any combination.

Parameters:

components - Build and test components that are included in the container recipe. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html#cfn-imagebuilder-containerrecipe-components

components

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

Build and test components that are included in the container recipe.

Recipes require a minimum of one build component, and can have a maximum of 20 build and test components in any combination.

Parameters:

components - Build and test components that are included in the container recipe. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html#cfn-imagebuilder-containerrecipe-components

containerType

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

Specifies the type of container, such as Docker.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html#cfn-imagebuilder-containerrecipe-containertype

name

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

The name of the container recipe.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html#cfn-imagebuilder-containerrecipe-name

parentImage

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

The base image for the container recipe.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html#cfn-imagebuilder-containerrecipe-parentimage

targetRepository

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

The destination repository for the container image.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html#cfn-imagebuilder-containerrecipe-targetrepository

targetRepository

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

The destination repository for the container image.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html#cfn-imagebuilder-containerrecipe-targetrepository

version

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

The semantic version of the container recipe.

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.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html#cfn-imagebuilder-containerrecipe-version

description

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

The description of the container recipe.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html#cfn-imagebuilder-containerrecipe-description

dockerfileTemplateData

@Stability(Stable)
public CfnContainerRecipe.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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html#cfn-imagebuilder-containerrecipe-dockerfiletemplatedata

dockerfileTemplateUri

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

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

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html#cfn-imagebuilder-containerrecipe-dockerfiletemplateuri

imageOsVersionOverride

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

Specifies the operating system version for the base image.

Parameters:

imageOsVersionOverride - Specifies the operating system version for the base image. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html#cfn-imagebuilder-containerrecipe-imageosversionoverride

instanceConfiguration

@Stability(Stable)
public CfnContainerRecipe.Builder instanceConfiguration(IResolvable 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html#cfn-imagebuilder-containerrecipe-instanceconfiguration

instanceConfiguration

@Stability(Stable)
public CfnContainerRecipe.Builder instanceConfiguration(CfnContainerRecipe.InstanceConfigurationProperty 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html#cfn-imagebuilder-containerrecipe-instanceconfiguration

kmsKeyId

@Stability(Stable)
public CfnContainerRecipe.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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html#cfn-imagebuilder-containerrecipe-kmskeyid

platformOverride

@Stability(Stable)
public CfnContainerRecipe.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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html#cfn-imagebuilder-containerrecipe-platformoverride

tags

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

Tags that are attached to the container recipe.

Parameters:

tags - Tags that are attached to the container recipe. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html#cfn-imagebuilder-containerrecipe-tags

workingDirectory

@Stability(Stable)
public CfnContainerRecipe.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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-containerrecipe.html#cfn-imagebuilder-containerrecipe-workingdirectory

build

@Stability(Stable)
public CfnContainerRecipe build()

Specified by:

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

Returns:

a newly built instance of CfnContainerRecipe.