Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateInfrastructureConfiguration

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

Request Syntax


PUT /UpdateInfrastructureConfiguration HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "description": "string",
   "infrastructureConfigurationArn": "string",
   "instanceMetadataOptions": { 
      "httpPutResponseHopLimit": number,
      "httpTokens": "string"
   },
   "instanceProfileName": "string",
   "instanceTypes": [ "string" ],
   "keyPair": "string",
   "logging": { 
      "s3Logs": { 
         "s3BucketName": "string",
         "s3KeyPrefix": "string"
      }
   },
   "placement": { 
      "availabilityZone": "string",
      "hostId": "string",
      "hostResourceGroupArn": "string",
      "tenancy": "string"
   },
   "resourceTags": { 
      "string" : "string" 
   },
   "securityGroupIds": [ "string" ],
   "snsTopicArn": "string",
   "subnetId": "string",
   "terminateInstanceOnFailure": boolean
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

clientToken

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 36.

Required: Yes

description

The description of the infrastructure configuration.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

infrastructureConfigurationArn

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

Type: String

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

Required: Yes

instanceMetadataOptions

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:

Configure the instance metadata options in the Amazon EC2 User Guide for Linux instances.
Configure the instance metadata options in the Amazon EC2 Windows Guide for Windows instances.

Type: InstanceMetadataOptions object

Required: No

instanceProfileName

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^[\w+=,.@-]+$

Required: Yes

instanceTypes

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.

Type: Array of strings

Required: No

keyPair

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

logging

The logging configuration of the infrastructure configuration.

Type: Logging object

Required: No

placement

The instance placement settings that define where the instances that are launched from your image will run.

Type: Placement object

Required: No

resourceTags

The tags attached to the resource created by Image Builder.

Type: String to string map

Map Entries: Maximum number of 30 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$

Value Length Constraints: Maximum length of 256.

Required: No

securityGroupIds

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

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

snsTopicArn

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.

Type: String

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

Required: No

subnetId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

terminateInstanceOnFailure

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.

Type: Boolean

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "clientToken": "string",
   "infrastructureConfigurationArn": "string",
   "requestId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

clientToken

The client token that uniquely identifies the request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 36.

infrastructureConfigurationArn

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

Type: String

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

requestId

The request ID that uniquely identifies this request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Errors

For information about the errors that are common to all actions, see Common Errors.

CallRateLimitExceededException

You have exceeded the permitted request rate for the specific operation.

HTTP Status Code: 429

ClientException

These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.

HTTP Status Code: 400

ForbiddenException

You are not authorized to perform the requested operation.

HTTP Status Code: 403

IdempotentParameterMismatchException

You have specified a client token for an operation using parameter values that differ from a previous request that used the same client token.

HTTP Status Code: 400

InvalidRequestException

You have requested an action that that the service doesn't support.

HTTP Status Code: 400

ResourceInUseException

The resource that you are trying to operate on is currently in use. Review the message details and retry later.

HTTP Status Code: 400

ServiceException

This exception is thrown when the service encounters an unrecoverable exception.

HTTP Status Code: 500

ServiceUnavailableException

The service is unable to process your request at this time.

HTTP Status Code: 503