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

Class CfnImageRecipeMixinProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnImageRecipeMixinProps>

Enclosing interface:

CfnImageRecipeMixinProps

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

A builder for CfnImageRecipeMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

additionalInstanceConfiguration

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

Sets the value of CfnImageRecipeMixinProps.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 CfnImageRecipeMixinProps.Builder additionalInstanceConfiguration(CfnImageRecipePropsMixin.AdditionalInstanceConfigurationProperty additionalInstanceConfiguration)

Sets the value of CfnImageRecipeMixinProps.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 CfnImageRecipeMixinProps.Builder amiTags(IResolvable amiTags)

Sets the value of CfnImageRecipeMixinProps.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 CfnImageRecipeMixinProps.Builder amiTags(Map<String,String> amiTags)

Sets the value of CfnImageRecipeMixinProps.getAmiTags()

Parameters:

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

Returns:

this

amiWatermarks

@Stability(Stable)
public CfnImageRecipeMixinProps.Builder amiWatermarks(List<String> amiWatermarks)

Sets the value of CfnImageRecipeMixinProps.getAmiWatermarks()

Parameters:

amiWatermarks - The AMI watermark names to attach to the output AMI from this recipe. AMI watermarks are lineage markers that automatically propagate to derivative AMIs when the source AMI is copied or distributed.

Returns:

this

blockDeviceMappings

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

Sets the value of CfnImageRecipeMixinProps.getBlockDeviceMappings()

Parameters:

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

Returns:

this

blockDeviceMappings

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

Sets the value of CfnImageRecipeMixinProps.getBlockDeviceMappings()

Parameters:

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

Returns:

this

components

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

Sets the value of CfnImageRecipeMixinProps.getComponents()

Parameters:

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.

Returns:

this

components

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

Sets the value of CfnImageRecipeMixinProps.getComponents()

Parameters:

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.

Returns:

this

description

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

Sets the value of CfnImageRecipeMixinProps.getDescription()

Parameters:

description - The description of the image recipe.

Returns:

this

name

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

Sets the value of CfnImageRecipeMixinProps.getName()

Parameters:

name - The name of the image recipe.

Returns:

this

parentImage

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

Sets the value of CfnImageRecipeMixinProps.getParentImage()

Parameters:

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

Returns:

this

tags

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

Sets the value of CfnImageRecipeMixinProps.getTags()

Parameters:

tags - The tags of the image recipe.

Returns:

this

version

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

Sets the value of CfnImageRecipeMixinProps.getVersion()

Parameters:

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.

Returns:

this

workingDirectory

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

Sets the value of CfnImageRecipeMixinProps.getWorkingDirectory()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public CfnImageRecipeMixinProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnImageRecipeMixinProps

Throws:

NullPointerException - if any required attribute was not provided