Create an infrastructure configuration

Open the EC2 Image Builder console at https://console.amazonaws.cn/imagebuilder/.

From the navigation pane, choose Infrastructure configuration.

Choose Create infrastructure configuration.

In the General section, enter the following required information:

In the Amazon infrastructure panel, configure the remaining infrastructure settings. Enter the following required information:

If you do not supply values for the following settings, they use service-specific defaults, where applicable.

In the Infrastructure tags section (optional), you can assign metadata tags to the Amazon EC2 instance that Image Builder launches during the build process. Enter tags as key-value pairs.

In the Tags section (optional), you can assign metadata tags to the infrastructure configuration resource that Image Builder creates as output. Enter tags as key-value pairs.

Create a CLI input JSON file

The following examples show variations of the JSON file that you might create for infrastructure configuration. Use a file editing tool to create a JSON file of your own.

Configuration to retain an instance from a failed build

This example specifies two instance types, m7i.large and m7i.xlarge. We recommend that you specify more than one instance type because this allows Image Builder to launch an instance from a pool with sufficient capacity. This can reduce your transient build failures.

The instanceProfileName specifies the instance profile that provides the instance with the permissions that the profile requires to perform customization activities. For example, if you have a component that retrieves resources from Amazon S3, the instance profile requires permissions to access those files. The instance profile also requires a minimal set of permissions for EC2 Image Builder to successfully communicate with the instance. For more information, see Get set up to build custom images with Image Builder.

The following example JSON file defines this infrastructure configuration:

{
    "name": "example-infra-config-dont-terminate",
    "description": "An example that will retain instances of failed builds",
    "instanceTypes": [
        "m7i.large", "m7i.xlarge"
    ],
    "instanceProfileName": "my-iam-instance-profile-name",
    "securityGroupIds": [
        "sg-12345678"
    ],
    "subnetId": "subnet-12345678",
    "logging": {
        "s3Logs": {
            "s3BucketName": "amzn-s3-demo-logging-bucket",
            "s3KeyPrefix": "my-path"
        }
    },
    "keyPair": "my-key-pair-name",
    "terminateInstanceOnFailure": false,
    "snsTopicArn": "arn:aws:sns:us-west-2:111122223333:my-topic"
}

macOS configuration with auto-placement

This example specifies instance types and placement for a Mac instance where the Dedicated Host has auto-placement enabled.

The following example JSON file defines this infrastructure configuration:

{
    "name": "macos-infra-config-auto-placement",
    "description": "An example infrastructure configuration for macOS.",
    "instanceProfileName": "EC2InstanceProfileForImageBuilder",
    "instanceTypes": ["mac1.metal", "mac2.metal"],
    "terminateInstanceOnFailure": false,
    "placement": {
        "tenancy": "host"
    }
}

macOS configuration with host ID specified

This example specifies instance type and placement for a Mac instance that targets a specific Dedicated Host.

The following example JSON file defines this infrastructure configuration:

{
    "name": "macos-infra-config-host-placement",
    "description": "An example infrastructure configuration for macOS.",
    "instanceProfileName": "EC2InstanceProfileForImageBuilder",
    "instanceTypes": ["mac2-m1ultra.metal"],
    "terminateInstanceOnFailure": false,
    "placement": {
        "tenancy": "host",
        "hostId": "h-1234567890abcdef0"
    }
}

Custom VPC with IMDSv2 and Amazon S3 logging

This example launches instances in a specific subnet and security group, requires IMDSv2 tokens, and writes application logs to Amazon S3. Because the example sets subnetId, it must also set securityGroupIds.

The following example JSON file defines this infrastructure configuration:

{
    "name": "vpc-infra-config-with-logging",
    "description": "Build in a custom VPC with IMDSv2 and S3 logging",
    "instanceTypes": ["m7i.large", "m8i.large"],
    "instanceProfileName": "EC2InstanceProfileForImageBuilder",
    "subnetId": "subnet-12345678",
    "securityGroupIds": ["sg-12345678"],
    "instanceMetadataOptions": {
        "httpTokens": "required",
        "httpPutResponseHopLimit": 2
    },
    "logging": {
        "s3Logs": {
            "s3BucketName": "amzn-s3-demo-logging-bucket",
            "s3KeyPrefix": "image-builder-logs"
        }
    },
    "resourceTags": {
        "Project": "golden-ami"
    },
    "terminateInstanceOnFailure": true
}

Dedicated Host placement with a host resource group

This example targets a host resource group instead of a specific host ID. Because tenancy is host, you can specify a host resource group ARN. Don't also specify a hostId.

The following example JSON file defines this infrastructure configuration:

{
    "name": "host-resource-group-infra-config",
    "instanceProfileName": "EC2InstanceProfileForImageBuilder",
    "instanceTypes": ["mac2.metal"],
    "terminateInstanceOnFailure": false,
    "placement": {
        "tenancy": "host",
        "hostResourceGroupArn": "arn:aws:resource-groups:us-west-2:111122223333:group/my-host-group"
    }
}

Build on an instance from an Auto Scaling group

This example takes the build instance from an existing Amazon EC2 Auto Scaling group and waits up to 10 minutes for an instance if the group has none available. For the requirements, see Build on an instance from an Auto Scaling group.

The following example JSON file defines this infrastructure configuration:

{
    "name": "parent-instance-infra-config",
    "instanceProfileName": "EC2InstanceProfileForImageBuilder",
    "parentInstance": {
        "autoScalingGroup": {
            "name": "my-build-pool",
            "capacityWaitTimeoutSeconds": 600
        }
    }
}

Use the file you created as input when you run the following command.

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