[ aws . imagebuilder ]
Updates an image pipeline. Image pipelines enable you to automate the creation and distribution of images.
Note
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.
See also: AWS API Documentation
update-image-pipeline
--image-pipeline-arn <value>
[--description <value>]
[--image-recipe-arn <value>]
[--container-recipe-arn <value>]
--infrastructure-configuration-arn <value>
[--distribution-configuration-arn <value>]
[--image-tests-configuration <value>]
[--enhanced-image-metadata-enabled | --no-enhanced-image-metadata-enabled]
[--schedule <value>]
[--status <value>]
[--client-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
--image-pipeline-arn
(string)
The Amazon Resource Name (ARN) of the image pipeline that you want to update.
--description
(string)
The description of the image pipeline.
--image-recipe-arn
(string)
The Amazon Resource Name (ARN) of the image recipe that will be used to configure images updated by this image pipeline.
--container-recipe-arn
(string)
The Amazon Resource Name (ARN) of the container pipeline to update.
--infrastructure-configuration-arn
(string)
The Amazon Resource Name (ARN) of the infrastructure configuration that will be used to build images updated by this image pipeline.
--distribution-configuration-arn
(string)
The Amazon Resource Name (ARN) of the distribution configuration that will be used to configure and distribute images updated by this image pipeline.
--image-tests-configuration
(structure)
The image test configuration of the image pipeline.
imageTestsEnabled -> (boolean)
Determines if tests should run after building the image. Image Builder defaults to enable tests to run following the image build, before image distribution.
timeoutMinutes -> (integer)
The maximum time in minutes that tests are permitted to run.
Note
The timeoutMinutes attribute is not currently active. This value is ignored.
Shorthand Syntax:
imageTestsEnabled=boolean,timeoutMinutes=integerJSON Syntax:
{ "imageTestsEnabled": true|false, "timeoutMinutes": integer }
--enhanced-image-metadata-enabled
|--no-enhanced-image-metadata-enabled
(boolean)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
(structure)The schedule of the image pipeline.
scheduleExpression -> (string)
The cron expression determines how often EC2 Image Builder evaluates your
pipelineExecutionStartCondition
.For information on how to format a cron expression in Image Builder, see Use cron expressions in EC2 Image Builder .
timezone -> (string)
The timezone that applies to the scheduling expression. For example, “Etc/UTC”, “America/Los_Angeles” in the IANA timezone format . If not specified this defaults to UTC.
pipelineExecutionStartCondition -> (string)
The condition configures when the pipeline should trigger a new image build. When the
pipelineExecutionStartCondition
is set toEXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE
, and you use semantic version filters on the base image or components in your image recipe, EC2 Image Builder will build a new image only when there are new versions of the image or components in your recipe that match the semantic version filter. When it is set toEXPRESSION_MATCH_ONLY
, it will build a new image every time the CRON expression matches the current time. For semantic version syntax, see CreateComponent in the EC2 Image Builder API Reference .Shorthand Syntax:
scheduleExpression=string,timezone=string,pipelineExecutionStartCondition=stringJSON Syntax:
{ "scheduleExpression": "string", "timezone": "string", "pipelineExecutionStartCondition": "EXPRESSION_MATCH_ONLY"|"EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE" }
--status
(string)The status of the image pipeline.
Possible values:
DISABLED
ENABLED
--client-token
(string)The idempotency token used to make this request idempotent.
--cli-input-json
|--cli-input-yaml
(string) Reads arguments from the JSON string provided. The JSON string follows the format provided by--generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with--cli-input-yaml
.
--generate-cli-skeleton
(string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the valueinput
, prints a sample input JSON that can be used as an argument for--cli-input-json
. Similarly, if providedyaml-input
it will print a sample input YAML that can be used with--cli-input-yaml
. If provided with the valueoutput
, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.Global Options¶
--debug
(boolean)Turn on debug logging.
--endpoint-url
(string)Override command’s default URL with the given URL.
--no-verify-ssl
(boolean)By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)Disable automatic pagination.
--output
(string)The formatting style for command output.
json
text
table
yaml
yaml-stream
--query
(string)A JMESPath query to use in filtering the response data.
--profile
(string)Use a specific profile from your credential file.
--region
(string)The region to use. Overrides config/env settings.
--version
(string)Display the version of this tool.
--color
(string)Turn on/off color output.
on
off
auto
--no-sign-request
(boolean)Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format
(string)The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob
fileb://
will always be treated as binary and use the file contents directly regardless of thecli-binary-format
setting. When usingfile://
the file contents will need to properly formatted for the configuredcli-binary-format
.
base64
raw-in-base64-out
--no-cli-pager
(boolean)Disable cli pager for output.
--cli-auto-prompt
(boolean)Automatically prompt for CLI input parameters.
--no-cli-auto-prompt
(boolean)Disable automatically prompt for CLI input parameters.
Examples¶
Note
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To update an image pipeline
The following
update-image-pipeline
example updates an image pipeline using a JSON file.aws imagebuilder update-image-pipeline \ --cli-input-json file://update-image-pipeline.jsonContents of
update-image-pipeline.json
:{ "imagePipelineArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-pipeline/mywindows2016pipeline", "imageRecipeArn": "arn:aws:imagebuilder:us-west-2:123456789012:image-recipe/mybasicrecipe/2019.12.03", "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure", "distributionConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:distribution-configuration/myexampledistribution", "imageTestsConfiguration": { "imageTestsEnabled": true, "timeoutMinutes": 120 }, "schedule": { "scheduleExpression": "cron(0 0 * * MON)", "pipelineExecutionStartCondition": "EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE" }, "status": "DISABLED" }Output:
{ "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" }For more information, see Setting Up and Managing an EC2 Image Builder Image Pipeline Using the AWS CLI in the EC2 Image Builder Users Guide.
Output¶
requestId -> (string)
The request ID that uniquely identifies this request.
clientToken -> (string)
The idempotency token used to make this request idempotent.
imagePipelineArn -> (string)
The Amazon Resource Name (ARN) of the image pipeline that was updated by this request.