pulumi-aws-kotlin/com.pulumi.aws.ec2.kotlin/AmiFromInstance

AmiFromInstance

class AmiFromInstance : KotlinCustomResource

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

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.AmiFromInstance;
import com.pulumi.aws.ec2.AmiFromInstanceArgs;
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 AmiFromInstance("example", AmiFromInstanceArgs.builder()
            .sourceInstanceId("i-xxxxxxxx")
            .build());
    }
}

Properties

architecture

val architecture: Output<String>

Machine architecture for created instances. Defaults to "x86_64".

arn

val arn: Output<String>

ARN of the AMI.

bootMode

val bootMode: Output<String>

Boot mode of the AMI. For more information, see Boot modes in the Amazon Elastic Compute Cloud User Guide.

deprecationTime

val deprecationTime: Output<String>?

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)

description

val description: Output<String>?

Longer, human-readable description for the AMI.

ebsBlockDevices

val ebsBlockDevices: Output<List<AmiFromInstanceEbsBlockDevice>>

Nested block describing an EBS block device that should be attached to created instances. The structure of this block is described below.

enaSupport

val enaSupport: Output<Boolean>

Whether enhanced networking with ENA is enabled. Defaults to false.

ephemeralBlockDevices

val ephemeralBlockDevices: Output<List<AmiFromInstanceEphemeralBlockDevice>>

Nested block describing an ephemeral block device that should be attached to created instances. The structure of this block is described below.

hypervisor

val hypervisor: Output<String>

val id: Output<String>

imageLocation

val imageLocation: Output<String>

Path to an S3 object containing an image manifest, e.g., created by the ec2-upload-bundle command in the EC2 command line tools.

imageOwnerAlias

val imageOwnerAlias: Output<String>

imageType

val imageType: Output<String>

imdsSupport

val imdsSupport: Output<String>

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.

kernelId

val kernelId: Output<String>

ID of the kernel image (AKI) that will be used as the paravirtual kernel in created instances.

manageEbsSnapshots

val manageEbsSnapshots: Output<Boolean>

name

val name: Output<String>

Region-unique name for the AMI.

ownerId

val ownerId: Output<String>

platform

val platform: Output<String>

platformDetails

val platformDetails: Output<String>

public

val public: Output<Boolean>

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

ramdiskId

val ramdiskId: Output<String>

ID of an initrd image (ARI) that will be used when booting the created instances.

rootDeviceName

val rootDeviceName: Output<String>

Name of the root device (for example, /dev/sda1, or /dev/xvda).

rootSnapshotId

val rootSnapshotId: Output<String>

snapshotWithoutReboot

val snapshotWithoutReboot: Output<Boolean>?

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.

sourceInstanceId

val sourceInstanceId: Output<String>

ID of the instance to use as the basis of the AMI.

sriovNetSupport

val sriovNetSupport: Output<String>

When set to "simple" (the default), enables enhanced networking for created instances. No other value is supported at this time.