Package software.amazon.awssdk.services.imagebuilder.model

Interface CreateImageRecipeRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateImageRecipeRequest.Builder,CreateImageRecipeRequest>, ImagebuilderRequest.Builder, SdkBuilder<CreateImageRecipeRequest.Builder,CreateImageRecipeRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateImageRecipeRequest
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.

      Parameters:
      name - The name of the image recipe.
      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, with an upper limit of 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, with an upper limit of 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.

      Parameters:
      components - The components included in the image recipe.
      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.

      Parameters:
      components - The components included in the image recipe.
      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.

      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 of the image recipe. The value of the string can be the ARN of the base image or an AMI ID. The format for the ARN follows this example: arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/x.x.x. You can provide the specific version that you want to use, or you can use a wildcard in all of the fields. If you enter an AMI ID for the string value, you must have access to the AMI, and the AMI must be in the same Region in which you are using Image Builder.

      Parameters:
      parentImage - The base image of the image recipe. The value of the string can be the ARN of the base image or an AMI ID. The format for the ARN follows this example: arn:aws:imagebuilder:us-west-2:aws:image/windows-server-2016-english-full-base-x86/x.x.x. You can provide the specific version that you want to use, or you can use a wildcard in all of the fields. If you enter an AMI ID for the string value, you must have access to the AMI, and the AMI must be in the same Region in which you are using Image Builder.
      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 of the image recipe.

      Parameters:
      blockDeviceMappings - The block device mappings of the image recipe.
      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 of the image recipe.

      Parameters:
      blockDeviceMappings - The block device mappings of the image recipe.
      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 of the image 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:

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

      Parameters:
      workingDirectory - The working directory used during build and test workflows.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • additionalInstanceConfiguration

      CreateImageRecipeRequest.Builder additionalInstanceConfiguration(AdditionalInstanceConfiguration additionalInstanceConfiguration)

      Specify additional settings and launch scripts for your build instances.

      Parameters:
      additionalInstanceConfiguration - Specify 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)

      Specify 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:

    • clientToken

      CreateImageRecipeRequest.Builder clientToken(String clientToken)

      Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

      Parameters:
      clientToken - Unique, case-sensitive identifier you provide to ensure idempotency of the request. 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.

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