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 -
Method Summary
Modifier and TypeMethodDescriptionadditionalInstanceConfiguration(CfnImageRecipePropsMixin.AdditionalInstanceConfigurationProperty additionalInstanceConfiguration) Sets the value ofCfnImageRecipeMixinProps.getAdditionalInstanceConfiguration()additionalInstanceConfiguration(IResolvable additionalInstanceConfiguration) Sets the value ofCfnImageRecipeMixinProps.getAdditionalInstanceConfiguration()Sets the value ofCfnImageRecipeMixinProps.getAmiTags()amiTags(IResolvable amiTags) Sets the value ofCfnImageRecipeMixinProps.getAmiTags()blockDeviceMappings(List<? extends Object> blockDeviceMappings) Sets the value ofCfnImageRecipeMixinProps.getBlockDeviceMappings()blockDeviceMappings(IResolvable blockDeviceMappings) Sets the value ofCfnImageRecipeMixinProps.getBlockDeviceMappings()build()Builds the configured instance.components(List<? extends Object> components) Sets the value ofCfnImageRecipeMixinProps.getComponents()components(IResolvable components) Sets the value ofCfnImageRecipeMixinProps.getComponents()description(String description) Sets the value ofCfnImageRecipeMixinProps.getDescription()Sets the value ofCfnImageRecipeMixinProps.getName()parentImage(String parentImage) Sets the value ofCfnImageRecipeMixinProps.getParentImage()Sets the value ofCfnImageRecipeMixinProps.getTags()Sets the value ofCfnImageRecipeMixinProps.getVersion()workingDirectory(String workingDirectory) Sets the value ofCfnImageRecipeMixinProps.getWorkingDirectory()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
additionalInstanceConfiguration
@Stability(Stable) public CfnImageRecipeMixinProps.Builder additionalInstanceConfiguration(IResolvable additionalInstanceConfiguration) Sets the value ofCfnImageRecipeMixinProps.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 ofCfnImageRecipeMixinProps.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
Sets the value ofCfnImageRecipeMixinProps.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
Sets the value ofCfnImageRecipeMixinProps.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 CfnImageRecipeMixinProps.Builder blockDeviceMappings(IResolvable blockDeviceMappings) Sets the value ofCfnImageRecipeMixinProps.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 ofCfnImageRecipeMixinProps.getBlockDeviceMappings()- Parameters:
blockDeviceMappings- The block device mappings to apply when creating images from this recipe.- Returns:
this
-
components
Sets the value ofCfnImageRecipeMixinProps.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 ofCfnImageRecipeMixinProps.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
Sets the value ofCfnImageRecipeMixinProps.getDescription()- Parameters:
description- The description of the image recipe.- Returns:
this
-
name
Sets the value ofCfnImageRecipeMixinProps.getName()- Parameters:
name- The name of the image recipe.- Returns:
this
-
parentImage
Sets the value ofCfnImageRecipeMixinProps.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
Sets the value ofCfnImageRecipeMixinProps.getTags()- Parameters:
tags- The tags of the image recipe.- Returns:
this
-
version
Sets the value ofCfnImageRecipeMixinProps.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 ofCfnImageRecipeMixinProps.getWorkingDirectory()- Parameters:
workingDirectory- The working directory to be used during build and test workflows.- Returns:
this
-
build
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnImageRecipeMixinProps>- Returns:
- a new instance of
CfnImageRecipeMixinProps - Throws:
NullPointerException- if any required attribute was not provided
-