Skip to content

Commit 0d929a1

Browse files
author
AWS
committed
EC2 Image Builder Update: This release adds support for importing and exporting VM Images as part of the Image Creation workflow via EC2 VM Import/Export.
1 parent ee32c57 commit 0d929a1

File tree

2 files changed

+148
-6
lines changed

2 files changed

+148
-6
lines changed

‎.changes/next-release/feature-EC2ImageBuilder-02c44b5.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "EC2 Image Builder",
4+
"contributor": "",
5+
"description": "This release adds support for importing and exporting VM Images as part of the Image Creation workflow via EC2 VM Import/Export."
6+
}

‎services/imagebuilder/src/main/resources/codegen-resources/service-2.json

Lines changed: 142 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -543,6 +543,21 @@
543543
],
544544
"documentation":"<p>Imports a component and transforms its data into a component document.</p>"
545545
},
546+
"ImportVmImage":{
547+
"name":"ImportVmImage",
548+
"http":{
549+
"method":"PUT",
550+
"requestUri":"/ImportVmImage"
551+
},
552+
"input":{"shape":"ImportVmImageRequest"},
553+
"output":{"shape":"ImportVmImageResponse"},
554+
"errors":[
555+
{"shape":"ServiceException"},
556+
{"shape":"ClientException"},
557+
{"shape":"ServiceUnavailableException"}
558+
],
559+
"documentation":"<p>When you export your virtual machine (VM) from its virtualization environment, that process creates a set of one or more disk container files that act as snapshots of your VM’s environment, settings, and data. The Amazon EC2 API <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportImage.html\">ImportImage</a> action uses those files to import your VM and create an AMI. To import using the CLI command, see <a href=\"https://docs.aws.amazon.com/cli/latest/reference/ec2/import-image.html\">import-image</a> </p> <p>You can reference the task ID from the VM import to pull in the AMI that the import created as the base image for your Image Builder recipe.</p>"
560+
},
546561
"ListComponentBuildVersions":{
547562
"name":"ListComponentBuildVersions",
548563
"http":{
@@ -1056,6 +1071,14 @@
10561071
},
10571072
"Arn":{"type":"string"},
10581073
"Boolean":{"type":"boolean"},
1074+
"BuildType":{
1075+
"type":"string",
1076+
"enum":[
1077+
"USER_INITIATED",
1078+
"SCHEDULED",
1079+
"IMPORT"
1080+
]
1081+
},
10591082
"CallRateLimitExceededException":{
10601083
"type":"structure",
10611084
"members":{
@@ -1078,7 +1101,7 @@
10781101
},
10791102
"clientToken":{
10801103
"shape":"ClientToken",
1081-
"documentation":"<p>The idempotency token used to make this request idempotent.</p>",
1104+
"documentation":"<p>Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html\">Ensuring idempotency</a> in the <i>Amazon EC2 API Reference</i>.</p>",
10821105
"idempotencyToken":true
10831106
}
10841107
}
@@ -1092,7 +1115,7 @@
10921115
},
10931116
"clientToken":{
10941117
"shape":"ClientToken",
1095-
"documentation":"<p>The idempotency token used to make this request idempotent.</p>"
1118+
"documentation":"<p>The idempotency token that was used for this request.</p>"
10961119
},
10971120
"imageBuildVersionArn":{
10981121
"shape":"ImageBuildVersionArn",
@@ -2277,6 +2300,14 @@
22772300
}
22782301
}
22792302
},
2303+
"DiskImageFormat":{
2304+
"type":"string",
2305+
"enum":[
2306+
"VMDK",
2307+
"RAW",
2308+
"VHD"
2309+
]
2310+
},
22802311
"Distribution":{
22812312
"type":"structure",
22822313
"required":["region"],
@@ -2300,6 +2331,10 @@
23002331
"launchTemplateConfigurations":{
23012332
"shape":"LaunchTemplateConfigurationList",
23022333
"documentation":"<p>A group of launchTemplateConfiguration settings that apply to image distribution for specified accounts.</p>"
2334+
},
2335+
"s3ExportConfiguration":{
2336+
"shape":"S3ExportConfiguration",
2337+
"documentation":"<p>Configure export settings to deliver disk images created from your image build, using a file format that is compatible with your VMs in that Region.</p>"
23032338
}
23042339
},
23052340
"documentation":"<p> Defines the settings for a specific Region.</p>"
@@ -2878,6 +2913,10 @@
28782913
"tags":{
28792914
"shape":"TagMap",
28802915
"documentation":"<p>The tags of the image.</p>"
2916+
},
2917+
"buildType":{
2918+
"shape":"BuildType",
2919+
"documentation":"<p>Indicates the type of build that created this image. The build can be initiated in the following ways:</p> <ul> <li> <p> <b>USER_INITIATED</b> – A manual pipeline build request.</p> </li> <li> <p> <b>SCHEDULED</b> – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from EventBridge.</p> </li> <li> <p> <b>IMPORT</b> – A VM import created the image to use as the base image for the recipe.</p> </li> </ul>"
28812920
}
28822921
},
28832922
"documentation":"<p>An Image Builder image. You must specify exactly one recipe for the image – either a container recipe (<code>containerRecipe</code>), which creates a container image, or an image recipe (<code>imageRecipe</code>), which creates an AMI.</p>"
@@ -3170,6 +3209,10 @@
31703209
"tags":{
31713210
"shape":"TagMap",
31723211
"documentation":"<p>The tags of the image.</p>"
3212+
},
3213+
"buildType":{
3214+
"shape":"BuildType",
3215+
"documentation":"<p>Indicates the type of build that created this image. The build can be initiated in the following ways:</p> <ul> <li> <p> <b>USER_INITIATED</b> – A manual pipeline build request.</p> </li> <li> <p> <b>SCHEDULED</b> – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from EventBridge.</p> </li> <li> <p> <b>IMPORT</b> – A VM import created the image to use as the base image for the recipe.</p> </li> </ul>"
31733216
}
31743217
},
31753218
"documentation":"<p>An image summary.</p>"
@@ -3183,14 +3226,14 @@
31833226
"members":{
31843227
"imageTestsEnabled":{
31853228
"shape":"NullableBoolean",
3186-
"documentation":"<p>Defines if tests should be executed when building this image.</p>"
3229+
"documentation":"<p>Determines if tests should run after building the image. Image Builder defaults to enable tests to run following the image build, before image distribution.</p>"
31873230
},
31883231
"timeoutMinutes":{
31893232
"shape":"ImageTestsTimeoutMinutes",
31903233
"documentation":"<p>The maximum time in minutes that tests are permitted to run.</p>"
31913234
}
31923235
},
3193-
"documentation":"<p>Image tests configuration.</p>"
3236+
"documentation":"<p>Configure image tests for your pipeline build. Tests run after building the image, to verify that the AMI or container image is valid before distributing it.</p>"
31943237
},
31953238
"ImageTestsTimeoutMinutes":{
31963239
"type":"integer",
@@ -3238,6 +3281,10 @@
32383281
"dateCreated":{
32393282
"shape":"DateTime",
32403283
"documentation":"<p>The date on which this specific version of the Image Builder image was created.</p>"
3284+
},
3285+
"buildType":{
3286+
"shape":"BuildType",
3287+
"documentation":"<p>Indicates the type of build that created this image. The build can be initiated in the following ways:</p> <ul> <li> <p> <b>USER_INITIATED</b> – A manual pipeline build request.</p> </li> <li> <p> <b>SCHEDULED</b> – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from EventBridge.</p> </li> <li> <p> <b>IMPORT</b> – A VM import created the image to use as the base image for the recipe.</p> </li> </ul>"
32413288
}
32423289
},
32433290
"documentation":"<p>The defining characteristics of a specific version of an Image Builder image.</p>"
@@ -3333,6 +3380,68 @@
33333380
}
33343381
}
33353382
},
3383+
"ImportVmImageRequest":{
3384+
"type":"structure",
3385+
"required":[
3386+
"name",
3387+
"semanticVersion",
3388+
"platform",
3389+
"vmImportTaskId",
3390+
"clientToken"
3391+
],
3392+
"members":{
3393+
"name":{
3394+
"shape":"NonEmptyString",
3395+
"documentation":"<p>The name of the base image that is created by the import process.</p>"
3396+
},
3397+
"semanticVersion":{
3398+
"shape":"VersionNumber",
3399+
"documentation":"<p>The semantic version to attach to the base image that was created during the import process. This version follows the semantic version syntax.</p> <note> <p>The semantic version has four nodes: &lt;major&gt;.&lt;minor&gt;.&lt;patch&gt;/&lt;build&gt;. You can assign values for the first three, and can filter on all of them.</p> <p> <b>Assignment:</b> For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.</p> <p> <b>Patterns:</b> You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.</p> </note>"
3400+
},
3401+
"description":{
3402+
"shape":"NonEmptyString",
3403+
"documentation":"<p>The description for the base image that is created by the import process.</p>"
3404+
},
3405+
"platform":{
3406+
"shape":"Platform",
3407+
"documentation":"<p>The operating system platform for the imported VM.</p>"
3408+
},
3409+
"osVersion":{
3410+
"shape":"OsVersion",
3411+
"documentation":"<p>The operating system version for the imported VM.</p>"
3412+
},
3413+
"vmImportTaskId":{
3414+
"shape":"NonEmptyString",
3415+
"documentation":"<p>The <code>importTaskId</code> (API) or <code>ImportTaskId</code> (CLI) from the Amazon EC2 VM import process. Image Builder retrieves information from the import process to pull in the AMI that is created from the VM source as the base image for your recipe.</p>"
3416+
},
3417+
"tags":{
3418+
"shape":"TagMap",
3419+
"documentation":"<p>Tags that are attached to the import resources.</p>"
3420+
},
3421+
"clientToken":{
3422+
"shape":"ClientToken",
3423+
"documentation":"<p>Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html\">Ensuring idempotency</a> in the <i>Amazon EC2 API Reference</i>.</p>",
3424+
"idempotencyToken":true
3425+
}
3426+
}
3427+
},
3428+
"ImportVmImageResponse":{
3429+
"type":"structure",
3430+
"members":{
3431+
"requestId":{
3432+
"shape":"NonEmptyString",
3433+
"documentation":"<p>The request ID that uniquely identifies this request.</p>"
3434+
},
3435+
"imageArn":{
3436+
"shape":"Arn",
3437+
"documentation":"<p>The Amazon Resource Name (ARN) of the AMI that was created during the VM import process. This AMI is used as the base image for the recipe that imported the VM.</p>"
3438+
},
3439+
"clientToken":{
3440+
"shape":"ClientToken",
3441+
"documentation":"<p>The idempotency token that was used for this request.</p>"
3442+
}
3443+
}
3444+
},
33363445
"InfrastructureConfiguration":{
33373446
"type":"structure",
33383447
"members":{
@@ -4366,16 +4475,43 @@
43664475
"max":25,
43674476
"min":1
43684477
},
4478+
"S3ExportConfiguration":{
4479+
"type":"structure",
4480+
"required":[
4481+
"roleName",
4482+
"diskImageFormat",
4483+
"s3Bucket"
4484+
],
4485+
"members":{
4486+
"roleName":{
4487+
"shape":"NonEmptyString",
4488+
"documentation":"<p>The name of the role that grants VM Import/Export permission to export images to your S3 bucket.</p>"
4489+
},
4490+
"diskImageFormat":{
4491+
"shape":"DiskImageFormat",
4492+
"documentation":"<p>Export the updated image to one of the following supported disk image formats:</p> <ul> <li> <p> <b>Virtual Hard Disk (VHD)</b> – Compatible with Citrix Xen and Microsoft Hyper-V virtualization products.</p> </li> <li> <p> <b>Stream-optimized ESX Virtual Machine Disk (VMDK)</b> – Compatible with VMware ESX and VMware vSphere versions 4, 5, and 6.</p> </li> <li> <p> <b>Raw</b> – Raw format.</p> </li> </ul>"
4493+
},
4494+
"s3Bucket":{
4495+
"shape":"NonEmptyString",
4496+
"documentation":"<p>The S3 bucket in which to store the output disk images for your VM.</p>"
4497+
},
4498+
"s3Prefix":{
4499+
"shape":"NonEmptyString",
4500+
"documentation":"<p>The Amazon S3 path for the bucket where the output disk images for your VM are stored.</p>"
4501+
}
4502+
},
4503+
"documentation":"<p>Properties that configure export from your build instance to a compatible file format for your VM.</p>"
4504+
},
43694505
"S3Logs":{
43704506
"type":"structure",
43714507
"members":{
43724508
"s3BucketName":{
43734509
"shape":"NonEmptyString",
4374-
"documentation":"<p>The Amazon S3 bucket in which to store the logs.</p>"
4510+
"documentation":"<p>The S3 bucket in which to store the logs.</p>"
43754511
},
43764512
"s3KeyPrefix":{
43774513
"shape":"NonEmptyString",
4378-
"documentation":"<p>The Amazon S3 path in which to store the logs.</p>"
4514+
"documentation":"<p>The Amazon S3 path to the bucket where the logs are stored.</p>"
43794515
}
43804516
},
43814517
"documentation":"<p>Amazon S3 logging configuration.</p>"

0 commit comments

Comments
 (0)