Create Image Pipeline

imagebuilder_create_image_pipeline

R Documentation

Creates a new image pipeline¶

Description¶

Creates a new image pipeline. Image pipelines enable you to automate the creation and distribution of images.

Usage¶

imagebuilder_create_image_pipeline(name, description, imageRecipeArn,
  containerRecipeArn, infrastructureConfigurationArn,
  distributionConfigurationArn, imageTestsConfiguration,
  enhancedImageMetadataEnabled, schedule, status, tags, clientToken,
  imageScanningConfiguration, workflows, executionRole)

Arguments¶

name: [required] The name of the image pipeline.
description: The description of the image pipeline.
imageRecipeArn: The Amazon Resource Name (ARN) of the image recipe that will be used to configure images created by this image pipeline.
containerRecipeArn: The Amazon Resource Name (ARN) of the container recipe that is used to configure images created by this container pipeline.
infrastructureConfigurationArn: [required] The Amazon Resource Name (ARN) of the infrastructure configuration that will be used to build images created by this image pipeline.
distributionConfigurationArn: The Amazon Resource Name (ARN) of the distribution configuration that will be used to configure and distribute images created by this image pipeline.
imageTestsConfiguration: The image test configuration of the image pipeline.
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.
schedule: The schedule of the image pipeline.
status: The status of the image pipeline.
tags: The tags of the image pipeline.
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",
  imagePipelineArn = "string"
)

Request syntax¶

svc$create_image_pipeline(
  name = "string",
  description = "string",
  imageRecipeArn = "string",
  containerRecipeArn = "string",
  infrastructureConfigurationArn = "string",
  distributionConfigurationArn = "string",
  imageTestsConfiguration = list(
    imageTestsEnabled = TRUE|FALSE,
    timeoutMinutes = 123
  ),
  enhancedImageMetadataEnabled = TRUE|FALSE,
  schedule = list(
    scheduleExpression = "string",
    timezone = "string",
    pipelineExecutionStartCondition = "EXPRESSION_MATCH_ONLY"|"EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE"
  ),
  status = "DISABLED"|"ENABLED",
  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"
)