Package software.amazon.awscdk.services.imagebuilder

Class CfnImageRecipeProps.Builder

java.lang.Object

software.amazon.awscdk.services.imagebuilder.CfnImageRecipeProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnImageRecipeProps>

Enclosing interface:

CfnImageRecipeProps

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

A builder for CfnImageRecipeProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnImageRecipeProps.Builder	additionalInstanceConfiguration(IResolvable additionalInstanceConfiguration)	Sets the value of CfnImageRecipeProps.getAdditionalInstanceConfiguration()
CfnImageRecipeProps.Builder	additionalInstanceConfiguration(CfnImageRecipe.AdditionalInstanceConfigurationProperty additionalInstanceConfiguration)	Sets the value of CfnImageRecipeProps.getAdditionalInstanceConfiguration()
CfnImageRecipeProps.Builder	amiTags(Map<String,String> amiTags)	Sets the value of CfnImageRecipeProps.getAmiTags()
CfnImageRecipeProps.Builder	amiTags(IResolvable amiTags)	Sets the value of CfnImageRecipeProps.getAmiTags()
CfnImageRecipeProps.Builder	blockDeviceMappings(List<? extends Object> blockDeviceMappings)	Sets the value of CfnImageRecipeProps.getBlockDeviceMappings()
CfnImageRecipeProps.Builder	blockDeviceMappings(IResolvable blockDeviceMappings)	Sets the value of CfnImageRecipeProps.getBlockDeviceMappings()
CfnImageRecipeProps	build()	Builds the configured instance.
CfnImageRecipeProps.Builder	components(List<? extends Object> components)	Sets the value of CfnImageRecipeProps.getComponents()
CfnImageRecipeProps.Builder	components(IResolvable components)	Sets the value of CfnImageRecipeProps.getComponents()
CfnImageRecipeProps.Builder	description(String description)	Sets the value of CfnImageRecipeProps.getDescription()
CfnImageRecipeProps.Builder	name(String name)	Sets the value of CfnImageRecipeProps.getName()
CfnImageRecipeProps.Builder	parentImage(String parentImage)	Sets the value of CfnImageRecipeProps.getParentImage()
CfnImageRecipeProps.Builder	tags(Map<String,String> tags)	Sets the value of CfnImageRecipeProps.getTags()
CfnImageRecipeProps.Builder	version(String version)	Sets the value of CfnImageRecipeProps.getVersion()
CfnImageRecipeProps.Builder	workingDirectory(String workingDirectory)	Sets the value of CfnImageRecipeProps.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 CfnImageRecipeProps.Builder components(IResolvable components)

Sets the value of CfnImageRecipeProps.getComponents()

Parameters:

components - The components that are included in the image 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 CfnImageRecipeProps.Builder components(List<? extends Object> components)

Sets the value of CfnImageRecipeProps.getComponents()

Parameters:

components - The components that are included in the image 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

name

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

Sets the value of CfnImageRecipeProps.getName()

Parameters:

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

Returns:

this

parentImage

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

Sets the value of CfnImageRecipeProps.getParentImage()

Parameters:

parentImage - The base image for customizations specified in the image recipe. This parameter is required. 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

Returns:

this

version

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

Sets the value of CfnImageRecipeProps.getVersion()

Parameters:

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

Returns:

this

additionalInstanceConfiguration

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

Sets the value of CfnImageRecipeProps.getAdditionalInstanceConfiguration()

Parameters:

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.

Returns:

this

additionalInstanceConfiguration

@Stability(Stable)
public CfnImageRecipeProps.Builder additionalInstanceConfiguration(CfnImageRecipe.AdditionalInstanceConfigurationProperty additionalInstanceConfiguration)

Sets the value of CfnImageRecipeProps.getAdditionalInstanceConfiguration()

Parameters:

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.

Returns:

this

amiTags

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

Sets the value of CfnImageRecipeProps.getAmiTags()

Parameters:

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

Returns:

this

amiTags

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

Sets the value of CfnImageRecipeProps.getAmiTags()

Parameters:

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

Returns:

this

blockDeviceMappings

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

Sets the value of CfnImageRecipeProps.getBlockDeviceMappings()

Parameters:

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

Returns:

this

blockDeviceMappings

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

Sets the value of CfnImageRecipeProps.getBlockDeviceMappings()

Parameters:

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

Returns:

this

description

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

Sets the value of CfnImageRecipeProps.getDescription()

Parameters:

description - The description of the image recipe.

Returns:

this

tags

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

Sets the value of CfnImageRecipeProps.getTags()

Parameters:

tags - The tags of the image recipe.

Returns:

this

workingDirectory

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

Sets the value of CfnImageRecipeProps.getWorkingDirectory()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public CfnImageRecipeProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnImageRecipeProps

Throws:

NullPointerException - if any required attribute was not provided