Interface ImageRecipe.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<ImageRecipe.Builder,ImageRecipe>,SdkBuilder<ImageRecipe.Builder,ImageRecipe>,SdkPojo
- Enclosing class:
- ImageRecipe
public static interface ImageRecipe.Builder extends SdkPojo, CopyableBuilder<ImageRecipe.Builder,ImageRecipe>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default ImageRecipe.BuilderadditionalInstanceConfiguration(Consumer<AdditionalInstanceConfiguration.Builder> additionalInstanceConfiguration)Before you create a new AMI, Image Builder launches temporary Amazon EC2 instances to build and test your image configuration.ImageRecipe.BuilderadditionalInstanceConfiguration(AdditionalInstanceConfiguration additionalInstanceConfiguration)Before you create a new AMI, Image Builder launches temporary Amazon EC2 instances to build and test your image configuration.ImageRecipe.Builderarn(String arn)The Amazon Resource Name (ARN) of the image recipe.ImageRecipe.BuilderblockDeviceMappings(Collection<InstanceBlockDeviceMapping> blockDeviceMappings)The block device mappings to apply when creating images from this recipe.ImageRecipe.BuilderblockDeviceMappings(Consumer<InstanceBlockDeviceMapping.Builder>... blockDeviceMappings)The block device mappings to apply when creating images from this recipe.ImageRecipe.BuilderblockDeviceMappings(InstanceBlockDeviceMapping... blockDeviceMappings)The block device mappings to apply when creating images from this recipe.ImageRecipe.Buildercomponents(Collection<ComponentConfiguration> components)The components that are included in the image recipe.ImageRecipe.Buildercomponents(Consumer<ComponentConfiguration.Builder>... components)The components that are included in the image recipe.ImageRecipe.Buildercomponents(ComponentConfiguration... components)The components that are included in the image recipe.ImageRecipe.BuilderdateCreated(String dateCreated)The date on which this image recipe was created.ImageRecipe.Builderdescription(String description)The description of the image recipe.ImageRecipe.Buildername(String name)The name of the image recipe.ImageRecipe.Builderowner(String owner)The owner of the image recipe.ImageRecipe.BuilderparentImage(String parentImage)The base image of the image recipe.ImageRecipe.Builderplatform(String platform)The platform of the image recipe.ImageRecipe.Builderplatform(Platform platform)The platform of the image recipe.ImageRecipe.Buildertags(Map<String,String> tags)The tags of the image recipe.ImageRecipe.Buildertype(String type)Specifies which type of image is created by the recipe - an AMI or a container image.ImageRecipe.Buildertype(ImageType type)Specifies which type of image is created by the recipe - an AMI or a container image.ImageRecipe.Builderversion(String version)The version of the image recipe.ImageRecipe.BuilderworkingDirectory(String workingDirectory)The working directory to be used during build and test workflows.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
arn
ImageRecipe.Builder arn(String arn)
The Amazon Resource Name (ARN) of the image recipe.
- Parameters:
arn- The Amazon Resource Name (ARN) of the image recipe.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
type
ImageRecipe.Builder type(String type)
Specifies which type of image is created by the recipe - an AMI or a container image.
-
type
ImageRecipe.Builder type(ImageType type)
Specifies which type of image is created by the recipe - an AMI or a container image.
-
name
ImageRecipe.Builder name(String name)
The name of the image recipe.
- Parameters:
name- The name of the image recipe.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
description
ImageRecipe.Builder description(String description)
The description of the image recipe.
- Parameters:
description- The description of the image recipe.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
platform
ImageRecipe.Builder platform(String platform)
The platform of the image recipe.
-
platform
ImageRecipe.Builder platform(Platform platform)
The platform of the image recipe.
-
owner
ImageRecipe.Builder owner(String owner)
The owner of the image recipe.
- Parameters:
owner- The owner of the image recipe.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
version
ImageRecipe.Builder version(String version)
The version of the image recipe.
- Parameters:
version- The version of the image recipe.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
components
ImageRecipe.Builder components(Collection<ComponentConfiguration> 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. Recipes require a minimum of one build component, and can have a maximum of 20 build and test components in any combination.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
components
ImageRecipe.Builder components(ComponentConfiguration... 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. Recipes require a minimum of one build component, and can have a maximum of 20 build and test components in any combination.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
components
ImageRecipe.Builder components(Consumer<ComponentConfiguration.Builder>... 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.
This is a convenience method that creates an instance of theComponentConfiguration.Builderavoiding the need to create one manually viaComponentConfiguration.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#components(List.) - Parameters:
components- a consumer that will call methods onComponentConfiguration.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#components(java.util.Collection)
-
parentImage
ImageRecipe.Builder parentImage(String parentImage)
The base image of the image recipe.
- Parameters:
parentImage- The base image of the image recipe.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
blockDeviceMappings
ImageRecipe.Builder blockDeviceMappings(Collection<InstanceBlockDeviceMapping> 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
blockDeviceMappings
ImageRecipe.Builder blockDeviceMappings(InstanceBlockDeviceMapping... 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
blockDeviceMappings
ImageRecipe.Builder blockDeviceMappings(Consumer<InstanceBlockDeviceMapping.Builder>... blockDeviceMappings)
The block device mappings to apply when creating images from this recipe.
This is a convenience method that creates an instance of theInstanceBlockDeviceMapping.Builderavoiding the need to create one manually viaInstanceBlockDeviceMapping.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#blockDeviceMappings(List.) - Parameters:
blockDeviceMappings- a consumer that will call methods onInstanceBlockDeviceMapping.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#blockDeviceMappings(java.util.Collection)
-
dateCreated
ImageRecipe.Builder dateCreated(String dateCreated)
The date on which this image recipe was created.
- Parameters:
dateCreated- The date on which this image recipe was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
ImageRecipe.Builder tags(Map<String,String> tags)
The tags of the image recipe.
- Parameters:
tags- The tags of the image recipe.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
workingDirectory
ImageRecipe.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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
additionalInstanceConfiguration
ImageRecipe.Builder additionalInstanceConfiguration(AdditionalInstanceConfiguration 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. 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:
- Returns a reference to this object so that method calls can be chained together.
-
additionalInstanceConfiguration
default ImageRecipe.Builder additionalInstanceConfiguration(Consumer<AdditionalInstanceConfiguration.Builder> 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.
This is a convenience method that creates an instance of theAdditionalInstanceConfiguration.Builderavoiding the need to create one manually viaAdditionalInstanceConfiguration.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toadditionalInstanceConfiguration(AdditionalInstanceConfiguration).- Parameters:
additionalInstanceConfiguration- a consumer that will call methods onAdditionalInstanceConfiguration.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
additionalInstanceConfiguration(AdditionalInstanceConfiguration)
-
-