Skip to content

Resource: awsAmiFromInstance

The "AMI from instance" resource allows the creation of an Amazon Machine Image (AMI) modelled after an existing EBS-backed EC2 instance.

The created AMI will refer to implicitly-created snapshots of the instance's EBS volumes and mimick its assigned block device configuration at the time the resource is created.

This resource is best applied to an instance that is stopped when this instance is created, so that the contents of the created image are predictable. When applied to an instance that is running, the instance will be stopped before taking the snapshots and then started back up again, resulting in a period of downtime.

Note that the source instance is inspected only at the initial creation of this resource. Ongoing updates to the referenced instance will not be propagated into the generated AMI. Users may taint or otherwise recreate the resource in order to produce a fresh snapshot.

Example Usage

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.amiFromInstance.AmiFromInstance(this, "example", {
  name: "terraform-example",
  sourceInstanceId: "i-xxxxxxxx",
});

Argument Reference

The following arguments are supported:

  • name - (Required) Region-unique name for the AMI.
  • sourceInstanceId - (Required) ID of the instance to use as the basis of the AMI.
  • snapshotWithoutReboot - (Optional) Boolean that overrides the behavior of stopping the instance before snapshotting. This is risky since it may cause a snapshot of an inconsistent filesystem state, but can be used to avoid downtime if the user otherwise guarantees that no filesystem writes will be underway at the time of snapshot.
  • tags - (Optional) Map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Timeouts

Configuration options:

  • create - (Default 40M)
  • update - (Default 40M)
  • delete - (Default 90M)

Attributes Reference

In addition to all arguments above, the following attributes are exported:

  • arn - ARN of the AMI.
  • id - ID of the created AMI.

This resource also exports a full set of attributes corresponding to the arguments of the awsAmi resource, allowing the properties of the created AMI to be used elsewhere in the configuration.