Updates an image pipeline¶

Description¶

Updates an image pipeline. Use image pipelines to automate the creation and distribution of images. You must specify exactly one recipe for your image, using either a containerRecipeArn or an imageRecipeArn. The recipe must be the same type, image or container, as the pipeline's current recipe.

UpdateImagePipeline does not support selective updates. The request replaces the pipeline's entire configuration, so include every setting that you want to keep. Any optional property that you omit is removed or reset to its default.

Usage¶

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

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 configures images created by this image pipeline. You must specify either this property or containerRecipeArn, but not both.

• containerRecipeArn

  The Amazon Resource Name (ARN) of the container recipe that is used to configure images created by this container pipeline. You must specify either this property or imageRecipeArn, but not both.

• infrastructureConfigurationArn

  [required] The Amazon Resource Name (ARN) of the infrastructure configuration that Image Builder uses to build images created by this image pipeline.

• distributionConfigurationArn

  The Amazon Resource Name (ARN) of the distribution configuration that Image Builder uses to configure and distribute images created by this image pipeline.

• imageTestsConfiguration

  Specifies the test settings that Image Builder applies to images that this pipeline creates. If you don't provide test settings, Image Builder stores a default configuration with image tests enabled.

• enhancedImageMetadataEnabled

  Specifies whether to collect additional information about the image being created, including the operating system (OS) version and package list. Defaults to true.

• schedule

  The schedule of the image pipeline. Because the update replaces the entire configuration, omitting this property removes any existing schedule. The pipeline then runs only when you call start_image_pipeline_execution.

• status

  The status of the image pipeline. Defaults to ENABLED when omitted. To keep a pipeline disabled, include this property set to DISABLED in your update request.

• 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.

• imageScanningConfiguration

  Contains settings for vulnerability scans that Amazon Inspector runs against the test instance during image creation.

• workflows

  The array of workflow configuration objects for builds that this pipeline starts. You must also specify executionRole when you provide workflows.

• loggingConfiguration

  Specifies the logging configuration for the image pipeline. Use this to define custom CloudWatch Logs log groups for your pipeline execution logs and image build logs. The service manages log groups with names starting with /aws/imagebuilder/ using the service-linked role. For custom log group names outside of this prefix, you must also provide an executionRole.

• executionRole

  The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions. If you omit this property, the pipeline reverts to the Image Builder service-linked role.

• imageTags

  The tags that Image Builder applies to the Image Builder image resource that this pipeline's scheduled executions create. These tags don't apply to the output AMI. To tag output AMIs, use amiTags in the pipeline's distribution configuration.

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",
    autoDisablePolicy = list(
      failureCount = 123
    )
  ),
  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"
    )
  ),
  loggingConfiguration = list(
    imageLogGroupName = "string",
    pipelineLogGroupName = "string"
  ),
  executionRole = "string",
  imageTags = list(
    "string"
  )
)