Skip to content

Create Image Recipe

imagebuilder_create_image_recipe R Documentation

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, clientToken)

Arguments

name

[required] The name of the image recipe.
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, 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.
components

[required] The components included in the image recipe.
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, and the AMI must be in the source Region.
blockDeviceMappings

The block device mappings of the image recipe.
tags

The tags of the image recipe.
workingDirectory

The working directory used during build and test workflows.
additionalInstanceConfiguration

Specify additional settings and launch scripts for your build instances.
clientToken

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

Value

A list with the following syntax:

list(
  requestId = "string",
  clientToken = "string",
  imageRecipeArn = "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"
  ),
  clientToken = "string"
)