AWS CLI Command Reference

[ aws . imagebuilder ]

update-infrastructure-configuration

Description

Updates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

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>]
[--client-token <value>]
[--resource-tags <value>]
[--instance-metadata-options <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--infrastructure-configuration-arn (string)

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

--description (string)

The description of the infrastructure configuration.

--instance-types (list)

The instance types of the infrastructure configuration. You can specify one or more instance types to use for this build. The service will pick one of these instance types based on availability.

(string)

Syntax:

"string" "string" ...

--instance-profile-name (string)

The instance profile to associate with the instance used to customize your Amazon EC2 AMI.

--security-group-ids (list)

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

(string)

Syntax:

"string" "string" ...

--subnet-id (string)

The subnet ID to place the instance used to customize your Amazon EC2 AMI in.

--logging (structure)

The logging configuration of the infrastructure configuration.

s3Logs -> (structure)

The Amazon S3 logging configuration.

s3BucketName -> (string)

The Amazon S3 bucket in which to store the logs.

s3KeyPrefix -> (string)

The Amazon S3 path in which to store the logs.

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.

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

The terminate instance on failure setting of the infrastructure configuration. 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.

--sns-topic-arn (string)

The SNS topic on which to send image build events.

--client-token (string)

The idempotency token used to make this request idempotent.

--resource-tags (map)

The tags attached to the resource created by Image Builder.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

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

--instance-metadata-options (structure)

The instance metadata options that you can set for the HTTP requests that pipeline builds use to launch EC2 build and test instances. 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.

The default setting is optional .

httpPutResponseHopLimit -> (integer)

Limit the number of hops that an instance metadata request can traverse to reach its destination.

Shorthand Syntax:

httpTokens=string,httpPutResponseHopLimit=integer

JSON Syntax:

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

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

See ‘aws help’ for descriptions of global parameters.

Examples

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.

clientToken -> (string)

The idempotency token used to make this request idempotent.

infrastructureConfigurationArn -> (string)

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

© Copyright 2018, Amazon Web Services. Created using Sphinx.