Package software.amazon.awscdk.cfnpropertymixins.services.imagebuilder

Class CfnContainerRecipePropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.imagebuilder.CfnContainerRecipePropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnContainerRecipePropsMixin>

Enclosing class:

CfnContainerRecipePropsMixin

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

A fluent builder for CfnContainerRecipePropsMixin.

Method Summary

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

Parameters:

options - Mixin options.

Returns:

a new instance of CfnContainerRecipePropsMixin.Builder.

create

@Stability(Stable)
public static CfnContainerRecipePropsMixin.Builder create()

Returns:

a new instance of CfnContainerRecipePropsMixin.Builder.

components

@Stability(Stable)
public CfnContainerRecipePropsMixin.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 CfnContainerRecipePropsMixin.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 CfnContainerRecipePropsMixin.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

description

@Stability(Stable)
public CfnContainerRecipePropsMixin.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 CfnContainerRecipePropsMixin.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 CfnContainerRecipePropsMixin.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 CfnContainerRecipePropsMixin.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 CfnContainerRecipePropsMixin.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 CfnContainerRecipePropsMixin.Builder instanceConfiguration(CfnContainerRecipePropsMixin.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 CfnContainerRecipePropsMixin.Builder kmsKeyId(String kmsKeyId)

The Amazon Resource Name (ARN) that uniquely identifies which KMS key is used to encrypt the container image for distribution to the target Region.

This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) in the AWS Key Management Service Developer Guide .

Parameters:

kmsKeyId - The Amazon Resource Name (ARN) that uniquely 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

name

@Stability(Stable)
public CfnContainerRecipePropsMixin.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 CfnContainerRecipePropsMixin.Builder parentImage(String parentImage)

The base image for customizations specified in the container recipe.

This can contain an Image Builder image resource ARN or a container image URI, for example amazonlinux:latest .

Parameters:

parentImage - The base image for customizations specified 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-parentimage

platformOverride

@Stability(Stable)
public CfnContainerRecipePropsMixin.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 CfnContainerRecipePropsMixin.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

targetRepository

@Stability(Stable)
public CfnContainerRecipePropsMixin.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 CfnContainerRecipePropsMixin.Builder targetRepository(CfnContainerRecipePropsMixin.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 CfnContainerRecipePropsMixin.Builder version(String version)

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

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.

Parameters:

version - The semantic version of the container recipe. This version follows the semantic version syntax. 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

workingDirectory

@Stability(Stable)
public CfnContainerRecipePropsMixin.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 CfnContainerRecipePropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnContainerRecipePropsMixin.