Creates a new container recipe¶

Description¶

Creates a new container recipe. Container recipes define how images are configured, tested, and assessed.

Usage¶

imagebuilder_create_container_recipe(containerType, name, description,
  semanticVersion, components, instanceConfiguration,
  dockerfileTemplateData, dockerfileTemplateUri, platformOverride,
  imageOsVersionOverride, parentImage, tags, workingDirectory,
  targetRepository, kmsKeyId, clientToken, dryRun)

Arguments¶

• containerType

  [required] The type of container to create.

• name

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

• semanticVersion

  [required] The semantic version of the container 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 container recipe. You can specify each component only one time in a recipe.

• instanceConfiguration

  A group of options that can be used to configure an instance for building and testing container images.

• dockerfileTemplateData

  The Dockerfile template used to build your image, as an inline data blob. You must specify exactly one of the dockerfileTemplateData or dockerfileTemplateUri properties. For the contextual variables that the template can include, see Create a new version of a container recipe in the EC2 Image Builder User Guide.

• dockerfileTemplateUri

  The Amazon S3 URI for the Dockerfile template that is used to build your container image. You must have permission to read the object. Image Builder reads the object once, when it creates the recipe, and stores its content in the recipe. Later changes to the S3 object don't affect the recipe. You must specify exactly one of the dockerfileTemplateData or dockerfileTemplateUri properties.

• platformOverride

  Specifies the operating system platform when you use a custom base image. Container recipes support only the Linux and Windows platforms.

• imageOsVersionOverride

  Specifies the operating system version for the base image. Use this property only when the base image is a container image from a registry. When the base image is an Image Builder image, the operating system version comes from the parent image.

• parentImage

  [required] The base image for the container recipe. This can be an Image Builder image resource ARN or a container image URI from a registry, for example amazonlinux:latest.

• tags

  Tags that are attached to the container recipe.

• workingDirectory

  The working directory for use during build and test workflows.

• targetRepository

  [required] The destination repository for the container image. The Amazon ECR repository must already exist in the Amazon Web Services Region where the build runs.

• kmsKeyId

  The Amazon Resource Name (ARN) that uniquely identifies which KMS key is used to encrypt the Dockerfile template. This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) in the Key Management Service Developer Guide.

• 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",
  containerRecipeArn = "string",
  latestVersionReferences = list(
    latestVersionArn = "string",
    latestMajorVersionArn = "string",
    latestMinorVersionArn = "string",
    latestPatchVersionArn = "string"
  )
)

Request syntax¶

svc$create_container_recipe(
  containerType = "DOCKER",
  name = "string",
  description = "string",
  semanticVersion = "string",
  components = list(
    list(
      componentArn = "string",
      parameters = list(
        list(
          name = "string",
          value = list(
            "string"
          )
        )
      )
    )
  ),
  instanceConfiguration = list(
    image = "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"
      )
    )
  ),
  dockerfileTemplateData = "string",
  dockerfileTemplateUri = "string",
  platformOverride = "Windows"|"Linux"|"macOS",
  imageOsVersionOverride = "string",
  parentImage = "string",
  tags = list(
    "string"
  ),
  workingDirectory = "string",
  targetRepository = list(
    service = "ECR",
    repositoryName = "string"
  ),
  kmsKeyId = "string",
  clientToken = "string",
  dryRun = TRUE|FALSE
)