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

Class CfnImageRecipePropsMixin.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnImageRecipePropsMixin>

Enclosing class:

CfnImageRecipePropsMixin

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

A fluent builder for CfnImageRecipePropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnImageRecipePropsMixin.Builder	additionalInstanceConfiguration(CfnImageRecipePropsMixin.AdditionalInstanceConfigurationProperty additionalInstanceConfiguration)	Before you create a new AMI, Image Builder launches temporary Amazon EC2 instances to build and test your image configuration.
CfnImageRecipePropsMixin.Builder	additionalInstanceConfiguration(IResolvable additionalInstanceConfiguration)	Before you create a new AMI, Image Builder launches temporary Amazon EC2 instances to build and test your image configuration.
CfnImageRecipePropsMixin.Builder	amiTags(Map<String,String> amiTags)	Tags that are applied to the AMI that Image Builder creates during the Build phase prior to image distribution.
CfnImageRecipePropsMixin.Builder	amiTags(IResolvable amiTags)	Tags that are applied to the AMI that Image Builder creates during the Build phase prior to image distribution.
CfnImageRecipePropsMixin.Builder	blockDeviceMappings(List<? extends Object> blockDeviceMappings)	The block device mappings to apply when creating images from this recipe.
CfnImageRecipePropsMixin.Builder	blockDeviceMappings(IResolvable blockDeviceMappings)	The block device mappings to apply when creating images from this recipe.
CfnImageRecipePropsMixin	build()
CfnImageRecipePropsMixin.Builder	components(List<? extends Object> components)	The components that are included in the image recipe.
CfnImageRecipePropsMixin.Builder	components(IResolvable components)	The components that are included in the image recipe.
static CfnImageRecipePropsMixin.Builder	create()
static CfnImageRecipePropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnImageRecipePropsMixin.Builder	description(String description)	The description of the image recipe.
CfnImageRecipePropsMixin.Builder	name(String name)	The name of the image recipe.
CfnImageRecipePropsMixin.Builder	parentImage(String parentImage)	The base image for customizations specified in the image recipe.
CfnImageRecipePropsMixin.Builder	tags(Map<String,String> tags)	The tags of the image recipe.
CfnImageRecipePropsMixin.Builder	version(String version)	The semantic version of the image recipe.
CfnImageRecipePropsMixin.Builder	workingDirectory(String workingDirectory)	The working directory to be used 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 CfnImageRecipePropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnImageRecipePropsMixin.Builder.

create

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

Returns:

a new instance of CfnImageRecipePropsMixin.Builder.

additionalInstanceConfiguration

@Stability(Stable)
public CfnImageRecipePropsMixin.Builder additionalInstanceConfiguration(IResolvable additionalInstanceConfiguration)

Before you create a new AMI, Image Builder launches temporary Amazon EC2 instances to build and test your image configuration.

Instance configuration adds a layer of control over those instances. You can define settings and add scripts to run when an instance is launched from your AMI.

Parameters:

additionalInstanceConfiguration - Before you create a new AMI, Image Builder launches temporary Amazon EC2 instances to build and test your image configuration. This parameter is required.

Returns:

this

See Also:

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

additionalInstanceConfiguration

@Stability(Stable)
public CfnImageRecipePropsMixin.Builder additionalInstanceConfiguration(CfnImageRecipePropsMixin.AdditionalInstanceConfigurationProperty additionalInstanceConfiguration)

Before you create a new AMI, Image Builder launches temporary Amazon EC2 instances to build and test your image configuration.

Instance configuration adds a layer of control over those instances. You can define settings and add scripts to run when an instance is launched from your AMI.

Parameters:

additionalInstanceConfiguration - Before you create a new AMI, Image Builder launches temporary Amazon EC2 instances to build and test your image configuration. This parameter is required.

Returns:

this

See Also:

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

amiTags

@Stability(Stable)
public CfnImageRecipePropsMixin.Builder amiTags(Map<String,String> amiTags)

Tags that are applied to the AMI that Image Builder creates during the Build phase prior to image distribution.

Parameters:

amiTags - Tags that are applied to the AMI that Image Builder creates during the Build phase prior to image distribution. This parameter is required.

Returns:

this

See Also:

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

amiTags

@Stability(Stable)
public CfnImageRecipePropsMixin.Builder amiTags(IResolvable amiTags)

Tags that are applied to the AMI that Image Builder creates during the Build phase prior to image distribution.

Parameters:

amiTags - Tags that are applied to the AMI that Image Builder creates during the Build phase prior to image distribution. This parameter is required.

Returns:

this

See Also:

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

blockDeviceMappings

@Stability(Stable)
public CfnImageRecipePropsMixin.Builder blockDeviceMappings(IResolvable blockDeviceMappings)

The block device mappings to apply when creating images from this recipe.

Parameters:

blockDeviceMappings - The block device mappings to apply when creating images from this recipe. This parameter is required.

Returns:

this

See Also:

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

blockDeviceMappings

@Stability(Stable)
public CfnImageRecipePropsMixin.Builder blockDeviceMappings(List<? extends Object> blockDeviceMappings)

The block device mappings to apply when creating images from this recipe.

Parameters:

blockDeviceMappings - The block device mappings to apply when creating images from this recipe. This parameter is required.

Returns:

this

See Also:

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

components

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

The components that are included in the image 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 - The components that are included in the image recipe. This parameter is required.

Returns:

this

See Also:

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

components

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

The components that are included in the image 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 - The components that are included in the image recipe. This parameter is required.

Returns:

this

See Also:

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

description

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

The description of the image recipe.

Parameters:

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

Returns:

this

See Also:

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

name

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

The name of the image recipe.

Parameters:

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

Returns:

this

See Also:

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

parentImage

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

The base image for customizations specified in the image recipe.

You can specify the parent image using one of the following options:

• AMI ID
• Image Builder image Amazon Resource Name (ARN)
• AWS Systems Manager (SSM) Parameter Store Parameter, prefixed by ssm: , followed by the parameter name or ARN.
• AWS Marketplace product ID

Parameters:

parentImage - The base image for customizations specified in the image recipe. This parameter is required.

Returns:

this

See Also:

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

tags

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

The tags of the image recipe.

Parameters:

tags - The tags of the image recipe. This parameter is required.

Returns:

this

See Also:

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

version

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

The semantic version of the image 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 image 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-imagerecipe.html#cfn-imagebuilder-imagerecipe-version

workingDirectory

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

The working directory to be used during build and test workflows.

Parameters:

workingDirectory - The working directory to be used during build and test workflows. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnImageRecipePropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnImageRecipePropsMixin.