Skip to content

Create Image

imagebuilder_create_image R Documentation

Creates a new image

Description

Creates a new image. This request will create a new image along with all of the configured output resources defined in the distribution configuration. You must specify exactly one recipe for your image, using either a ContainerRecipeArn or an ImageRecipeArn.

Usage

imagebuilder_create_image(imageRecipeArn, containerRecipeArn,
  distributionConfigurationArn, infrastructureConfigurationArn,
  imageTestsConfiguration, enhancedImageMetadataEnabled, tags,
  clientToken, imageScanningConfiguration, workflows, executionRole)

Arguments

imageRecipeArn

The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.

containerRecipeArn

The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.

distributionConfigurationArn

The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline.

infrastructureConfigurationArn

[required] The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested.

imageTestsConfiguration

The image tests configuration of the image.

enhancedImageMetadataEnabled

Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.

tags

The tags of the 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.

imageScanningConfiguration

Contains settings for vulnerability scans.

workflows

Contains an array of workflow configuration objects.

executionRole

The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.

Value

A list with the following syntax: 

list(
  requestId = "string",
  clientToken = "string",
  imageBuildVersionArn = "string"
)

Request syntax

svc$create_image(
  imageRecipeArn = "string",
  containerRecipeArn = "string",
  distributionConfigurationArn = "string",
  infrastructureConfigurationArn = "string",
  imageTestsConfiguration = list(
    imageTestsEnabled = TRUE|FALSE,
    timeoutMinutes = 123
  ),
  enhancedImageMetadataEnabled = TRUE|FALSE,
  tags = list(
    "string"
  ),
  clientToken = "string",
  imageScanningConfiguration = list(
    imageScanningEnabled = TRUE|FALSE,
    ecrConfiguration = list(
      repositoryName = "string",
      containerTags = list(
        "string"
      )
    )
  ),
  workflows = list(
    list(
      workflowArn = "string",
      parameters = list(
        list(
          name = "string",
          value = list(
            "string"
          )
        )
      ),
      parallelGroup = "string",
      onFailure = "CONTINUE"|"ABORT"
    )
  ),
  executionRole = "string"
)