Interface ImageRecipe.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<ImageRecipe.Builder,
,ImageRecipe> SdkBuilder<ImageRecipe.Builder,
,ImageRecipe> SdkPojo
- Enclosing class:
ImageRecipe
-
Method Summary
Modifier and TypeMethodDescriptiondefault 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.additionalInstanceConfiguration
(AdditionalInstanceConfiguration additionalInstanceConfiguration) Before you create a new AMI, Image Builder launches temporary Amazon EC2 instances to build and test your image configuration.The Amazon Resource Name (ARN) of the image recipe.blockDeviceMappings
(Collection<InstanceBlockDeviceMapping> blockDeviceMappings) The block device mappings to apply when creating images from this recipe.blockDeviceMappings
(Consumer<InstanceBlockDeviceMapping.Builder>... blockDeviceMappings) The block device mappings to apply when creating images from this recipe.blockDeviceMappings
(InstanceBlockDeviceMapping... blockDeviceMappings) The block device mappings to apply when creating images from this recipe.components
(Collection<ComponentConfiguration> components) The components that are included in the image recipe.components
(Consumer<ComponentConfiguration.Builder>... components) The components that are included in the image recipe.components
(ComponentConfiguration... components) The components that are included in the image recipe.dateCreated
(String dateCreated) The date on which this image recipe was created.description
(String description) The description of the image recipe.The name of the image recipe.The owner of the image recipe.parentImage
(String parentImage) The base image of the image recipe.The platform of the image recipe.The platform of the image recipe.The tags of the image recipe.Specifies which type of image is created by the recipe - an AMI or a container image.Specifies which type of image is created by the recipe - an AMI or a container image.The version of the image recipe.workingDirectory
(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 Details
-
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
Specifies which type of image is created by the recipe - an AMI or a container image.
- Parameters:
type
- Specifies which type of image is created by the recipe - an AMI or a container image.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
type
Specifies which type of image is created by the recipe - an AMI or a container image.
- Parameters:
type
- Specifies which type of image is created by the recipe - an AMI or a container image.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
The platform of the image recipe.
- Parameters:
platform
- The platform of the image recipe.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
platform
The platform of the image recipe.
- Parameters:
platform
- The platform of the image recipe.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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
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
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.Builder
avoiding the need to create one manually viaComponentConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocomponents(List<ComponentConfiguration>)
.- 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:
-
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
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
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.Builder
avoiding the need to create one manually viaInstanceBlockDeviceMapping.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toblockDeviceMappings(List<InstanceBlockDeviceMapping>)
.- 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:
-
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
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
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.Builder
avoiding the need to create one manually viaAdditionalInstanceConfiguration.builder()
.When the
Consumer
completes,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:
-