Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. opsworks
  5. Instance
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-aws

aws.opsworks.Instance

Explore with Pulumi AI

aws logo
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-aws

    Provides an OpsWorks instance resource.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const my_instance = new aws.opsworks.Instance("my-instance", {
    stackId: main.id,
    layerIds: [my_layer.id],
    instanceType: "t2.micro",
    os: "Amazon Linux 2015.09",
    state: "stopped",
});

    import pulumi
import pulumi_aws as aws

my_instance = aws.opsworks.Instance("my-instance",
    stack_id=main["id"],
    layer_ids=[my_layer["id"]],
    instance_type="t2.micro",
    os="Amazon Linux 2015.09",
    state="stopped")

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/opsworks"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := opsworks.NewInstance(ctx, "my-instance", &opsworks.InstanceArgs{
			StackId: pulumi.Any(main.Id),
			LayerIds: pulumi.StringArray{
				my_layer.Id,
			},
			InstanceType: pulumi.String("t2.micro"),
			Os:           pulumi.String("Amazon Linux 2015.09"),
			State:        pulumi.String("stopped"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var my_instance = new Aws.OpsWorks.Instance("my-instance", new()
    {
        StackId = main.Id,
        LayerIds = new[]
        {
            my_layer.Id,
        },
        InstanceType = "t2.micro",
        Os = "Amazon Linux 2015.09",
        State = "stopped",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.opsworks.Instance;
import com.pulumi.aws.opsworks.InstanceArgs;
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 my_instance = new Instance("my-instance", InstanceArgs.builder()
            .stackId(main.id())
            .layerIds(my_layer.id())
            .instanceType("t2.micro")
            .os("Amazon Linux 2015.09")
            .state("stopped")
            .build());

    }
}

    resources:
  my-instance:
    type: aws:opsworks:Instance
    properties:
      stackId: ${main.id}
      layerIds:
        - ${["my-layer"].id}
      instanceType: t2.micro
      os: Amazon Linux 2015.09
      state: stopped

    Block devices

    Each of the *_block_device attributes controls a portion of the AWS Instance’s “Block Device Mapping”. It’s a good idea to familiarize yourself with AWS’s Block Device Mapping docs to understand the implications of using these attributes.

    ebs_block_device

    • delete_on_termination - (Optional) Whether the volume should be destroyed on instance termination. Default is true.
    • device_name - (Required) Name of the device to mount.
    • iops - (Optional) Amount of provisioned IOPS. This must be set with a volume_type of io1.
    • snapshot_id - (Optional) Snapshot ID to mount.
    • volume_size - (Optional) Size of the volume in gigabytes.
    • volume_type - (Optional) Type of volume. Valid values are standard, gp2, or io1. Default is standard.

    Modifying any ebs_block_device currently requires resource replacement.

    ephemeral_block_device

    Each AWS Instance type has a different set of Instance Store block devices available for attachment. AWS publishes a list of which ephemeral devices are available on each type. The devices are always identified by the virtual_name in the format ephemeral{0..N}.

    root_block_device

    • delete_on_termination - (Optional) Whether the volume should be destroyed on instance termination. Default is true.
    • iops - (Optional) Amount of provisioned IOPS. This must be set with a volume_type of io1.
    • volume_size - (Optional) Size of the volume in gigabytes.
    • volume_type - (Optional) Type of volume. Valid values are standard, gp2, or io1. Default is standard.

    Modifying any of the root_block_device settings requires resource replacement.

    NOTE: Currently, changes to *_block_device configuration of existing resources cannot be automatically detected by this provider. After making updates to block device configuration, resource recreation can be manually triggered by using the up command with the –replace argument.

    Create Instance Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Instance(name: string, args: InstanceArgs, opts?: CustomResourceOptions);
    @overload
def Instance(resource_name: str,
             args: InstanceArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Instance(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             layer_ids: Optional[Sequence[str]] = None,
             stack_id: Optional[str] = None,
             infrastructure_class: Optional[str] = None,
             subnet_id: Optional[str] = None,
             availability_zone: Optional[str] = None,
             created_at: Optional[str] = None,
             delete_ebs: Optional[bool] = None,
             delete_eip: Optional[bool] = None,
             ebs_block_devices: Optional[Sequence[InstanceEbsBlockDeviceArgs]] = None,
             ebs_optimized: Optional[bool] = None,
             ecs_cluster_arn: Optional[str] = None,
             elastic_ip: Optional[str] = None,
             ephemeral_block_devices: Optional[Sequence[InstanceEphemeralBlockDeviceArgs]] = None,
             hostname: Optional[str] = None,
             virtualization_type: Optional[str] = None,
             auto_scaling_type: Optional[str] = None,
             root_block_devices: Optional[Sequence[InstanceRootBlockDeviceArgs]] = None,
             instance_type: Optional[str] = None,
             architecture: Optional[str] = None,
             os: Optional[str] = None,
             instance_profile_arn: Optional[str] = None,
             root_device_type: Optional[str] = None,
             security_group_ids: Optional[Sequence[str]] = None,
             ssh_key_name: Optional[str] = None,
             ami_id: Optional[str] = None,
             state: Optional[str] = None,
             status: Optional[str] = None,
             install_updates_on_boot: Optional[bool] = None,
             tenancy: Optional[str] = None,
             agent_version: Optional[str] = None)
    func NewInstance(ctx *Context, name string, args InstanceArgs, opts ...ResourceOption) (*Instance, error)
    public Instance(string name, InstanceArgs args, CustomResourceOptions? opts = null)
    public Instance(String name, InstanceArgs args)
public Instance(String name, InstanceArgs args, CustomResourceOptions options)

    type: aws:opsworks:Instance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var exampleinstanceResourceResourceFromOpsworksinstance = new Aws.OpsWorks.Instance("exampleinstanceResourceResourceFromOpsworksinstance", new()
{
    LayerIds = new[]
    {
        "string",
    },
    StackId = "string",
    InfrastructureClass = "string",
    SubnetId = "string",
    AvailabilityZone = "string",
    CreatedAt = "string",
    DeleteEbs = false,
    DeleteEip = false,
    EbsBlockDevices = new[]
    {
        new Aws.OpsWorks.Inputs.InstanceEbsBlockDeviceArgs
        {
            DeviceName = "string",
            DeleteOnTermination = false,
            Iops = 0,
            SnapshotId = "string",
            VolumeSize = 0,
            VolumeType = "string",
        },
    },
    EbsOptimized = false,
    EcsClusterArn = "string",
    ElasticIp = "string",
    EphemeralBlockDevices = new[]
    {
        new Aws.OpsWorks.Inputs.InstanceEphemeralBlockDeviceArgs
        {
            DeviceName = "string",
            VirtualName = "string",
        },
    },
    Hostname = "string",
    VirtualizationType = "string",
    AutoScalingType = "string",
    RootBlockDevices = new[]
    {
        new Aws.OpsWorks.Inputs.InstanceRootBlockDeviceArgs
        {
            DeleteOnTermination = false,
            Iops = 0,
            VolumeSize = 0,
            VolumeType = "string",
        },
    },
    InstanceType = "string",
    Architecture = "string",
    Os = "string",
    InstanceProfileArn = "string",
    RootDeviceType = "string",
    SecurityGroupIds = new[]
    {
        "string",
    },
    SshKeyName = "string",
    AmiId = "string",
    State = "string",
    Status = "string",
    InstallUpdatesOnBoot = false,
    Tenancy = "string",
    AgentVersion = "string",
});

    example, err := opsworks.NewInstance(ctx, "exampleinstanceResourceResourceFromOpsworksinstance", &opsworks.InstanceArgs{
	LayerIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	StackId:             pulumi.String("string"),
	InfrastructureClass: pulumi.String("string"),
	SubnetId:            pulumi.String("string"),
	AvailabilityZone:    pulumi.String("string"),
	CreatedAt:           pulumi.String("string"),
	DeleteEbs:           pulumi.Bool(false),
	DeleteEip:           pulumi.Bool(false),
	EbsBlockDevices: opsworks.InstanceEbsBlockDeviceArray{
		&opsworks.InstanceEbsBlockDeviceArgs{
			DeviceName:          pulumi.String("string"),
			DeleteOnTermination: pulumi.Bool(false),
			Iops:                pulumi.Int(0),
			SnapshotId:          pulumi.String("string"),
			VolumeSize:          pulumi.Int(0),
			VolumeType:          pulumi.String("string"),
		},
	},
	EbsOptimized:  pulumi.Bool(false),
	EcsClusterArn: pulumi.String("string"),
	ElasticIp:     pulumi.String("string"),
	EphemeralBlockDevices: opsworks.InstanceEphemeralBlockDeviceArray{
		&opsworks.InstanceEphemeralBlockDeviceArgs{
			DeviceName:  pulumi.String("string"),
			VirtualName: pulumi.String("string"),
		},
	},
	Hostname:           pulumi.String("string"),
	VirtualizationType: pulumi.String("string"),
	AutoScalingType:    pulumi.String("string"),
	RootBlockDevices: opsworks.InstanceRootBlockDeviceArray{
		&opsworks.InstanceRootBlockDeviceArgs{
			DeleteOnTermination: pulumi.Bool(false),
			Iops:                pulumi.Int(0),
			VolumeSize:          pulumi.Int(0),
			VolumeType:          pulumi.String("string"),
		},
	},
	InstanceType:       pulumi.String("string"),
	Architecture:       pulumi.String("string"),
	Os:                 pulumi.String("string"),
	InstanceProfileArn: pulumi.String("string"),
	RootDeviceType:     pulumi.String("string"),
	SecurityGroupIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	SshKeyName:           pulumi.String("string"),
	AmiId:                pulumi.String("string"),
	State:                pulumi.String("string"),
	Status:               pulumi.String("string"),
	InstallUpdatesOnBoot: pulumi.Bool(false),
	Tenancy:              pulumi.String("string"),
	AgentVersion:         pulumi.String("string"),
})

    var exampleinstanceResourceResourceFromOpsworksinstance = new Instance("exampleinstanceResourceResourceFromOpsworksinstance", InstanceArgs.builder()
    .layerIds("string")
    .stackId("string")
    .infrastructureClass("string")
    .subnetId("string")
    .availabilityZone("string")
    .createdAt("string")
    .deleteEbs(false)
    .deleteEip(false)
    .ebsBlockDevices(InstanceEbsBlockDeviceArgs.builder()
        .deviceName("string")
        .deleteOnTermination(false)
        .iops(0)
        .snapshotId("string")
        .volumeSize(0)
        .volumeType("string")
        .build())
    .ebsOptimized(false)
    .ecsClusterArn("string")
    .elasticIp("string")
    .ephemeralBlockDevices(InstanceEphemeralBlockDeviceArgs.builder()
        .deviceName("string")
        .virtualName("string")
        .build())
    .hostname("string")
    .virtualizationType("string")
    .autoScalingType("string")
    .rootBlockDevices(InstanceRootBlockDeviceArgs.builder()
        .deleteOnTermination(false)
        .iops(0)
        .volumeSize(0)
        .volumeType("string")
        .build())
    .instanceType("string")
    .architecture("string")
    .os("string")
    .instanceProfileArn("string")
    .rootDeviceType("string")
    .securityGroupIds("string")
    .sshKeyName("string")
    .amiId("string")
    .state("string")
    .status("string")
    .installUpdatesOnBoot(false)
    .tenancy("string")
    .agentVersion("string")
    .build());

    exampleinstance_resource_resource_from_opsworksinstance = aws.opsworks.Instance("exampleinstanceResourceResourceFromOpsworksinstance",
    layer_ids=["string"],
    stack_id="string",
    infrastructure_class="string",
    subnet_id="string",
    availability_zone="string",
    created_at="string",
    delete_ebs=False,
    delete_eip=False,
    ebs_block_devices=[{
        "deviceName": "string",
        "deleteOnTermination": False,
        "iops": 0,
        "snapshotId": "string",
        "volumeSize": 0,
        "volumeType": "string",
    }],
    ebs_optimized=False,
    ecs_cluster_arn="string",
    elastic_ip="string",
    ephemeral_block_devices=[{
        "deviceName": "string",
        "virtualName": "string",
    }],
    hostname="string",
    virtualization_type="string",
    auto_scaling_type="string",
    root_block_devices=[{
        "deleteOnTermination": False,
        "iops": 0,
        "volumeSize": 0,
        "volumeType": "string",
    }],
    instance_type="string",
    architecture="string",
    os="string",
    instance_profile_arn="string",
    root_device_type="string",
    security_group_ids=["string"],
    ssh_key_name="string",
    ami_id="string",
    state="string",
    status="string",
    install_updates_on_boot=False,
    tenancy="string",
    agent_version="string")

    const exampleinstanceResourceResourceFromOpsworksinstance = new aws.opsworks.Instance("exampleinstanceResourceResourceFromOpsworksinstance", {
    layerIds: ["string"],
    stackId: "string",
    infrastructureClass: "string",
    subnetId: "string",
    availabilityZone: "string",
    createdAt: "string",
    deleteEbs: false,
    deleteEip: false,
    ebsBlockDevices: [{
        deviceName: "string",
        deleteOnTermination: false,
        iops: 0,
        snapshotId: "string",
        volumeSize: 0,
        volumeType: "string",
    }],
    ebsOptimized: false,
    ecsClusterArn: "string",
    elasticIp: "string",
    ephemeralBlockDevices: [{
        deviceName: "string",
        virtualName: "string",
    }],
    hostname: "string",
    virtualizationType: "string",
    autoScalingType: "string",
    rootBlockDevices: [{
        deleteOnTermination: false,
        iops: 0,
        volumeSize: 0,
        volumeType: "string",
    }],
    instanceType: "string",
    architecture: "string",
    os: "string",
    instanceProfileArn: "string",
    rootDeviceType: "string",
    securityGroupIds: ["string"],
    sshKeyName: "string",
    amiId: "string",
    state: "string",
    status: "string",
    installUpdatesOnBoot: false,
    tenancy: "string",
    agentVersion: "string",
});

    type: aws:opsworks:Instance
properties:
    agentVersion: string
    amiId: string
    architecture: string
    autoScalingType: string
    availabilityZone: string
    createdAt: string
    deleteEbs: false
    deleteEip: false
    ebsBlockDevices:
        - deleteOnTermination: false
          deviceName: string
          iops: 0
          snapshotId: string
          volumeSize: 0
          volumeType: string
    ebsOptimized: false
    ecsClusterArn: string
    elasticIp: string
    ephemeralBlockDevices:
        - deviceName: string
          virtualName: string
    hostname: string
    infrastructureClass: string
    installUpdatesOnBoot: false
    instanceProfileArn: string
    instanceType: string
    layerIds:
        - string
    os: string
    rootBlockDevices:
        - deleteOnTermination: false
          iops: 0
          volumeSize: 0
          volumeType: string
    rootDeviceType: string
    securityGroupIds:
        - string
    sshKeyName: string
    stackId: string
    state: string
    status: string
    subnetId: string
    tenancy: string
    virtualizationType: string

    Instance Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Instance resource accepts the following input properties:

    LayerIds List<string>
    List of the layers the instance will belong to.
    StackId string

    Identifier of the stack the instance will belong to.

    The following arguments are optional:

    AgentVersion string
    OpsWorks agent to install. Default is INHERIT.
    AmiId string
    AMI to use for the instance. If an AMI is specified, os must be Custom.
    Architecture string
    Machine architecture for created instances. Valid values are x86_64 or i386. The default is x86_64.
    AutoScalingType string
    Creates load-based or time-based instances. Valid values are load, timer.
    AvailabilityZone string
    Name of the availability zone where instances will be created by default.
    CreatedAt string
    Time that the instance was created.
    DeleteEbs bool
    Whether to delete EBS volume on deletion. Default is true.
    DeleteEip bool
    Whether to delete the Elastic IP on deletion.
    EbsBlockDevices List<InstanceEbsBlockDevice>
    Configuration block for additional EBS block devices to attach to the instance. See Block Devices below.
    EbsOptimized bool
    Whether the launched EC2 instance will be EBS-optimized.
    EcsClusterArn string
    ECS cluster's ARN for container instances.
    ElasticIp string
    Instance Elastic IP address.
    EphemeralBlockDevices List<InstanceEphemeralBlockDevice>
    Configuration block for ephemeral (also known as "Instance Store") volumes on the instance. See Block Devices below.
    Hostname string
    Instance's host name.
    InfrastructureClass string
    For registered instances, infrastructure class: ec2 or on-premises.
    InstallUpdatesOnBoot bool
    Controls where to install OS and package updates when the instance boots. Default is true.
    InstanceProfileArn string
    ARN of the instance's IAM profile.
    InstanceType string
    Type of instance to start.
    Os string
    Name of operating system that will be installed.
    RootBlockDevices List<InstanceRootBlockDevice>
    Configuration block for the root block device of the instance. See Block Devices below.
    RootDeviceType string
    Name of the type of root device instances will have by default. Valid values are ebs or instance-store.
    SecurityGroupIds List<string>
    Associated security groups.
    SshKeyName string
    Name of the SSH keypair that instances will have by default.
    State string
    Desired state of the instance. Valid values are running or stopped.
    Status string
    Instance status. Will be one of booting, connection_lost, online, pending, rebooting, requested, running_setup, setup_failed, shutting_down, start_failed, stop_failed, stopped, stopping, terminated, or terminating.
    SubnetId string
    Subnet ID to attach to.
    Tenancy string
    Instance tenancy to use. Valid values are default, dedicated or host.
    VirtualizationType string
    Keyword to choose what virtualization mode created instances will use. Valid values are paravirtual or hvm.
    LayerIds []string
    List of the layers the instance will belong to.
    StackId string

    Identifier of the stack the instance will belong to.

    The following arguments are optional:

    AgentVersion string
    OpsWorks agent to install. Default is INHERIT.
    AmiId string
    AMI to use for the instance. If an AMI is specified, os must be Custom.
    Architecture string
    Machine architecture for created instances. Valid values are x86_64 or i386. The default is x86_64.
    AutoScalingType string
    Creates load-based or time-based instances. Valid values are load, timer.
    AvailabilityZone string
    Name of the availability zone where instances will be created by default.
    CreatedAt string
    Time that the instance was created.
    DeleteEbs bool
    Whether to delete EBS volume on deletion. Default is true.
    DeleteEip bool
    Whether to delete the Elastic IP on deletion.
    EbsBlockDevices []InstanceEbsBlockDeviceArgs
    Configuration block for additional EBS block devices to attach to the instance. See Block Devices below.
    EbsOptimized bool
    Whether the launched EC2 instance will be EBS-optimized.
    EcsClusterArn string
    ECS cluster's ARN for container instances.
    ElasticIp string
    Instance Elastic IP address.
    EphemeralBlockDevices []InstanceEphemeralBlockDeviceArgs
    Configuration block for ephemeral (also known as "Instance Store") volumes on the instance. See Block Devices below.
    Hostname string
    Instance's host name.
    InfrastructureClass string
    For registered instances, infrastructure class: ec2 or on-premises.
    InstallUpdatesOnBoot bool
    Controls where to install OS and package updates when the instance boots. Default is true.
    InstanceProfileArn string
    ARN of the instance's IAM profile.
    InstanceType string
    Type of instance to start.
    Os string
    Name of operating system that will be installed.
    RootBlockDevices []InstanceRootBlockDeviceArgs
    Configuration block for the root block device of the instance. See Block Devices below.
    RootDeviceType string
    Name of the type of root device instances will have by default. Valid values are ebs or instance-store.
    SecurityGroupIds []string
    Associated security groups.
    SshKeyName string
    Name of the SSH keypair that instances will have by default.
    State string
    Desired state of the instance. Valid values are running or stopped.
    Status string
    Instance status. Will be one of booting, connection_lost, online, pending, rebooting, requested, running_setup, setup_failed, shutting_down, start_failed, stop_failed, stopped, stopping, terminated, or terminating.
    SubnetId string
    Subnet ID to attach to.
    Tenancy string
    Instance tenancy to use. Valid values are default, dedicated or host.
    VirtualizationType string
    Keyword to choose what virtualization mode created instances will use. Valid values are paravirtual or hvm.
    layerIds List<String>
    List of the layers the instance will belong to.
    stackId String

    Identifier of the stack the instance will belong to.

    The following arguments are optional:

    agentVersion String
    OpsWorks agent to install. Default is INHERIT.
    amiId String
    AMI to use for the instance. If an AMI is specified, os must be Custom.
    architecture String
    Machine architecture for created instances. Valid values are x86_64 or i386. The default is x86_64.
    autoScalingType String
    Creates load-based or time-based instances. Valid values are load, timer.
    availabilityZone String
    Name of the availability zone where instances will be created by default.
    createdAt String
    Time that the instance was created.
    deleteEbs Boolean
    Whether to delete EBS volume on deletion. Default is true.
    deleteEip Boolean
    Whether to delete the Elastic IP on deletion.
    ebsBlockDevices List<InstanceEbsBlockDevice>
    Configuration block for additional EBS block devices to attach to the instance. See Block Devices below.
    ebsOptimized Boolean
    Whether the launched EC2 instance will be EBS-optimized.
    ecsClusterArn String
    ECS cluster's ARN for container instances.
    elasticIp String
    Instance Elastic IP address.
    ephemeralBlockDevices List<InstanceEphemeralBlockDevice>
    Configuration block for ephemeral (also known as "Instance Store") volumes on the instance. See Block Devices below.
    hostname String
    Instance's host name.
    infrastructureClass String
    For registered instances, infrastructure class: ec2 or on-premises.
    installUpdatesOnBoot Boolean
    Controls where to install OS and package updates when the instance boots. Default is true.
    instanceProfileArn String
    ARN of the instance's IAM profile.
    instanceType String
    Type of instance to start.
    os String
    Name of operating system that will be installed.
    rootBlockDevices List<InstanceRootBlockDevice>
    Configuration block for the root block device of the instance. See Block Devices below.
    rootDeviceType String
    Name of the type of root device instances will have by default. Valid values are ebs or instance-store.
    securityGroupIds List<String>
    Associated security groups.
    sshKeyName String
    Name of the SSH keypair that instances will have by default.
    state String
    Desired state of the instance. Valid values are running or stopped.
    status String
    Instance status. Will be one of booting, connection_lost, online, pending, rebooting, requested, running_setup, setup_failed, shutting_down, start_failed, stop_failed, stopped, stopping, terminated, or terminating.
    subnetId String
    Subnet ID to attach to.
    tenancy String
    Instance tenancy to use. Valid values are default, dedicated or host.
    virtualizationType String
    Keyword to choose what virtualization mode created instances will use. Valid values are paravirtual or hvm.
    layerIds string[]
    List of the layers the instance will belong to.
    stackId string

    Identifier of the stack the instance will belong to.

    The following arguments are optional:

    agentVersion string
    OpsWorks agent to install. Default is INHERIT.
    amiId string
    AMI to use for the instance. If an AMI is specified, os must be Custom.
    architecture string
    Machine architecture for created instances. Valid values are x86_64 or i386. The default is x86_64.
    autoScalingType string
    Creates load-based or time-based instances. Valid values are load, timer.
    availabilityZone string
    Name of the availability zone where instances will be created by default.
    createdAt string
    Time that the instance was created.
    deleteEbs boolean
    Whether to delete EBS volume on deletion. Default is true.
    deleteEip boolean
    Whether to delete the Elastic IP on deletion.
    ebsBlockDevices InstanceEbsBlockDevice[]
    Configuration block for additional EBS block devices to attach to the instance. See Block Devices below.
    ebsOptimized boolean
    Whether the launched EC2 instance will be EBS-optimized.
    ecsClusterArn string
    ECS cluster's ARN for container instances.
    elasticIp string
    Instance Elastic IP address.
    ephemeralBlockDevices InstanceEphemeralBlockDevice[]
    Configuration block for ephemeral (also known as "Instance Store") volumes on the instance. See Block Devices below.
    hostname string
    Instance's host name.
    infrastructureClass string
    For registered instances, infrastructure class: ec2 or on-premises.
    installUpdatesOnBoot boolean
    Controls where to install OS and package updates when the instance boots. Default is true.
    instanceProfileArn string
    ARN of the instance's IAM profile.
    instanceType string
    Type of instance to start.
    os string
    Name of operating system that will be installed.
    rootBlockDevices InstanceRootBlockDevice[]
    Configuration block for the root block device of the instance. See Block Devices below.
    rootDeviceType string
    Name of the type of root device instances will have by default. Valid values are ebs or instance-store.
    securityGroupIds string[]
    Associated security groups.
    sshKeyName string
    Name of the SSH keypair that instances will have by default.
    state string
    Desired state of the instance. Valid values are running or stopped.
    status string
    Instance status. Will be one of booting, connection_lost, online, pending, rebooting, requested, running_setup, setup_failed, shutting_down, start_failed, stop_failed, stopped, stopping, terminated, or terminating.
    subnetId string
    Subnet ID to attach to.
    tenancy string
    Instance tenancy to use. Valid values are default, dedicated or host.
    virtualizationType string
    Keyword to choose what virtualization mode created instances will use. Valid values are paravirtual or hvm.
    layer_ids Sequence[str]
    List of the layers the instance will belong to.
    stack_id str

    Identifier of the stack the instance will belong to.

    The following arguments are optional:

    agent_version str
    OpsWorks agent to install. Default is INHERIT.
    ami_id str
    AMI to use for the instance. If an AMI is specified, os must be Custom.
    architecture str
    Machine architecture for created instances. Valid values are x86_64 or i386. The default is x86_64.
    auto_scaling_type str
    Creates load-based or time-based instances. Valid values are load, timer.
    availability_zone str
    Name of the availability zone where instances will be created by default.
    created_at str
    Time that the instance was created.
    delete_ebs bool
    Whether to delete EBS volume on deletion. Default is true.
    delete_eip bool
    Whether to delete the Elastic IP on deletion.
    ebs_block_devices Sequence[InstanceEbsBlockDeviceArgs]
    Configuration block for additional EBS block devices to attach to the instance. See Block Devices below.
    ebs_optimized bool
    Whether the launched EC2 instance will be EBS-optimized.
    ecs_cluster_arn str
    ECS cluster's ARN for container instances.
    elastic_ip str
    Instance Elastic IP address.
    ephemeral_block_devices Sequence[InstanceEphemeralBlockDeviceArgs]
    Configuration block for ephemeral (also known as "Instance Store") volumes on the instance. See Block Devices below.
    hostname str
    Instance's host name.
    infrastructure_class str
    For registered instances, infrastructure class: ec2 or on-premises.
    install_updates_on_boot bool
    Controls where to install OS and package updates when the instance boots. Default is true.
    instance_profile_arn str
    ARN of the instance's IAM profile.
    instance_type str
    Type of instance to start.
    os str
    Name of operating system that will be installed.
    root_block_devices Sequence[InstanceRootBlockDeviceArgs]
    Configuration block for the root block device of the instance. See Block Devices below.
    root_device_type str
    Name of the type of root device instances will have by default. Valid values are ebs or instance-store.
    security_group_ids Sequence[str]
    Associated security groups.
    ssh_key_name str
    Name of the SSH keypair that instances will have by default.
    state str
    Desired state of the instance. Valid values are running or stopped.
    status str
    Instance status. Will be one of booting, connection_lost, online, pending, rebooting, requested, running_setup, setup_failed, shutting_down, start_failed, stop_failed, stopped, stopping, terminated, or terminating.
    subnet_id str
    Subnet ID to attach to.
    tenancy str
    Instance tenancy to use. Valid values are default, dedicated or host.
    virtualization_type str
    Keyword to choose what virtualization mode created instances will use. Valid values are paravirtual or hvm.
    layerIds List<String>
    List of the layers the instance will belong to.
    stackId String

    Identifier of the stack the instance will belong to.

    The following arguments are optional:

    agentVersion String
    OpsWorks agent to install. Default is INHERIT.
    amiId String
    AMI to use for the instance. If an AMI is specified, os must be Custom.
    architecture String
    Machine architecture for created instances. Valid values are x86_64 or i386. The default is x86_64.
    autoScalingType String
    Creates load-based or time-based instances. Valid values are load, timer.
    availabilityZone String
    Name of the availability zone where instances will be created by default.
    createdAt String
    Time that the instance was created.
    deleteEbs Boolean
    Whether to delete EBS volume on deletion. Default is true.
    deleteEip Boolean
    Whether to delete the Elastic IP on deletion.
    ebsBlockDevices List<Property Map>
    Configuration block for additional EBS block devices to attach to the instance. See Block Devices below.
    ebsOptimized Boolean
    Whether the launched EC2 instance will be EBS-optimized.
    ecsClusterArn String
    ECS cluster's ARN for container instances.
    elasticIp String
    Instance Elastic IP address.
    ephemeralBlockDevices List<Property Map>
    Configuration block for ephemeral (also known as "Instance Store") volumes on the instance. See Block Devices below.
    hostname String
    Instance's host name.
    infrastructureClass String
    For registered instances, infrastructure class: ec2 or on-premises.
    installUpdatesOnBoot Boolean
    Controls where to install OS and package updates when the instance boots. Default is true.
    instanceProfileArn String
    ARN of the instance's IAM profile.
    instanceType String
    Type of instance to start.
    os String
    Name of operating system that will be installed.
    rootBlockDevices List<Property Map>
    Configuration block for the root block device of the instance. See Block Devices below.
    rootDeviceType String
    Name of the type of root device instances will have by default. Valid values are ebs or instance-store.
    securityGroupIds List<String>
    Associated security groups.
    sshKeyName String
    Name of the SSH keypair that instances will have by default.
    state String
    Desired state of the instance. Valid values are running or stopped.
    status String
    Instance status. Will be one of booting, connection_lost, online, pending, rebooting, requested, running_setup, setup_failed, shutting_down, start_failed, stop_failed, stopped, stopping, terminated, or terminating.
    subnetId String
    Subnet ID to attach to.
    tenancy String
    Instance tenancy to use. Valid values are default, dedicated or host.
    virtualizationType String
    Keyword to choose what virtualization mode created instances will use. Valid values are paravirtual or hvm.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Instance resource produces the following output properties:

    Ec2InstanceId string
    EC2 instance ID.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastServiceErrorId string
    ID of the last service error.
    Platform string
    Instance's platform.
    PrivateDns string
    Private DNS name assigned to the instance. Can only be used inside the Amazon EC2, and only available if you've enabled DNS hostnames for your VPC.
    PrivateIp string
    Private IP address assigned to the instance.
    PublicDns string
    Public DNS name assigned to the instance. For EC2-VPC, this is only available if you've enabled DNS hostnames for your VPC.
    PublicIp string
    Public IP address assigned to the instance, if applicable.
    RegisteredBy string
    For registered instances, who performed the registration.
    ReportedAgentVersion string
    Instance's reported AWS OpsWorks Stacks agent version.
    ReportedOsFamily string
    For registered instances, the reported operating system family.
    ReportedOsName string
    For registered instances, the reported operating system name.
    ReportedOsVersion string
    For registered instances, the reported operating system version.
    RootDeviceVolumeId string
    Root device volume ID.
    SshHostDsaKeyFingerprint string
    SSH key's Deep Security Agent (DSA) fingerprint.
    SshHostRsaKeyFingerprint string
    SSH key's RSA fingerprint.
    Ec2InstanceId string
    EC2 instance ID.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastServiceErrorId string
    ID of the last service error.
    Platform string
    Instance's platform.
    PrivateDns string
    Private DNS name assigned to the instance. Can only be used inside the Amazon EC2, and only available if you've enabled DNS hostnames for your VPC.
    PrivateIp string
    Private IP address assigned to the instance.
    PublicDns string
    Public DNS name assigned to the instance. For EC2-VPC, this is only available if you've enabled DNS hostnames for your VPC.
    PublicIp string
    Public IP address assigned to the instance, if applicable.
    RegisteredBy string
    For registered instances, who performed the registration.
    ReportedAgentVersion string
    Instance's reported AWS OpsWorks Stacks agent version.
    ReportedOsFamily string
    For registered instances, the reported operating system family.
    ReportedOsName string
    For registered instances, the reported operating system name.
    ReportedOsVersion string
    For registered instances, the reported operating system version.
    RootDeviceVolumeId string
    Root device volume ID.
    SshHostDsaKeyFingerprint string
    SSH key's Deep Security Agent (DSA) fingerprint.
    SshHostRsaKeyFingerprint string
    SSH key's RSA fingerprint.
    ec2InstanceId String
    EC2 instance ID.
    id String
    The provider-assigned unique ID for this managed resource.
    lastServiceErrorId String
    ID of the last service error.
    platform String
    Instance's platform.
    privateDns String
    Private DNS name assigned to the instance. Can only be used inside the Amazon EC2, and only available if you've enabled DNS hostnames for your VPC.
    privateIp String
    Private IP address assigned to the instance.
    publicDns String
    Public DNS name assigned to the instance. For EC2-VPC, this is only available if you've enabled DNS hostnames for your VPC.
    publicIp String
    Public IP address assigned to the instance, if applicable.
    registeredBy String
    For registered instances, who performed the registration.
    reportedAgentVersion String
    Instance's reported AWS OpsWorks Stacks agent version.
    reportedOsFamily String
    For registered instances, the reported operating system family.
    reportedOsName String
    For registered instances, the reported operating system name.
    reportedOsVersion String
    For registered instances, the reported operating system version.
    rootDeviceVolumeId String
    Root device volume ID.
    sshHostDsaKeyFingerprint String
    SSH key's Deep Security Agent (DSA) fingerprint.
    sshHostRsaKeyFingerprint String
    SSH key's RSA fingerprint.
    ec2InstanceId string
    EC2 instance ID.
    id string
    The provider-assigned unique ID for this managed resource.
    lastServiceErrorId string
    ID of the last service error.
    platform string
    Instance's platform.
    privateDns string
    Private DNS name assigned to the instance. Can only be used inside the Amazon EC2, and only available if you've enabled DNS hostnames for your VPC.
    privateIp string
    Private IP address assigned to the instance.
    publicDns string
    Public DNS name assigned to the instance. For EC2-VPC, this is only available if you've enabled DNS hostnames for your VPC.
    publicIp string
    Public IP address assigned to the instance, if applicable.
    registeredBy string
    For registered instances, who performed the registration.
    reportedAgentVersion string
    Instance's reported AWS OpsWorks Stacks agent version.
    reportedOsFamily string
    For registered instances, the reported operating system family.
    reportedOsName string
    For registered instances, the reported operating system name.
    reportedOsVersion string
    For registered instances, the reported operating system version.
    rootDeviceVolumeId string
    Root device volume ID.
    sshHostDsaKeyFingerprint string
    SSH key's Deep Security Agent (DSA) fingerprint.
    sshHostRsaKeyFingerprint string
    SSH key's RSA fingerprint.
    ec2_instance_id str
    EC2 instance ID.
    id str
    The provider-assigned unique ID for this managed resource.
    last_service_error_id str
    ID of the last service error.
    platform str
    Instance's platform.
    private_dns str
    Private DNS name assigned to the instance. Can only be used inside the Amazon EC2, and only available if you've enabled DNS hostnames for your VPC.
    private_ip str
    Private IP address assigned to the instance.
    public_dns str
    Public DNS name assigned to the instance. For EC2-VPC, this is only available if you've enabled DNS hostnames for your VPC.
    public_ip str
    Public IP address assigned to the instance, if applicable.
    registered_by str
    For registered instances, who performed the registration.
    reported_agent_version str
    Instance's reported AWS OpsWorks Stacks agent version.
    reported_os_family str
    For registered instances, the reported operating system family.
    reported_os_name str
    For registered instances, the reported operating system name.
    reported_os_version str
    For registered instances, the reported operating system version.
    root_device_volume_id str
    Root device volume ID.
    ssh_host_dsa_key_fingerprint str
    SSH key's Deep Security Agent (DSA) fingerprint.
    ssh_host_rsa_key_fingerprint str
    SSH key's RSA fingerprint.
    ec2InstanceId String
    EC2 instance ID.
    id String
    The provider-assigned unique ID for this managed resource.
    lastServiceErrorId String
    ID of the last service error.
    platform String
    Instance's platform.
    privateDns String
    Private DNS name assigned to the instance. Can only be used inside the Amazon EC2, and only available if you've enabled DNS hostnames for your VPC.
    privateIp String
    Private IP address assigned to the instance.
    publicDns String
    Public DNS name assigned to the instance. For EC2-VPC, this is only available if you've enabled DNS hostnames for your VPC.
    publicIp String
    Public IP address assigned to the instance, if applicable.
    registeredBy String
    For registered instances, who performed the registration.
    reportedAgentVersion String
    Instance's reported AWS OpsWorks Stacks agent version.
    reportedOsFamily String
    For registered instances, the reported operating system family.
    reportedOsName String
    For registered instances, the reported operating system name.
    reportedOsVersion String
    For registered instances, the reported operating system version.
    rootDeviceVolumeId String
    Root device volume ID.
    sshHostDsaKeyFingerprint String
    SSH key's Deep Security Agent (DSA) fingerprint.
    sshHostRsaKeyFingerprint String
    SSH key's RSA fingerprint.

    Look up Existing Instance Resource

    Get an existing Instance resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: InstanceState, opts?: CustomResourceOptions): Instance
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        agent_version: Optional[str] = None,
        ami_id: Optional[str] = None,
        architecture: Optional[str] = None,
        auto_scaling_type: Optional[str] = None,
        availability_zone: Optional[str] = None,
        created_at: Optional[str] = None,
        delete_ebs: Optional[bool] = None,
        delete_eip: Optional[bool] = None,
        ebs_block_devices: Optional[Sequence[InstanceEbsBlockDeviceArgs]] = None,
        ebs_optimized: Optional[bool] = None,
        ec2_instance_id: Optional[str] = None,
        ecs_cluster_arn: Optional[str] = None,
        elastic_ip: Optional[str] = None,
        ephemeral_block_devices: Optional[Sequence[InstanceEphemeralBlockDeviceArgs]] = None,
        hostname: Optional[str] = None,
        infrastructure_class: Optional[str] = None,
        install_updates_on_boot: Optional[bool] = None,
        instance_profile_arn: Optional[str] = None,
        instance_type: Optional[str] = None,
        last_service_error_id: Optional[str] = None,
        layer_ids: Optional[Sequence[str]] = None,
        os: Optional[str] = None,
        platform: Optional[str] = None,
        private_dns: Optional[str] = None,
        private_ip: Optional[str] = None,
        public_dns: Optional[str] = None,
        public_ip: Optional[str] = None,
        registered_by: Optional[str] = None,
        reported_agent_version: Optional[str] = None,
        reported_os_family: Optional[str] = None,
        reported_os_name: Optional[str] = None,
        reported_os_version: Optional[str] = None,
        root_block_devices: Optional[Sequence[InstanceRootBlockDeviceArgs]] = None,
        root_device_type: Optional[str] = None,
        root_device_volume_id: Optional[str] = None,
        security_group_ids: Optional[Sequence[str]] = None,
        ssh_host_dsa_key_fingerprint: Optional[str] = None,
        ssh_host_rsa_key_fingerprint: Optional[str] = None,
        ssh_key_name: Optional[str] = None,
        stack_id: Optional[str] = None,
        state: Optional[str] = None,
        status: Optional[str] = None,
        subnet_id: Optional[str] = None,
        tenancy: Optional[str] = None,
        virtualization_type: Optional[str] = None) -> Instance
    func GetInstance(ctx *Context, name string, id IDInput, state *InstanceState, opts ...ResourceOption) (*Instance, error)
    public static Instance Get(string name, Input<string> id, InstanceState? state, CustomResourceOptions? opts = null)
    public static Instance get(String name, Output<String> id, InstanceState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AgentVersion string
    OpsWorks agent to install. Default is INHERIT.
    AmiId string
    AMI to use for the instance. If an AMI is specified, os must be Custom.
    Architecture string
    Machine architecture for created instances. Valid values are x86_64 or i386. The default is x86_64.
    AutoScalingType string
    Creates load-based or time-based instances. Valid values are load, timer.
    AvailabilityZone string
    Name of the availability zone where instances will be created by default.
    CreatedAt string
    Time that the instance was created.
    DeleteEbs bool
    Whether to delete EBS volume on deletion. Default is true.
    DeleteEip bool
    Whether to delete the Elastic IP on deletion.
    EbsBlockDevices List<InstanceEbsBlockDevice>
    Configuration block for additional EBS block devices to attach to the instance. See Block Devices below.
    EbsOptimized bool
    Whether the launched EC2 instance will be EBS-optimized.
    Ec2InstanceId string
    EC2 instance ID.
    EcsClusterArn string
    ECS cluster's ARN for container instances.
    ElasticIp string
    Instance Elastic IP address.
    EphemeralBlockDevices List<InstanceEphemeralBlockDevice>
    Configuration block for ephemeral (also known as "Instance Store") volumes on the instance. See Block Devices below.
    Hostname string
    Instance's host name.
    InfrastructureClass string
    For registered instances, infrastructure class: ec2 or on-premises.
    InstallUpdatesOnBoot bool
    Controls where to install OS and package updates when the instance boots. Default is true.
    InstanceProfileArn string
    ARN of the instance's IAM profile.
    InstanceType string
    Type of instance to start.
    LastServiceErrorId string
    ID of the last service error.
    LayerIds List<string>
    List of the layers the instance will belong to.
    Os string
    Name of operating system that will be installed.
    Platform string
    Instance's platform.
    PrivateDns string
    Private DNS name assigned to the instance. Can only be used inside the Amazon EC2, and only available if you've enabled DNS hostnames for your VPC.
    PrivateIp string
    Private IP address assigned to the instance.
    PublicDns string
    Public DNS name assigned to the instance. For EC2-VPC, this is only available if you've enabled DNS hostnames for your VPC.
    PublicIp string
    Public IP address assigned to the instance, if applicable.
    RegisteredBy string
    For registered instances, who performed the registration.
    ReportedAgentVersion string
    Instance's reported AWS OpsWorks Stacks agent version.
    ReportedOsFamily string
    For registered instances, the reported operating system family.
    ReportedOsName string
    For registered instances, the reported operating system name.
    ReportedOsVersion string
    For registered instances, the reported operating system version.
    RootBlockDevices List<InstanceRootBlockDevice>
    Configuration block for the root block device of the instance. See Block Devices below.
    RootDeviceType string
    Name of the type of root device instances will have by default. Valid values are ebs or instance-store.
    RootDeviceVolumeId string
    Root device volume ID.
    SecurityGroupIds List<string>
    Associated security groups.
    SshHostDsaKeyFingerprint string
    SSH key's Deep Security Agent (DSA) fingerprint.
    SshHostRsaKeyFingerprint string
    SSH key's RSA fingerprint.
    SshKeyName string
    Name of the SSH keypair that instances will have by default.
    StackId string

    Identifier of the stack the instance will belong to.

    The following arguments are optional:

    State string
    Desired state of the instance. Valid values are running or stopped.
    Status string
    Instance status. Will be one of booting, connection_lost, online, pending, rebooting, requested, running_setup, setup_failed, shutting_down, start_failed, stop_failed, stopped, stopping, terminated, or terminating.
    SubnetId string
    Subnet ID to attach to.
    Tenancy string
    Instance tenancy to use. Valid values are default, dedicated or host.
    VirtualizationType string
    Keyword to choose what virtualization mode created instances will use. Valid values are paravirtual or hvm.
    AgentVersion string
    OpsWorks agent to install. Default is INHERIT.
    AmiId string
    AMI to use for the instance. If an AMI is specified, os must be Custom.
    Architecture string
    Machine architecture for created instances. Valid values are x86_64 or i386. The default is x86_64.
    AutoScalingType string
    Creates load-based or time-based instances. Valid values are load, timer.
    AvailabilityZone string
    Name of the availability zone where instances will be created by default.
    CreatedAt string
    Time that the instance was created.
    DeleteEbs bool
    Whether to delete EBS volume on deletion. Default is true.
    DeleteEip bool
    Whether to delete the Elastic IP on deletion.
    EbsBlockDevices []InstanceEbsBlockDeviceArgs
    Configuration block for additional EBS block devices to attach to the instance. See Block Devices below.
    EbsOptimized bool
    Whether the launched EC2 instance will be EBS-optimized.
    Ec2InstanceId string
    EC2 instance ID.
    EcsClusterArn string
    ECS cluster's ARN for container instances.
    ElasticIp string
    Instance Elastic IP address.
    EphemeralBlockDevices []InstanceEphemeralBlockDeviceArgs
    Configuration block for ephemeral (also known as "Instance Store") volumes on the instance. See Block Devices below.
    Hostname string
    Instance's host name.
    InfrastructureClass string
    For registered instances, infrastructure class: ec2 or on-premises.
    InstallUpdatesOnBoot bool
    Controls where to install OS and package updates when the instance boots. Default is true.
    InstanceProfileArn string
    ARN of the instance's IAM profile.
    InstanceType string
    Type of instance to start.
    LastServiceErrorId string
    ID of the last service error.
    LayerIds []string
    List of the layers the instance will belong to.
    Os string
    Name of operating system that will be installed.
    Platform string
    Instance's platform.
    PrivateDns string
    Private DNS name assigned to the instance. Can only be used inside the Amazon EC2, and only available if you've enabled DNS hostnames for your VPC.
    PrivateIp string
    Private IP address assigned to the instance.
    PublicDns string
    Public DNS name assigned to the instance. For EC2-VPC, this is only available if you've enabled DNS hostnames for your VPC.
    PublicIp string
    Public IP address assigned to the instance, if applicable.
    RegisteredBy string
    For registered instances, who performed the registration.
    ReportedAgentVersion string
    Instance's reported AWS OpsWorks Stacks agent version.
    ReportedOsFamily string
    For registered instances, the reported operating system family.
    ReportedOsName string
    For registered instances, the reported operating system name.
    ReportedOsVersion string
    For registered instances, the reported operating system version.
    RootBlockDevices []InstanceRootBlockDeviceArgs
    Configuration block for the root block device of the instance. See Block Devices below.
    RootDeviceType string
    Name of the type of root device instances will have by default. Valid values are ebs or instance-store.
    RootDeviceVolumeId string
    Root device volume ID.
    SecurityGroupIds []string
    Associated security groups.
    SshHostDsaKeyFingerprint string
    SSH key's Deep Security Agent (DSA) fingerprint.
    SshHostRsaKeyFingerprint string
    SSH key's RSA fingerprint.
    SshKeyName string
    Name of the SSH keypair that instances will have by default.
    StackId string

    Identifier of the stack the instance will belong to.

    The following arguments are optional:

    State string
    Desired state of the instance. Valid values are running or stopped.
    Status string
    Instance status. Will be one of booting, connection_lost, online, pending, rebooting, requested, running_setup, setup_failed, shutting_down, start_failed, stop_failed, stopped, stopping, terminated, or terminating.
    SubnetId string
    Subnet ID to attach to.
    Tenancy string
    Instance tenancy to use. Valid values are default, dedicated or host.
    VirtualizationType string
    Keyword to choose what virtualization mode created instances will use. Valid values are paravirtual or hvm.
    agentVersion String
    OpsWorks agent to install. Default is INHERIT.
    amiId String
    AMI to use for the instance. If an AMI is specified, os must be Custom.
    architecture String
    Machine architecture for created instances. Valid values are x86_64 or i386. The default is x86_64.
    autoScalingType String
    Creates load-based or time-based instances. Valid values are load, timer.
    availabilityZone String
    Name of the availability zone where instances will be created by default.
    createdAt String
    Time that the instance was created.
    deleteEbs Boolean
    Whether to delete EBS volume on deletion. Default is true.
    deleteEip Boolean
    Whether to delete the Elastic IP on deletion.
    ebsBlockDevices List<InstanceEbsBlockDevice>
    Configuration block for additional EBS block devices to attach to the instance. See Block Devices below.
    ebsOptimized Boolean
    Whether the launched EC2 instance will be EBS-optimized.
    ec2InstanceId String
    EC2 instance ID.
    ecsClusterArn String
    ECS cluster's ARN for container instances.
    elasticIp String
    Instance Elastic IP address.
    ephemeralBlockDevices List<InstanceEphemeralBlockDevice>
    Configuration block for ephemeral (also known as "Instance Store") volumes on the instance. See Block Devices below.
    hostname String
    Instance's host name.
    infrastructureClass String
    For registered instances, infrastructure class: ec2 or on-premises.
    installUpdatesOnBoot Boolean
    Controls where to install OS and package updates when the instance boots. Default is true.
    instanceProfileArn String
    ARN of the instance's IAM profile.
    instanceType String
    Type of instance to start.
    lastServiceErrorId String
    ID of the last service error.
    layerIds List<String>
    List of the layers the instance will belong to.
    os String
    Name of operating system that will be installed.
    platform String
    Instance's platform.
    privateDns String
    Private DNS name assigned to the instance. Can only be used inside the Amazon EC2, and only available if you've enabled DNS hostnames for your VPC.
    privateIp String
    Private IP address assigned to the instance.
    publicDns String
    Public DNS name assigned to the instance. For EC2-VPC, this is only available if you've enabled DNS hostnames for your VPC.
    publicIp String
    Public IP address assigned to the instance, if applicable.
    registeredBy String
    For registered instances, who performed the registration.
    reportedAgentVersion String
    Instance's reported AWS OpsWorks Stacks agent version.
    reportedOsFamily String
    For registered instances, the reported operating system family.
    reportedOsName String
    For registered instances, the reported operating system name.
    reportedOsVersion String
    For registered instances, the reported operating system version.
    rootBlockDevices List<InstanceRootBlockDevice>
    Configuration block for the root block device of the instance. See Block Devices below.
    rootDeviceType String
    Name of the type of root device instances will have by default. Valid values are ebs or instance-store.
    rootDeviceVolumeId String
    Root device volume ID.
    securityGroupIds List<String>
    Associated security groups.
    sshHostDsaKeyFingerprint String
    SSH key's Deep Security Agent (DSA) fingerprint.
    sshHostRsaKeyFingerprint String
    SSH key's RSA fingerprint.
    sshKeyName String
    Name of the SSH keypair that instances will have by default.
    stackId String

    Identifier of the stack the instance will belong to.

    The following arguments are optional:

    state String
    Desired state of the instance. Valid values are running or stopped.
    status String
    Instance status. Will be one of booting, connection_lost, online, pending, rebooting, requested, running_setup, setup_failed, shutting_down, start_failed, stop_failed, stopped, stopping, terminated, or terminating.
    subnetId String
    Subnet ID to attach to.
    tenancy String
    Instance tenancy to use. Valid values are default, dedicated or host.
    virtualizationType String
    Keyword to choose what virtualization mode created instances will use. Valid values are paravirtual or hvm.
    agentVersion string
    OpsWorks agent to install. Default is INHERIT.
    amiId string
    AMI to use for the instance. If an AMI is specified, os must be Custom.
    architecture string
    Machine architecture for created instances. Valid values are x86_64 or i386. The default is x86_64.
    autoScalingType string
    Creates load-based or time-based instances. Valid values are load, timer.
    availabilityZone string
    Name of the availability zone where instances will be created by default.
    createdAt string
    Time that the instance was created.
    deleteEbs boolean
    Whether to delete EBS volume on deletion. Default is true.
    deleteEip boolean
    Whether to delete the Elastic IP on deletion.
    ebsBlockDevices InstanceEbsBlockDevice[]
    Configuration block for additional EBS block devices to attach to the instance. See Block Devices below.
    ebsOptimized boolean
    Whether the launched EC2 instance will be EBS-optimized.
    ec2InstanceId string
    EC2 instance ID.
    ecsClusterArn string
    ECS cluster's ARN for container instances.
    elasticIp string
    Instance Elastic IP address.
    ephemeralBlockDevices InstanceEphemeralBlockDevice[]
    Configuration block for ephemeral (also known as "Instance Store") volumes on the instance. See Block Devices below.
    hostname string
    Instance's host name.
    infrastructureClass string
    For registered instances, infrastructure class: ec2 or on-premises.
    installUpdatesOnBoot boolean
    Controls where to install OS and package updates when the instance boots. Default is true.
    instanceProfileArn string
    ARN of the instance's IAM profile.
    instanceType string
    Type of instance to start.
    lastServiceErrorId string
    ID of the last service error.
    layerIds string[]
    List of the layers the instance will belong to.
    os string
    Name of operating system that will be installed.
    platform string
    Instance's platform.
    privateDns string
    Private DNS name assigned to the instance. Can only be used inside the Amazon EC2, and only available if you've enabled DNS hostnames for your VPC.
    privateIp string
    Private IP address assigned to the instance.
    publicDns string
    Public DNS name assigned to the instance. For EC2-VPC, this is only available if you've enabled DNS hostnames for your VPC.
    publicIp string
    Public IP address assigned to the instance, if applicable.
    registeredBy string
    For registered instances, who performed the registration.
    reportedAgentVersion string
    Instance's reported AWS OpsWorks Stacks agent version.
    reportedOsFamily string
    For registered instances, the reported operating system family.
    reportedOsName string
    For registered instances, the reported operating system name.
    reportedOsVersion string
    For registered instances, the reported operating system version.
    rootBlockDevices InstanceRootBlockDevice[]
    Configuration block for the root block device of the instance. See Block Devices below.
    rootDeviceType string
    Name of the type of root device instances will have by default. Valid values are ebs or instance-store.
    rootDeviceVolumeId string
    Root device volume ID.
    securityGroupIds string[]
    Associated security groups.
    sshHostDsaKeyFingerprint string
    SSH key's Deep Security Agent (DSA) fingerprint.
    sshHostRsaKeyFingerprint string
    SSH key's RSA fingerprint.
    sshKeyName string
    Name of the SSH keypair that instances will have by default.
    stackId string

    Identifier of the stack the instance will belong to.

    The following arguments are optional:

    state string
    Desired state of the instance. Valid values are running or stopped.
    status string
    Instance status. Will be one of booting, connection_lost, online, pending, rebooting, requested, running_setup, setup_failed, shutting_down, start_failed, stop_failed, stopped, stopping, terminated, or terminating.
    subnetId string
    Subnet ID to attach to.
    tenancy string
    Instance tenancy to use. Valid values are default, dedicated or host.
    virtualizationType string
    Keyword to choose what virtualization mode created instances will use. Valid values are paravirtual or hvm.
    agent_version str
    OpsWorks agent to install. Default is INHERIT.
    ami_id str
    AMI to use for the instance. If an AMI is specified, os must be Custom.
    architecture str
    Machine architecture for created instances. Valid values are x86_64 or i386. The default is x86_64.
    auto_scaling_type str
    Creates load-based or time-based instances. Valid values are load, timer.
    availability_zone str
    Name of the availability zone where instances will be created by default.
    created_at str
    Time that the instance was created.
    delete_ebs bool
    Whether to delete EBS volume on deletion. Default is true.
    delete_eip bool
    Whether to delete the Elastic IP on deletion.
    ebs_block_devices Sequence[InstanceEbsBlockDeviceArgs]
    Configuration block for additional EBS block devices to attach to the instance. See Block Devices below.
    ebs_optimized bool
    Whether the launched EC2 instance will be EBS-optimized.
    ec2_instance_id str
    EC2 instance ID.
    ecs_cluster_arn str
    ECS cluster's ARN for container instances.
    elastic_ip str
    Instance Elastic IP address.
    ephemeral_block_devices Sequence[InstanceEphemeralBlockDeviceArgs]
    Configuration block for ephemeral (also known as "Instance Store") volumes on the instance. See Block Devices below.
    hostname str
    Instance's host name.
    infrastructure_class str
    For registered instances, infrastructure class: ec2 or on-premises.
    install_updates_on_boot bool
    Controls where to install OS and package updates when the instance boots. Default is true.
    instance_profile_arn str
    ARN of the instance's IAM profile.
    instance_type str
    Type of instance to start.
    last_service_error_id str
    ID of the last service error.
    layer_ids Sequence[str]
    List of the layers the instance will belong to.
    os str
    Name of operating system that will be installed.
    platform str
    Instance's platform.
    private_dns str
    Private DNS name assigned to the instance. Can only be used inside the Amazon EC2, and only available if you've enabled DNS hostnames for your VPC.
    private_ip str
    Private IP address assigned to the instance.
    public_dns str
    Public DNS name assigned to the instance. For EC2-VPC, this is only available if you've enabled DNS hostnames for your VPC.
    public_ip str
    Public IP address assigned to the instance, if applicable.
    registered_by str
    For registered instances, who performed the registration.
    reported_agent_version str
    Instance's reported AWS OpsWorks Stacks agent version.
    reported_os_family str
    For registered instances, the reported operating system family.
    reported_os_name str
    For registered instances, the reported operating system name.
    reported_os_version str
    For registered instances, the reported operating system version.
    root_block_devices Sequence[InstanceRootBlockDeviceArgs]
    Configuration block for the root block device of the instance. See Block Devices below.
    root_device_type str
    Name of the type of root device instances will have by default. Valid values are ebs or instance-store.
    root_device_volume_id str
    Root device volume ID.
    security_group_ids Sequence[str]
    Associated security groups.
    ssh_host_dsa_key_fingerprint str
    SSH key's Deep Security Agent (DSA) fingerprint.
    ssh_host_rsa_key_fingerprint str
    SSH key's RSA fingerprint.
    ssh_key_name str
    Name of the SSH keypair that instances will have by default.
    stack_id str

    Identifier of the stack the instance will belong to.

    The following arguments are optional:

    state str
    Desired state of the instance. Valid values are running or stopped.
    status str
    Instance status. Will be one of booting, connection_lost, online, pending, rebooting, requested, running_setup, setup_failed, shutting_down, start_failed, stop_failed, stopped, stopping, terminated, or terminating.
    subnet_id str
    Subnet ID to attach to.
    tenancy str
    Instance tenancy to use. Valid values are default, dedicated or host.
    virtualization_type str
    Keyword to choose what virtualization mode created instances will use. Valid values are paravirtual or hvm.
    agentVersion String
    OpsWorks agent to install. Default is INHERIT.
    amiId String
    AMI to use for the instance. If an AMI is specified, os must be Custom.
    architecture String
    Machine architecture for created instances. Valid values are x86_64 or i386. The default is x86_64.
    autoScalingType String
    Creates load-based or time-based instances. Valid values are load, timer.
    availabilityZone String
    Name of the availability zone where instances will be created by default.
    createdAt String
    Time that the instance was created.
    deleteEbs Boolean
    Whether to delete EBS volume on deletion. Default is true.
    deleteEip Boolean
    Whether to delete the Elastic IP on deletion.
    ebsBlockDevices List<Property Map>
    Configuration block for additional EBS block devices to attach to the instance. See Block Devices below.
    ebsOptimized Boolean
    Whether the launched EC2 instance will be EBS-optimized.
    ec2InstanceId String
    EC2 instance ID.
    ecsClusterArn String
    ECS cluster's ARN for container instances.
    elasticIp String
    Instance Elastic IP address.
    ephemeralBlockDevices List<Property Map>
    Configuration block for ephemeral (also known as "Instance Store") volumes on the instance. See Block Devices below.
    hostname String
    Instance's host name.
    infrastructureClass String
    For registered instances, infrastructure class: ec2 or on-premises.
    installUpdatesOnBoot Boolean
    Controls where to install OS and package updates when the instance boots. Default is true.
    instanceProfileArn String
    ARN of the instance's IAM profile.
    instanceType String
    Type of instance to start.
    lastServiceErrorId String
    ID of the last service error.
    layerIds List<String>
    List of the layers the instance will belong to.
    os String
    Name of operating system that will be installed.
    platform String
    Instance's platform.
    privateDns String
    Private DNS name assigned to the instance. Can only be used inside the Amazon EC2, and only available if you've enabled DNS hostnames for your VPC.
    privateIp String
    Private IP address assigned to the instance.
    publicDns String
    Public DNS name assigned to the instance. For EC2-VPC, this is only available if you've enabled DNS hostnames for your VPC.
    publicIp String
    Public IP address assigned to the instance, if applicable.
    registeredBy String
    For registered instances, who performed the registration.
    reportedAgentVersion String
    Instance's reported AWS OpsWorks Stacks agent version.
    reportedOsFamily String
    For registered instances, the reported operating system family.
    reportedOsName String
    For registered instances, the reported operating system name.
    reportedOsVersion String
    For registered instances, the reported operating system version.
    rootBlockDevices List<Property Map>
    Configuration block for the root block device of the instance. See Block Devices below.
    rootDeviceType String
    Name of the type of root device instances will have by default. Valid values are ebs or instance-store.
    rootDeviceVolumeId String
    Root device volume ID.
    securityGroupIds List<String>
    Associated security groups.
    sshHostDsaKeyFingerprint String
    SSH key's Deep Security Agent (DSA) fingerprint.
    sshHostRsaKeyFingerprint String
    SSH key's RSA fingerprint.
    sshKeyName String
    Name of the SSH keypair that instances will have by default.
    stackId String

    Identifier of the stack the instance will belong to.

    The following arguments are optional:

    state String
    Desired state of the instance. Valid values are running or stopped.
    status String
    Instance status. Will be one of booting, connection_lost, online, pending, rebooting, requested, running_setup, setup_failed, shutting_down, start_failed, stop_failed, stopped, stopping, terminated, or terminating.
    subnetId String
    Subnet ID to attach to.
    tenancy String
    Instance tenancy to use. Valid values are default, dedicated or host.
    virtualizationType String
    Keyword to choose what virtualization mode created instances will use. Valid values are paravirtual or hvm.

    Supporting Types

    InstanceEbsBlockDevice, InstanceEbsBlockDeviceArgs

    deviceName String
    deleteOnTermination Boolean
    iops Integer
    snapshotId String
    volumeSize Integer
    volumeType String
    deviceName string
    deleteOnTermination boolean
    iops number
    snapshotId string
    volumeSize number
    volumeType string
    deviceName String
    deleteOnTermination Boolean
    iops Number
    snapshotId String
    volumeSize Number
    volumeType String

    InstanceEphemeralBlockDevice, InstanceEphemeralBlockDeviceArgs

    DeviceName string
    VirtualName string
    DeviceName string
    VirtualName string
    deviceName String
    virtualName String
    deviceName string
    virtualName string
    deviceName String
    virtualName String

    InstanceRootBlockDevice, InstanceRootBlockDeviceArgs

    deleteOnTermination Boolean
    iops Integer
    volumeSize Integer
    volumeType String
    deleteOnTermination boolean
    iops number
    volumeSize number
    volumeType string
    deleteOnTermination Boolean
    iops Number
    volumeSize Number
    volumeType String

    Import

    Using pulumi import, import Opsworks Instances using the instance id. For example:

    $ pulumi import aws:opsworks/instance:Instance my_instance 4d6d1710-ded9-42a1-b08e-b043ad7af1e2

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
    pulumi/pulumi-aws