Creates a new image recipe¶

Description¶

Creates a new image recipe. Image recipes define how images are configured, tested, and assessed.

Usage¶

imagebuilder_create_image_recipe(name, description, semanticVersion,
  components, parentImage, blockDeviceMappings, tags, workingDirectory,
  additionalInstanceConfiguration, amiTags, amiWatermarks, clientToken,
  dryRun)

Arguments¶

• name

  [required] 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.

• description

  The description of the image recipe.

• semanticVersion

  [required] 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.

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

• parentImage

  [required] 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.

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

• tags

  The tags of the image recipe.

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

• additionalInstanceConfiguration

  The additional settings and launch scripts for your build instances.

• amiTags

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

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

• clientToken

  [required] 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.

• dryRun

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

Value¶

A list with the following syntax:

list(
  requestId = "string",
  clientToken = "string",
  imageRecipeArn = "string",
  latestVersionReferences = list(
    latestVersionArn = "string",
    latestMajorVersionArn = "string",
    latestMinorVersionArn = "string",
    latestPatchVersionArn = "string"
  )
)

Request syntax¶

svc$create_image_recipe(
  name = "string",
  description = "string",
  semanticVersion = "string",
  components = list(
    list(
      componentArn = "string",
      parameters = list(
        list(
          name = "string",
          value = list(
            "string"
          )
        )
      )
    )
  ),
  parentImage = "string",
  blockDeviceMappings = list(
    list(
      deviceName = "string",
      ebs = list(
        encrypted = TRUE|FALSE,
        deleteOnTermination = TRUE|FALSE,
        iops = 123,
        kmsKeyId = "string",
        snapshotId = "string",
        volumeSize = 123,
        volumeType = "standard"|"io1"|"io2"|"gp2"|"gp3"|"sc1"|"st1",
        throughput = 123
      ),
      virtualName = "string",
      noDevice = "string"
    )
  ),
  tags = list(
    "string"
  ),
  workingDirectory = "string",
  additionalInstanceConfiguration = list(
    systemsManagerAgent = list(
      uninstallAfterBuild = TRUE|FALSE
    ),
    userDataOverride = "string"
  ),
  amiTags = list(
    "string"
  ),
  amiWatermarks = list(
    "string"
  ),
  clientToken = "string",
  dryRun = TRUE|FALSE
)