imagebuilder_update_image_pipeline: Updates an image pipeline

View source: R/imagebuilder_operations.R

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

See https://www.paws-r-sdk.com/docs/imagebuilder_update_image_pipeline/ for full documentation.

Usage

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

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.


paws.compute documentation built on Sept. 12, 2024, 6:12 a.m.