create-infrastructure-configuration¶

Description¶

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

Synopsis¶

  create-infrastructure-configuration
--name <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>]
[--tags <value>]
[--client-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--name (string)

The name of the infrastructure configuration.

--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 in which to place the instance used to customize your Amazon EC2 AMI.

--logging (structure)

The logging configuration of the infrastructure configuration.

s3Logs -> (structure)

The Amazon S3 logging configuration.

s3BucketName -> (string)

The S3 bucket in which to store the logs.

s3KeyPrefix -> (string)

The Amazon S3 path to the bucket where the logs are stored.

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 Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications.

Note

EC2 Image Builder is unable to send notifications to SNS topics that are encrypted using keys from other accounts. The key that is used to encrypt the SNS topic must reside in the account that the Image Builder service runs under.

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

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
}

--tags (map)

The tags of the infrastructure configuration.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

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

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

See ‘aws help’ for descriptions of global 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 create an infrastructure configuration

The following create-infrastructure-configuration example creates an infrastructure configuration using a JSON file.

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

Contents of create-infrastructure-configuration.json:

{
    "name": "MyExampleInfrastructure",
    "description": "An example that will retain instances of failed builds",
    "instanceTypes": [
        "m5.large", "m5.xlarge"
    ],
    "instanceProfileName": "EC2InstanceProfileForImageBuilder",
    "securityGroupIds": [
        "sg-a1b2c3d4"
    ],
    "subnetId": "subnet-a1b2c3d4",
    "logging": {
        "s3Logs": {
            "s3BucketName": "bucket-name",
            "s3KeyPrefix": "bucket-path"
        }
    },
    "keyPair": "key-pair-name",
    "terminateInstanceOnFailure": false,
    "snsTopicArn": "arn:aws:sns:us-west-2:123456789012:sns-topic-name"
}

Output:

{
    "requestId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "clientToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
    "infrastructureConfigurationArn": "arn:aws:imagebuilder:us-west-2:123456789012:infrastructure-configuration/myexampleinfrastructure"
}

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 created by this request.

Table of Contents

Feedback

User Guide

create-infrastructure-configuration¶

Description¶

Synopsis¶

Options¶

Examples¶

Output¶