Skip to content

Create Container Recipe

imagebuilder_create_container_recipe R Documentation

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)

Arguments

containerType

[required] The type of container to create.

name

[required] The name of the container recipe.

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, 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] Components for build and test that are included in the container recipe. Recipes require a minimum of one build component, and can have a maximum of 20 build and test components in any combination.

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.

dockerfileTemplateUri

The Amazon S3 URI for the Dockerfile that will be used to build your container image.

platformOverride

Specifies the operating system platform when you use a custom base image.

imageOsVersionOverride

Specifies the operating system version for the base image.

parentImage

[required] The base image for the container recipe.

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.

kmsKeyId

Identifies which KMS key is used to encrypt the container image.

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",
  containerRecipeArn = "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",
  imageOsVersionOverride = "string",
  parentImage = "string",
  tags = list(
    "string"
  ),
  workingDirectory = "string",
  targetRepository = list(
    service = "ECR",
    repositoryName = "string"
  ),
  kmsKeyId = "string",
  clientToken = "string"
)