software.amazon.awssdk.services.imagebuilder.model

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

Modifier and Type	Method and Description
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.
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.
ImageRecipe.Builder	arn(String arn) The Amazon Resource Name (ARN) of the image recipe.
ImageRecipe.Builder	blockDeviceMappings(Collection<InstanceBlockDeviceMapping> blockDeviceMappings) The block device mappings to apply when creating images from this recipe.
ImageRecipe.Builder	blockDeviceMappings(Consumer<InstanceBlockDeviceMapping.Builder>... blockDeviceMappings) The block device mappings to apply when creating images from this recipe.
ImageRecipe.Builder	blockDeviceMappings(InstanceBlockDeviceMapping... blockDeviceMappings) The block device mappings to apply when creating images from this recipe.
ImageRecipe.Builder	components(Collection<ComponentConfiguration> components) The components of the image recipe.
ImageRecipe.Builder	components(ComponentConfiguration... components) The components of the image recipe.
ImageRecipe.Builder	components(Consumer<ComponentConfiguration.Builder>... components) The components of the image recipe.
ImageRecipe.Builder	dateCreated(String dateCreated) The date on which this image recipe was created.
ImageRecipe.Builder	description(String description) The description of the image recipe.
ImageRecipe.Builder	name(String name) The name of the image recipe.
ImageRecipe.Builder	owner(String owner) The owner of the image recipe.
ImageRecipe.Builder	parentImage(String parentImage) The base image of the image recipe.
ImageRecipe.Builder	platform(Platform platform) The platform of the image recipe.
ImageRecipe.Builder	platform(String platform) The platform of the image recipe.
ImageRecipe.Builder	tags(Map<String,String> tags) The tags of the image recipe.
ImageRecipe.Builder	type(ImageType type) Specifies which type of image is created by the recipe - an AMI or a container image.
ImageRecipe.Builder	type(String type) Specifies which type of image is created by the recipe - an AMI or a container image.
ImageRecipe.Builder	version(String version) The version of the image recipe.
ImageRecipe.Builder	workingDirectory(String workingDirectory) The working directory to be used during build and test workflows.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

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.

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:

ImageType, ImageType

type

ImageRecipe.Builder type(ImageType 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:

ImageType, ImageType

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.

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, Platform

platform

ImageRecipe.Builder platform(Platform 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, Platform

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 of the image recipe.

Parameters:

components - The components of the image recipe.

Returns:

Returns a reference to this object so that method calls can be chained together.

components

ImageRecipe.Builder components(ComponentConfiguration... components)

The components of the image recipe.

Parameters:

components - The components of the image recipe.

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 of the image recipe.

This is a convenience method that creates an instance of the ComponentConfiguration.Builder avoiding the need to create one manually via ComponentConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #components(List).

Parameters:

components - a consumer that will call methods on ComponentConfiguration.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 the InstanceBlockDeviceMapping.Builder avoiding the need to create one manually via InstanceBlockDeviceMapping.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #blockDeviceMappings(List).

Parameters:

blockDeviceMappings - a consumer that will call methods on InstanceBlockDeviceMapping.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 the AdditionalInstanceConfiguration.Builder avoiding the need to create one manually via AdditionalInstanceConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to additionalInstanceConfiguration(AdditionalInstanceConfiguration).

Parameters:

additionalInstanceConfiguration - a consumer that will call methods on AdditionalInstanceConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

additionalInstanceConfiguration(AdditionalInstanceConfiguration)