Package software.amazon.awscdk.services.imagebuilder.alpha

Class ImageRecipeProps.Builder

java.lang.Object

software.amazon.awscdk.services.imagebuilder.alpha.ImageRecipeProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ImageRecipeProps>

Enclosing interface:

ImageRecipeProps

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

A builder for ImageRecipeProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ImageRecipeProps.Builder	amiTags(Map<String,String> amiTags)	Sets the value of ImageRecipeProps.getAmiTags()
ImageRecipeProps.Builder	baseImage(BaseImage baseImage)	Sets the value of ImageRecipeProps.getBaseImage()
ImageRecipeProps.Builder	blockDevices(List<? extends BlockDevice> blockDevices)	Sets the value of ImageRecipeProps.getBlockDevices()
ImageRecipeProps	build()	Builds the configured instance.
ImageRecipeProps.Builder	components(List<? extends ComponentConfiguration> components)	Sets the value of ImageRecipeProps.getComponents()
ImageRecipeProps.Builder	description(String description)	Sets the value of ImageRecipeProps.getDescription()
ImageRecipeProps.Builder	imageRecipeName(String imageRecipeName)	Sets the value of ImageRecipeProps.getImageRecipeName()
ImageRecipeProps.Builder	imageRecipeVersion(String imageRecipeVersion)	Sets the value of ImageRecipeProps.getImageRecipeVersion()
ImageRecipeProps.Builder	tags(Map<String,String> tags)	Sets the value of ImageRecipeProps.getTags()
ImageRecipeProps.Builder	uninstallSsmAgentAfterBuild(Boolean uninstallSsmAgentAfterBuild)	Sets the value of ImageRecipeProps.getUninstallSsmAgentAfterBuild()
ImageRecipeProps.Builder	userDataOverride(UserData userDataOverride)	Sets the value of ImageRecipeProps.getUserDataOverride()
ImageRecipeProps.Builder	workingDirectory(String workingDirectory)	Sets the value of ImageRecipeProps.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

baseImage

@Stability(Experimental)
public ImageRecipeProps.Builder baseImage(BaseImage baseImage)

Sets the value of ImageRecipeProps.getBaseImage()

Parameters:

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

Returns:

this

amiTags

@Stability(Experimental)
public ImageRecipeProps.Builder amiTags(Map<String,String> amiTags)

Sets the value of ImageRecipeProps.getAmiTags()

Parameters:

amiTags - The additional tags to assign to the output AMI generated by the build.

Returns:

this

blockDevices

@Stability(Experimental)
public ImageRecipeProps.Builder blockDevices(List<? extends BlockDevice> blockDevices)

Sets the value of ImageRecipeProps.getBlockDevices()

Parameters:

blockDevices - The block devices to attach to the instance used for building the image.

Returns:

this

components

@Stability(Experimental)
public ImageRecipeProps.Builder components(List<? extends ComponentConfiguration> components)

Sets the value of ImageRecipeProps.getComponents()

Parameters:

components - The list of component configurations to apply in the image build.

Returns:

this

description

@Stability(Experimental)
public ImageRecipeProps.Builder description(String description)

Sets the value of ImageRecipeProps.getDescription()

Parameters:

description - The description of the image recipe.

Returns:

this

imageRecipeName

@Stability(Experimental)
public ImageRecipeProps.Builder imageRecipeName(String imageRecipeName)

Sets the value of ImageRecipeProps.getImageRecipeName()

Parameters:

imageRecipeName - The name of the image recipe.

Returns:

this

imageRecipeVersion

@Stability(Experimental)
public ImageRecipeProps.Builder imageRecipeVersion(String imageRecipeVersion)

Sets the value of ImageRecipeProps.getImageRecipeVersion()

Parameters:

imageRecipeVersion - The version of the image recipe.

Returns:

this

tags

@Stability(Experimental)
public ImageRecipeProps.Builder tags(Map<String,String> tags)

Sets the value of ImageRecipeProps.getTags()

Parameters:

tags - The tags to apply to the image recipe.

Returns:

this

uninstallSsmAgentAfterBuild

@Stability(Experimental)
public ImageRecipeProps.Builder uninstallSsmAgentAfterBuild(Boolean uninstallSsmAgentAfterBuild)

Sets the value of ImageRecipeProps.getUninstallSsmAgentAfterBuild()

Parameters:

uninstallSsmAgentAfterBuild - Whether to uninstall the Systems Manager agent from your final build image, prior to creating the new AMI.

Returns:

this

userDataOverride

@Stability(Experimental)
public ImageRecipeProps.Builder userDataOverride(UserData userDataOverride)

Sets the value of ImageRecipeProps.getUserDataOverride()

Parameters:

userDataOverride - The user data commands to pass to Image Builder build and test EC2 instances. For Linux and macOS, Image Builder uses a default user data script to install the Systems Manager agent. If you override the user data, you must ensure to add commands to install Systems Manager agent, if it is not pre-installed on your base image.

Returns:

this

workingDirectory

@Stability(Experimental)
public ImageRecipeProps.Builder workingDirectory(String workingDirectory)

Sets the value of ImageRecipeProps.getWorkingDirectory()

Parameters:

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

Returns:

this

build

@Stability(Experimental)
public ImageRecipeProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of ImageRecipeProps

Throws:

NullPointerException - if any required attribute was not provided