AWS CLI Command Reference

[ aws . imagebuilder ]

update-infrastructure-configuration

Description

Updates an infrastructure configuration. An infrastructure configuration defines the environment in which Image Builder builds and tests your image.

Note

This operation doesn’t support selective updates. The request replaces the configuration, so include every setting that you want to keep. Omitted optional properties are cleared.

See also: AWS API Documentation

Synopsis

  update-infrastructure-configuration
--infrastructure-configuration-arn <value>
[--description <value>]
[--instance-types <value>]
--instance-profile-name <value>
[--security-group-ids <value>]
[--subnet-id <value>]
[--logging <value>]
[--key-pair <value>]
[--terminate-instance-on-failure | --no-terminate-instance-on-failure]
[--sns-topic-arn <value>]
[--resource-tags <value>]
[--instance-metadata-options <value>]
[--placement <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]
[--cli-error-format <value>]

Options

--infrastructure-configuration-arn (string) [required]

The Amazon Resource Name (ARN) of the infrastructure configuration that you want to update.

Constraints:

  • pattern: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):infrastructure-configuration/[a-z0-9-_]+$

--description (string)

The description of the infrastructure configuration.

Constraints:

  • min: 1
  • max: 1024

--instance-types (list)

The instance types of the infrastructure configuration. You can specify one or more instance types to use for this build. Image Builder picks one of these instance types based on availability. If you don’t specify instance types, Image Builder selects compatible instance types automatically. If you specify a Dedicated Host, Image Builder uses only instance types that the host supports.

(string)

Syntax:

"string" "string" ...

--instance-profile-name (string) [required]

The instance profile to associate with the instance used to customize your Amazon EC2 AMI. The instance profile must exist in your account.

Constraints:

  • min: 1
  • max: 256
  • pattern: ^[\w+=,.@-]+$

--security-group-ids (list)

The security group IDs to associate with the instance used to customize your Amazon EC2 AMI.

(string)

Constraints:

  • min: 1
  • max: 1024

Syntax:

"string" "string" ...

--subnet-id (string)

The subnet ID in which to place the instance used to customize your Amazon EC2 AMI. If you specify subnetId , you must also specify one or more security group IDs in securityGroupIds . Otherwise, the request fails.

Constraints:

  • min: 1
  • max: 1024

--logging (structure)

The logging configuration of the infrastructure configuration. When you configure S3 logs, Image Builder writes logs from the build and test process to the specified bucket under the key prefix.

s3Logs -> (structure)

The Amazon S3 logging configuration.

s3BucketName -> (string)

The name of an existing Amazon S3 bucket where Image Builder saves build logs. The bucket isn’t validated when you create or update the configuration, and Image Builder doesn’t create it. The instance profile associated with this infrastructure configuration must have permission to write to the bucket.

Constraints:

  • min: 1
  • max: 1024

s3KeyPrefix -> (string)

The Amazon S3 key prefix under which Image Builder writes build and test logs in the bucket.

Constraints:

  • min: 1
  • max: 1024

Shorthand Syntax:

s3Logs={s3BucketName=string,s3KeyPrefix=string}

JSON Syntax:

{
  "s3Logs": {
    "s3BucketName": "string",
    "s3KeyPrefix": "string"
  }
}

--key-pair (string)

The key pair of the infrastructure configuration. You can use this to log on to and debug the instance used to create your image.

Constraints:

  • min: 1
  • max: 1024

--terminate-instance-on-failure | --no-terminate-instance-on-failure (boolean)

Specifies whether to terminate the instance on failure. Set to false if you want Image Builder to retain the instance used to configure your AMI if the build or test phase of your workflow fails. Defaults to true .

--sns-topic-arn (string)

The Amazon Resource Name (ARN) of the SNS topic to which Image Builder sends image build event notifications. Specify a standard topic. Image Builder doesn’t support FIFO topics. Image Builder validates the topic when you create or update the configuration. You must have permission to publish to the topic.

Note

EC2 Image Builder can’t send notifications to SNS topics that are encrypted using keys from other accounts. If your SNS topic is encrypted, the key must be owned by the same account that owns your Image Builder resources.

Constraints:

  • pattern: ^arn:aws[^:]*:sns:[^:]+:[0-9]{12}:[a-zA-Z0-9-_]{1,256}$

--resource-tags (map)

The metadata tags to assign to the Amazon EC2 instance that Image Builder launches during the build process. Tags are formatted as key value pairs. Tag keys can’t begin with aws: or match one of the following reserved keys: CreatedBy , Ec2ImageBuilderArn , Name , or Tags .

