Interface CreateImageRecipeRequest.Builder

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

  • Method Details

    • name

      CreateImageRecipeRequest.Builder name(String name)

      The name of the image recipe. The recipe name, combined with the semantic version, must be unique to your account in each Amazon Web Services Region. Image Builder generates the image recipe ARN from a normalized form of the name, so names that differ only in case, spaces, or underscores count as the same name.

      Parameters:
      name - The name of the image recipe. The recipe name, combined with the semantic version, must be unique to your account in each Amazon Web Services Region. Image Builder generates the image recipe ARN from a normalized form of the name, so names that differ only in case, spaces, or underscores count as the same name.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      CreateImageRecipeRequest.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.

    • semanticVersion

      CreateImageRecipeRequest.Builder semanticVersion(String semanticVersion)

      The semantic version of the image recipe. This version follows the semantic version syntax.

      The semantic version has four nodes: <major>.<minor>.<patch>/<build>. 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. The upper limit is 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.

      Parameters:
      semanticVersion - The semantic version of the image recipe. This version follows the semantic version syntax.

      The semantic version has four nodes: <major>.<minor>.<patch>/<build>. 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. The upper limit is 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:
      Returns a reference to this object so that method calls can be chained together.

    • components

      CreateImageRecipeRequest.Builder components(Collection<ComponentConfiguration> components)

      The components included in the image recipe. Components are optional. A recipe with no components bakes the base image without additional customization. You can specify each component only one time in a recipe. Components with a status of DEPRECATED or DISABLED can't be added to new recipes.

      Parameters:
      components - The components included in the image recipe. Components are optional. A recipe with no components bakes the base image without additional customization. You can specify each component only one time in a recipe. Components with a status of DEPRECATED or DISABLED can't be added to new recipes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • components

      CreateImageRecipeRequest.Builder components(ComponentConfiguration... components)

      The components included in the image recipe. Components are optional. A recipe with no components bakes the base image without additional customization. You can specify each component only one time in a recipe. Components with a status of DEPRECATED or DISABLED can't be added to new recipes.

      Parameters:
      components - The components included in the image recipe. Components are optional. A recipe with no components bakes the base image without additional customization. You can specify each component only one time in a recipe. Components with a status of DEPRECATED or DISABLED can't be added to new recipes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • components

      CreateImageRecipeRequest.Builder components(Consumer<ComponentConfiguration.Builder>... components)

      The components included in the image recipe. Components are optional. A recipe with no components bakes the base image without additional customization. You can specify each component only one time in a recipe. Components with a status of DEPRECATED or DISABLED can't be added to new recipes.

      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

      CreateImageRecipeRequest.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

      If you enter an AMI ID or an SSM parameter that contains the AMI ID, you must have access to the AMI. The AMI must also be in the Region where you're creating the recipe.

      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

      If you enter an AMI ID or an SSM parameter that contains the AMI ID, you must have access to the AMI. The AMI must also be in the Region where you're creating the recipe.

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

    • blockDeviceMappings

      CreateImageRecipeRequest.Builder blockDeviceMappings(Collection<InstanceBlockDeviceMapping> blockDeviceMappings)

      The block device mappings that Image Builder applies to the build instance and the output AMI. For example, you can override the size of the base image's root volume or attach additional EBS volumes.

      Parameters:
      blockDeviceMappings - The block device mappings that Image Builder applies to the build instance and the output AMI. For example, you can override the size of the base image's root volume or attach additional EBS volumes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • blockDeviceMappings

      CreateImageRecipeRequest.Builder blockDeviceMappings(InstanceBlockDeviceMapping... blockDeviceMappings)

      The block device mappings that Image Builder applies to the build instance and the output AMI. For example, you can override the size of the base image's root volume or attach additional EBS volumes.

      Parameters:
      blockDeviceMappings - The block device mappings that Image Builder applies to the build instance and the output AMI. For example, you can override the size of the base image's root volume or attach additional EBS volumes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • blockDeviceMappings

      CreateImageRecipeRequest.Builder blockDeviceMappings(Consumer<InstanceBlockDeviceMapping.Builder>... blockDeviceMappings)

      The block device mappings that Image Builder applies to the build instance and the output AMI. For example, you can override the size of the base image's root volume or attach additional EBS volumes.

      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:

    • tags

      CreateImageRecipeRequest.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

      CreateImageRecipeRequest.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

      CreateImageRecipeRequest.Builder additionalInstanceConfiguration(AdditionalInstanceConfiguration additionalInstanceConfiguration)

      The additional settings and launch scripts for your build instances.

      Parameters:
      additionalInstanceConfiguration - The additional settings and launch scripts for your build instances.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • additionalInstanceConfiguration

      default CreateImageRecipeRequest.Builder additionalInstanceConfiguration(Consumer<AdditionalInstanceConfiguration.Builder> additionalInstanceConfiguration)

      The additional settings and launch scripts for your build instances.

      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

      CreateImageRecipeRequest.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

      CreateImageRecipeRequest.Builder amiWatermarks(Collection<String> amiWatermarks)

      The AMI watermark names to attach to the output AMI from this recipe. AMI watermarks are lineage markers. They automatically propagate to derivative AMIs when the source AMI is copied or distributed across Regions or accounts.

      AMI watermarks are supported only for image recipes. AMIs with watermarks cannot be made public.

      Parameters:
      amiWatermarks - The AMI watermark names to attach to the output AMI from this recipe. AMI watermarks are lineage markers. They automatically propagate to derivative AMIs when the source AMI is copied or distributed across Regions or accounts.

      AMI watermarks are supported only for image recipes. AMIs with watermarks cannot be made public.

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

    • amiWatermarks

      CreateImageRecipeRequest.Builder amiWatermarks(String... amiWatermarks)

      The AMI watermark names to attach to the output AMI from this recipe. AMI watermarks are lineage markers. They automatically propagate to derivative AMIs when the source AMI is copied or distributed across Regions or accounts.

      AMI watermarks are supported only for image recipes. AMIs with watermarks cannot be made public.

      Parameters:
      amiWatermarks - The AMI watermark names to attach to the output AMI from this recipe. AMI watermarks are lineage markers. They automatically propagate to derivative AMIs when the source AMI is copied or distributed across Regions or accounts.

      AMI watermarks are supported only for image recipes. AMIs with watermarks cannot be made public.

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

    • clientToken

      CreateImageRecipeRequest.Builder clientToken(String clientToken)

      A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time. If you retry a request with the same client token, Image Builder returns the original response without running the operation again. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

      Parameters:
      clientToken - A unique, case-sensitive identifier you provide to ensure that the operation runs no more than one time. If you retry a request with the same client token, Image Builder returns the original response without running the operation again. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dryRun

      CreateImageRecipeRequest.Builder dryRun(Boolean dryRun)

      Validates the required permissions and request parameters without performing the operation. If validation succeeds, the operation returns a DryRunOperationException error response.

      Parameters:
      dryRun - Validates the required permissions and request parameters without performing the operation. If validation succeeds, the operation returns a DryRunOperationException error response.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreateImageRecipeRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateImageRecipeRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.