Update Image Pipeline

imagebuilder_update_image_pipeline

R Documentation

Updates an image pipeline¶

Description¶

Updates an image pipeline. Image pipelines enable you to automate the creation and distribution of images. You must specify exactly one recipe for your image, using either a containerRecipeArn or an imageRecipeArn.

UpdateImagePipeline does not support selective updates for the pipeline. You must specify all of the required properties in the update request, not just the properties that have changed.

Usage¶

imagebuilder_update_image_pipeline(imagePipelineArn, description,
  imageRecipeArn, containerRecipeArn, infrastructureConfigurationArn,
  distributionConfigurationArn, imageTestsConfiguration,
  enhancedImageMetadataEnabled, schedule, status, clientToken,
  imageScanningConfiguration, workflows, executionRole)

Arguments¶

imagePipelineArn: [required] The Amazon Resource Name (ARN) of the image pipeline that you want to update.
description: The description of the image pipeline.
imageRecipeArn: The Amazon Resource Name (ARN) of the image recipe that will be used to configure images updated by this image pipeline.
containerRecipeArn: The Amazon Resource Name (ARN) of the container pipeline to update.
infrastructureConfigurationArn: [required] The Amazon Resource Name (ARN) of the infrastructure configuration that Image Builder uses to build images that this image pipeline has updated.
distributionConfigurationArn: The Amazon Resource Name (ARN) of the distribution configuration that Image Builder uses to configure and distribute images that this image pipeline has updated.
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.
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 the workflows to run for the pipeline.
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$update_image_pipeline(
  imagePipelineArn = "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",
  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"
)