Interface ImageRecipe.Builder

All Superinterfaces:
Buildable, CopyableBuilder<ImageRecipe.Builder,ImageRecipe>, SdkBuilder<ImageRecipe.Builder,ImageRecipe>, SdkPojo
Enclosing class:
ImageRecipe
@Mutable @NotThreadSafe public static interface ImageRecipe.Builder extends SdkPojo, CopyableBuilder<ImageRecipe.Builder,ImageRecipe>

  • Method Details

    • 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)

      The output image type. For an image recipe, this is always AMI. Container images are built from container recipes, a separate resource. This field isn't currently returned in responses.

      Parameters:
      type - The output image type. For an image recipe, this is always AMI. Container images are built from container recipes, a separate resource. This field isn't currently returned in responses.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • type

      ImageRecipe.Builder type(ImageType type)

      The output image type. For an image recipe, this is always AMI. Container images are built from container recipes, a separate resource. This field isn't currently returned in responses.

      Parameters:
      type - The output image type. For an image recipe, this is always AMI. Container images are built from container recipes, a separate resource. This field isn't currently returned in responses.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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

      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:

    • 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. A recipe can contain a maximum of 20 build and test components in any combination, by default. This maximum is an adjustable quota. For more information, see EC2 Image Builder endpoints and quotas in the Amazon Web Services General Reference.

      Parameters:
      components - The components that are included in the image recipe. A recipe can contain a maximum of 20 build and test components in any combination, by default. This maximum is an adjustable quota. For more information, see EC2 Image Builder endpoints and quotas in the Amazon Web Services General Reference.
      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. A recipe can contain a maximum of 20 build and test components in any combination, by default. This maximum is an adjustable quota. For more information, see EC2 Image Builder endpoints and quotas in the Amazon Web Services General Reference.

      Parameters:
      components - The components that are included in the image recipe. A recipe can contain a maximum of 20 build and test components in any combination, by default. This maximum is an adjustable quota. For more information, see EC2 Image Builder endpoints and quotas in the Amazon Web Services General Reference.
      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. A recipe can contain a maximum of 20 build and test components in any combination, by default. This maximum is an adjustable quota. For more information, see EC2 Image Builder endpoints and quotas in the Amazon Web Services General Reference.

      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<ComponentConfiguration>).

      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:

    • parentImage

      ImageRecipe.Builder parentImage(String 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)

      • Amazon Web Services Systems Manager (SSM) Parameter Store Parameter, prefixed by ssm:, followed by the parameter name or ARN.

      • Amazon Web Services Marketplace product ID

      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)

      • Amazon Web Services Systems Manager (SSM) Parameter Store Parameter, prefixed by ssm:, followed by the parameter name or ARN.

      • Amazon Web Services Marketplace product ID

      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<InstanceBlockDeviceMapping>).

      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:

    • 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 used during build and test workflows. If you don't specify a working directory, Image Builder uses /tmp for Linux and macOS build instances, and C:/ for Windows build instances.

      Parameters:
      workingDirectory - The working directory used during build and test workflows. If you don't specify a working directory, Image Builder uses /tmp for Linux and macOS build instances, and C:/ for Windows build instances.
      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 Image Builder launches your build instance.

      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 Image Builder launches your build instance.
      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 Image Builder launches your build instance.

      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:

    • amiTags

      ImageRecipe.Builder amiTags(Map<String,String> amiTags)

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

      Parameters:
      amiTags - Tags that are applied to the AMI that Image Builder creates during the Build phase prior to image distribution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • amiWatermarks

      ImageRecipe.Builder amiWatermarks(Collection<String> amiWatermarks)

      The AMI watermark names attached 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.

      Parameters:
      amiWatermarks - The AMI watermark names attached 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:
      Returns a reference to this object so that method calls can be chained together.

    • amiWatermarks

      ImageRecipe.Builder amiWatermarks(String... amiWatermarks)

      The AMI watermark names attached 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.

      Parameters:
      amiWatermarks - The AMI watermark names attached 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:
      Returns a reference to this object so that method calls can be chained together.