Ami Copy
The "AMI copy" resource allows duplication of an Amazon Machine Image (AMI), including cross-region copies. If the source AMI has associated EBS snapshots, those will also be duplicated along with the AMI. This is useful for taking a single AMI provisioned in one region and making it available in another for a multi-region deployment. Copying an AMI can take several minutes. The creation of this resource will block until the new AMI is available for use on new instances.
Example Usage
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.AmiCopy;
import com.pulumi.aws.ec2.AmiCopyArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new AmiCopy("example", AmiCopyArgs.builder()
.description("A copy of ami-xxxxxxxx")
.sourceAmiId("ami-xxxxxxxx")
.sourceAmiRegion("us-west-1")
.tags(Map.of("Name", "HelloWorld"))
.build());
}
}
Properties
Machine architecture for created instances. Defaults to "x86_64".
Boot mode of the AMI. For more information, see Boot modes in the Amazon Elastic Compute Cloud User Guide.
Date and time to deprecate the AMI. If you specified a value for seconds, Amazon EC2 rounds the seconds to the nearest minute. Valid values: RFC3339 time string (YYYY-MM-DDTHH:MM:SSZ
)
Longer, human-readable description for the AMI.
ARN of the Outpost to which to copy the AMI. Only specify this parameter when copying an AMI from an AWS Region to an Outpost. The AMI must be in the Region of the destination Outpost.
Nested block describing an EBS block device that should be attached to created instances. The structure of this block is described below.
Whether enhanced networking with ENA is enabled. Defaults to false
.
Nested block describing an ephemeral block device that should be attached to created instances. The structure of this block is described below.
Path to an S3 object containing an image manifest, e.g., created by the ec2-upload-bundle
command in the EC2 command line tools.
If EC2 instances started from this image should require the use of the Instance Metadata Service V2 (IMDSv2), set this argument to v2.0
. For more information, see Configure instance metadata options for new instances.
Name of the root device (for example, /dev/sda1
, or /dev/xvda
).
Id of the AMI to copy. This id must be valid in the region given by source_ami_region
.
Region from which the AMI will be copied. This may be the same as the AWS provider region in order to create a copy within the same region.
When set to "simple" (the default), enables enhanced networking for created instances. No other value is supported at this time.
If the image is configured for NitroTPM support, the value is v2.0
. For more information, see NitroTPM in the Amazon Elastic Compute Cloud User Guide.
Keyword to choose what virtualization mode created instances will use. Can be either "paravirtual" (the default) or "hvm". The choice of virtualization type changes the set of further arguments that are required, as described below.