Constraints:

  • min: 1
  • max: 30

key -> (string)

Constraints:

  • min: 1
  • max: 128
  • pattern: ^(?!aws:)[a-zA-Z0-9\s_.:/=+\-@]*$

value -> (string)

Constraints:

  • max: 256

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--instance-metadata-options (structure)

The instance metadata service (IMDS) settings that Image Builder applies to the EC2 build and test instances it launches during image creation. If you don’t set these options, the EC2 launch defaults for the instance apply. For more information about instance metadata options, see one of the following links:

httpTokens -> (string)

Indicates whether a signed token header is required for instance metadata retrieval requests. The values affect the response as follows:

  • required – When you retrieve the IAM role credentials, version 2.0 credentials are returned in all cases.
  • optional – You can include a signed token header in your request to retrieve instance metadata, or you can leave it out. If you include it, version 2.0 credentials are returned for the IAM role. Otherwise, version 1.0 credentials are returned.

If you don’t set a value, the EC2 launch default applies to the build and test instances. That default depends on the base AMI and any account-level instance metadata defaults. For more information, see Configure the instance metadata options in the * Amazon EC2 User Guide * .

Constraints:

  • pattern: optional|required

httpPutResponseHopLimit -> (integer)

Limit the number of hops that an instance metadata request can traverse to reach its destination. If you don’t set a value, the EC2 launch default for the instance applies. If HTTP tokens are required, container image builds need a minimum of two hops.

Constraints:

  • min: 1
  • max: 64

Shorthand Syntax:

httpTokens=string,httpPutResponseHopLimit=integer

JSON Syntax:

{
  "httpTokens": "string",
  "httpPutResponseHopLimit": integer
}

--placement (structure)

The instance placement settings that define where the build and test instances that Image Builder launches during image creation run. These settings don’t affect instances that you launch from the output image.

availabilityZone -> (string)

The Availability Zone where your build and test instances will launch.

Constraints:

  • min: 1
  • max: 1024

tenancy -> (string)

The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware. An instance with a tenancy of host runs on a Dedicated Host.

If tenancy is set to host , then you can optionally specify one target for placement – either host ID or host resource group ARN. If automatic placement is enabled for your host, and you don’t specify any placement target, Amazon EC2 will try to find an available host for your build and test instances.

Possible values:

  • default
  • dedicated
  • host

hostId -> (string)

The ID of the Dedicated Host on which build and test instances run. This only applies if tenancy is host .

Constraints:

  • min: 1
  • max: 1024

hostResourceGroupArn -> (string)

The Amazon Resource Name (ARN) of the host resource group in which to launch build and test instances. This only applies if tenancy is host .

Constraints:

  • min: 1
  • max: 1024

Shorthand Syntax:

availabilityZone=string,tenancy=string,hostId=string,hostResourceGroupArn=string

JSON Syntax:

{
  "availabilityZone": "string",
  "tenancy": "default"|"dedicated"|"host",
  "hostId": "string",
  "hostResourceGroupArn": "string"
}

--client-token (string)

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 .

Constraints:

  • min: 1
  • max: 64

--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 value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, 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. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream
  • off

--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 the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-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.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

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 infrastructure configuration

The following update-infrastructure-configuration example updates an infrastructure configuration using a JSON file.

aws imagebuilder update-infrastructure-configuration \
    --cli-input-json file:/update-infrastructure-configuration.json

Contents of update-infrastructure-configuration.json:

{
    "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure",
    "description": "An example that will terminate instances of failed builds",
    "instanceTypes": [
        "m5.large", "m5.2xlarge"
    ],
    "instanceProfileName": "EC2InstanceProfileForImageFactory",
    "securityGroupIds": [
        "sg-a48c95ef"
    ],
    "subnetId": "subnet-a48c95ef",
    "logging": {
        "s3Logs": {
            "s3BucketName": "bucket-name",
            "s3KeyPrefix": "bucket-path"
        }
    },
    "terminateInstanceOnFailure": true,
    "snsTopicArn": "arn:aws:sns:us-west-2:123456789012:sns-name"
}

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.

Constraints:

  • min: 1
  • max: 1024

clientToken -> (string)

The client token that uniquely identifies the request.

Constraints:

  • min: 1
  • max: 64

infrastructureConfigurationArn -> (string)

The Amazon Resource Name (ARN) of the infrastructure configuration that was updated by this request.

Constraints:

  • pattern: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):infrastructure-configuration/[a-z0-9-_]+$
© Copyright 2026, Amazon Web Services. Created using Sphinx.