Instance

Provides an OpsWorks instance resource.

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.

The root_block_device mapping supports the following:

volume_type - (Optional) The type of volume. Can be "standard", "gp2", or "io1". (Default: "standard").
volume_size - (Optional) The size of the volume in gigabytes.
iops - (Optional) The amount of provisioned IOPS. This must be set with a volume_type of "io1".
delete_on_termination - (Optional) Whether the volume should be destroyed on instance termination (Default: true).

Modifying any of the root_block_device settings requires resource replacement.

Each ebs_block_device supports the following:

device_name - The name of the device to mount.
snapshot_id - (Optional) The Snapshot ID to mount.
volume_type - (Optional) The type of volume. Can be "standard", "gp2", or "io1". (Default: "standard").
volume_size - (Optional) The size of the volume in gigabytes.
iops - (Optional) The amount of provisioned IOPS. This must be set with a volume_type of "io1".
delete_on_termination - (Optional) Whether the volume should be destroyed on instance termination (Default: true).

Modifying any ebs_block_device currently requires resource replacement.

Each ephemeral_block_device supports the following:

device_name - The name of the block device to mount on the instance.
virtual_name - The Instance Store Device Name (e.g. "ephemeral0")

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}".

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.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var my_instance = new Aws.OpsWorks.Instance("my-instance", new Aws.OpsWorks.InstanceArgs
        {
            InstanceType = "t2.micro",
            LayerIds = 
            {
                aws_opsworks_custom_layer.My_layer.Id,
            },
            Os = "Amazon Linux 2015.09",
            StackId = aws_opsworks_stack.Main.Id,
            State = "stopped",
        });
    }

}

package main

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

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

import pulumi
import pulumi_aws as aws

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

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

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

Create a Instance Resource

new Instance(name: string, args: InstanceArgs, opts?: CustomResourceOptions);

def Instance(resource_name, opts=None, agent_version=None, ami_id=None, architecture=None, auto_scaling_type=None, availability_zone=None, created_at=None, delete_ebs=None, delete_eip=None, ebs_block_devices=None, ebs_optimized=None, ecs_cluster_arn=None, elastic_ip=None, ephemeral_block_devices=None, hostname=None, infrastructure_class=None, install_updates_on_boot=None, instance_profile_arn=None, instance_type=None, last_service_error_id=None, layer_ids=None, os=None, platform=None, private_dns=None, private_ip=None, public_dns=None, public_ip=None, registered_by=None, reported_agent_version=None, reported_os_family=None, reported_os_name=None, reported_os_version=None, root_block_devices=None, root_device_type=None, root_device_volume_id=None, security_group_ids=None, ssh_host_dsa_key_fingerprint=None, ssh_host_rsa_key_fingerprint=None, ssh_key_name=None, stack_id=None, state=None, status=None, subnet_id=None, tenancy=None, virtualization_type=None, __props__=None);

func NewInstance(ctx *Context, name string, args InstanceArgs, opts ...ResourceOption) (*Instance, error)

public Instance(string name, InstanceArgs args, CustomResourceOptions? opts = null)

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.
opts ResourceOptions: A bag of options that control this 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.

Instance Resource Properties

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

Inputs

The Instance resource accepts the following input properties:

LayerIds List<string>: The ids of the layers the instance will belong to.
StackId string: The id of the stack the instance will belong to.
AgentVersion string: The AWS OpsWorks agent to install. Defaults to "INHERIT".
AmiId string: The AMI to use for the instance. If an AMI is specified, os must be "Custom".
Architecture string: Machine architecture for created instances. Can be either "x86_64" (the default) or "i386"
AutoScalingType string: Creates load-based or time-based instances. If set, can be either: "load" or "timer".
AvailabilityZone string: Name of the availability zone where instances will be created by default.
CreatedAt string
DeleteEbs bool
DeleteEip bool
EbsBlockDevices List<InstanceEbsBlockDeviceArgs>: Additional EBS block devices to attach to the instance. See Block Devices below for details.
EbsOptimized bool: If true, the launched EC2 instance will be EBS-optimized.
EcsClusterArn string
ElasticIp string
EphemeralBlockDevices List<InstanceEphemeralBlockDeviceArgs>: Customize Ephemeral (also known as “Instance Store”) volumes on the instance. See Block Devices below for details.
Hostname string: The instance’s host name.
InfrastructureClass string
InstallUpdatesOnBoot bool: Controls where to install OS and package updates when the instance boots. Defaults to true.
InstanceProfileArn string
InstanceType string: The type of instance to start
LastServiceErrorId string
Os string: Name of operating system that will be installed.
Platform string
PrivateDns string: The 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: The private IP address assigned to the instance
PublicDns string: The 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: The public IP address assigned to the instance, if applicable.
RegisteredBy string
ReportedAgentVersion string
ReportedOsFamily string
ReportedOsName string
ReportedOsVersion string
RootBlockDevices List<InstanceRootBlockDeviceArgs>: Customize details about the root block device of the instance. See Block Devices below for details.
RootDeviceType string: Name of the type of root device instances will have by default. Can be either "ebs" or "instance-store"
RootDeviceVolumeId string
SecurityGroupIds List<string>: The associated security groups.
SshHostDsaKeyFingerprint string
SshHostRsaKeyFingerprint string
SshKeyName string: Name of the SSH keypair that instances will have by default.
State string: The desired state of the instance. Can be either "running" or "stopped".
Status string
SubnetId string: Subnet ID to attach to
Tenancy string: Instance tenancy to use. Can be one of "default", "dedicated" or "host"
VirtualizationType string: Keyword to choose what virtualization mode created instances will use. Can be either "paravirtual" or "hvm".

LayerIds []string: The ids of the layers the instance will belong to.
StackId string: The id of the stack the instance will belong to.
AgentVersion string: The AWS OpsWorks agent to install. Defaults to "INHERIT".
AmiId string: The AMI to use for the instance. If an AMI is specified, os must be "Custom".
Architecture string: Machine architecture for created instances. Can be either "x86_64" (the default) or "i386"
AutoScalingType string: Creates load-based or time-based instances. If set, can be either: "load" or "timer".
AvailabilityZone string: Name of the availability zone where instances will be created by default.
CreatedAt string
DeleteEbs bool
DeleteEip bool
EbsBlockDevices []InstanceEbsBlockDevice: Additional EBS block devices to attach to the instance. See Block Devices below for details.
EbsOptimized bool: If true, the launched EC2 instance will be EBS-optimized.
EcsClusterArn string
ElasticIp string
EphemeralBlockDevices []InstanceEphemeralBlockDevice: Customize Ephemeral (also known as “Instance Store”) volumes on the instance. See Block Devices below for details.
Hostname string: The instance’s host name.
InfrastructureClass string
InstallUpdatesOnBoot bool: Controls where to install OS and package updates when the instance boots. Defaults to true.
InstanceProfileArn string
InstanceType string: The type of instance to start
LastServiceErrorId string
Os string: Name of operating system that will be installed.
Platform string
PrivateDns string: The 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: The private IP address assigned to the instance
PublicDns string: The 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: The public IP address assigned to the instance, if applicable.
RegisteredBy string
ReportedAgentVersion string
ReportedOsFamily string
ReportedOsName string
ReportedOsVersion string
RootBlockDevices []InstanceRootBlockDevice: Customize details about the root block device of the instance. See Block Devices below for details.
RootDeviceType string: Name of the type of root device instances will have by default. Can be either "ebs" or "instance-store"
RootDeviceVolumeId string
SecurityGroupIds []string: The associated security groups.
SshHostDsaKeyFingerprint string
SshHostRsaKeyFingerprint string
SshKeyName string: Name of the SSH keypair that instances will have by default.
State string: The desired state of the instance. Can be either "running" or "stopped".
Status string
SubnetId string: Subnet ID to attach to
Tenancy string: Instance tenancy to use. Can be one of "default", "dedicated" or "host"
VirtualizationType string: Keyword to choose what virtualization mode created instances will use. Can be either "paravirtual" or "hvm".

layerIds string[]: The ids of the layers the instance will belong to.
stackId string: The id of the stack the instance will belong to.
agentVersion string: The AWS OpsWorks agent to install. Defaults to "INHERIT".
amiId string: The AMI to use for the instance. If an AMI is specified, os must be "Custom".
architecture string: Machine architecture for created instances. Can be either "x86_64" (the default) or "i386"
autoScalingType string: Creates load-based or time-based instances. If set, can be either: "load" or "timer".
availabilityZone string: Name of the availability zone where instances will be created by default.
createdAt string
deleteEbs boolean
deleteEip boolean
ebsBlockDevices InstanceEbsBlockDevice[]: Additional EBS block devices to attach to the instance. See Block Devices below for details.
ebsOptimized boolean: If true, the launched EC2 instance will be EBS-optimized.
ecsClusterArn string
elasticIp string
ephemeralBlockDevices InstanceEphemeralBlockDevice[]: Customize Ephemeral (also known as “Instance Store”) volumes on the instance. See Block Devices below for details.
hostname string: The instance’s host name.
infrastructureClass string
installUpdatesOnBoot boolean: Controls where to install OS and package updates when the instance boots. Defaults to true.
instanceProfileArn string
instanceType string: The type of instance to start
lastServiceErrorId string
os string: Name of operating system that will be installed.
platform string
privateDns string: The 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: The private IP address assigned to the instance
publicDns string: The 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: The public IP address assigned to the instance, if applicable.
registeredBy string
reportedAgentVersion string
reportedOsFamily string
reportedOsName string
reportedOsVersion string
rootBlockDevices InstanceRootBlockDevice[]: Customize details about the root block device of the instance. See Block Devices below for details.
rootDeviceType string: Name of the type of root device instances will have by default. Can be either "ebs" or "instance-store"
rootDeviceVolumeId string
securityGroupIds string[]: The associated security groups.
sshHostDsaKeyFingerprint string
sshHostRsaKeyFingerprint string
sshKeyName string: Name of the SSH keypair that instances will have by default.
state string: The desired state of the instance. Can be either "running" or "stopped".
status string
subnetId string: Subnet ID to attach to
tenancy string: Instance tenancy to use. Can be one of "default", "dedicated" or "host"
virtualizationType string: Keyword to choose what virtualization mode created instances will use. Can be either "paravirtual" or "hvm".

layer_ids List[str]: The ids of the layers the instance will belong to.
stack_id str: The id of the stack the instance will belong to.
agent_version str: The AWS OpsWorks agent to install. Defaults to "INHERIT".
ami_id str: The AMI to use for the instance. If an AMI is specified, os must be "Custom".
architecture str: Machine architecture for created instances. Can be either "x86_64" (the default) or "i386"
auto_scaling_type str: Creates load-based or time-based instances. If set, can be either: "load" or "timer".
availability_zone str: Name of the availability zone where instances will be created by default.
created_at str
delete_ebs bool
delete_eip bool
ebs_block_devices List[InstanceEbsBlockDevice]: Additional EBS block devices to attach to the instance. See Block Devices below for details.
ebs_optimized bool: If true, the launched EC2 instance will be EBS-optimized.
ecs_cluster_arn str
elastic_ip str
ephemeral_block_devices List[InstanceEphemeralBlockDevice]: Customize Ephemeral (also known as “Instance Store”) volumes on the instance. See Block Devices below for details.
hostname str: The instance’s host name.
infrastructure_class str
install_updates_on_boot bool: Controls where to install OS and package updates when the instance boots. Defaults to true.
instance_profile_arn str
instance_type str: The type of instance to start
last_service_error_id str
os str: Name of operating system that will be installed.
platform str
private_dns str: The 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: The private IP address assigned to the instance
public_dns str: The 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: The public IP address assigned to the instance, if applicable.
registered_by str
reported_agent_version str
reported_os_family str
reported_os_name str
reported_os_version str
root_block_devices List[InstanceRootBlockDevice]: Customize details about the root block device of the instance. See Block Devices below for details.
root_device_type str: Name of the type of root device instances will have by default. Can be either "ebs" or "instance-store"
root_device_volume_id str
security_group_ids List[str]: The associated security groups.
ssh_host_dsa_key_fingerprint str
ssh_host_rsa_key_fingerprint str
ssh_key_name str: Name of the SSH keypair that instances will have by default.
state str: The desired state of the instance. Can be either "running" or "stopped".
status str
subnet_id str: Subnet ID to attach to
tenancy str: Instance tenancy to use. Can be one of "default", "dedicated" or "host"
virtualization_type str: Keyword to choose what virtualization mode created instances will use. Can be either "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.

Ec2InstanceId string: EC2 instance ID
Id string: The provider-assigned unique ID for this managed resource.

ec2InstanceId string: EC2 instance ID
id string: The provider-assigned unique ID for this managed resource.

ec2_instance_id str: EC2 instance ID
id str: The provider-assigned unique ID for this managed resource.

Look up an 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

static get(resource_name, id, opts=None, agent_version=None, ami_id=None, architecture=None, auto_scaling_type=None, availability_zone=None, created_at=None, delete_ebs=None, delete_eip=None, ebs_block_devices=None, ebs_optimized=None, ec2_instance_id=None, ecs_cluster_arn=None, elastic_ip=None, ephemeral_block_devices=None, hostname=None, infrastructure_class=None, install_updates_on_boot=None, instance_profile_arn=None, instance_type=None, last_service_error_id=None, layer_ids=None, os=None, platform=None, private_dns=None, private_ip=None, public_dns=None, public_ip=None, registered_by=None, reported_agent_version=None, reported_os_family=None, reported_os_name=None, reported_os_version=None, root_block_devices=None, root_device_type=None, root_device_volume_id=None, security_group_ids=None, ssh_host_dsa_key_fingerprint=None, ssh_host_rsa_key_fingerprint=None, ssh_key_name=None, stack_id=None, state=None, status=None, subnet_id=None, tenancy=None, virtualization_type=None, __props__=None);

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)

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.

The following state arguments are supported:

AgentVersion string: The AWS OpsWorks agent to install. Defaults to "INHERIT".
AmiId string: The AMI to use for the instance. If an AMI is specified, os must be "Custom".
Architecture string: Machine architecture for created instances. Can be either "x86_64" (the default) or "i386"
AutoScalingType string: Creates load-based or time-based instances. If set, can be either: "load" or "timer".
AvailabilityZone string: Name of the availability zone where instances will be created by default.
CreatedAt string
DeleteEbs bool
DeleteEip bool
EbsBlockDevices List<InstanceEbsBlockDeviceArgs>: Additional EBS block devices to attach to the instance. See Block Devices below for details.
EbsOptimized bool: If true, the launched EC2 instance will be EBS-optimized.
Ec2InstanceId string: EC2 instance ID
EcsClusterArn string
ElasticIp string
EphemeralBlockDevices List<InstanceEphemeralBlockDeviceArgs>: Customize Ephemeral (also known as “Instance Store”) volumes on the instance. See Block Devices below for details.
Hostname string: The instance’s host name.
InfrastructureClass string
InstallUpdatesOnBoot bool: Controls where to install OS and package updates when the instance boots. Defaults to true.
InstanceProfileArn string
InstanceType string: The type of instance to start
LastServiceErrorId string
LayerIds List<string>: The ids of the layers the instance will belong to.
Os string: Name of operating system that will be installed.
Platform string
PrivateDns string: The 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: The private IP address assigned to the instance
PublicDns string: The 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: The public IP address assigned to the instance, if applicable.
RegisteredBy string
ReportedAgentVersion string
ReportedOsFamily string
ReportedOsName string
ReportedOsVersion string
RootBlockDevices List<InstanceRootBlockDeviceArgs>: Customize details about the root block device of the instance. See Block Devices below for details.
RootDeviceType string: Name of the type of root device instances will have by default. Can be either "ebs" or "instance-store"
RootDeviceVolumeId string
SecurityGroupIds List<string>: The associated security groups.
SshHostDsaKeyFingerprint string
SshHostRsaKeyFingerprint string
SshKeyName string: Name of the SSH keypair that instances will have by default.
StackId string: The id of the stack the instance will belong to.
State string: The desired state of the instance. Can be either "running" or "stopped".
Status string
SubnetId string: Subnet ID to attach to
Tenancy string: Instance tenancy to use. Can be one of "default", "dedicated" or "host"
VirtualizationType string: Keyword to choose what virtualization mode created instances will use. Can be either "paravirtual" or "hvm".

AgentVersion string: The AWS OpsWorks agent to install. Defaults to "INHERIT".
AmiId string: The AMI to use for the instance. If an AMI is specified, os must be "Custom".
Architecture string: Machine architecture for created instances. Can be either "x86_64" (the default) or "i386"
AutoScalingType string: Creates load-based or time-based instances. If set, can be either: "load" or "timer".
AvailabilityZone string: Name of the availability zone where instances will be created by default.
CreatedAt string
DeleteEbs bool
DeleteEip bool
EbsBlockDevices []InstanceEbsBlockDevice: Additional EBS block devices to attach to the instance. See Block Devices below for details.
EbsOptimized bool: If true, the launched EC2 instance will be EBS-optimized.
Ec2InstanceId string: EC2 instance ID
EcsClusterArn string
ElasticIp string
EphemeralBlockDevices []InstanceEphemeralBlockDevice: Customize Ephemeral (also known as “Instance Store”) volumes on the instance. See Block Devices below for details.
Hostname string: The instance’s host name.
InfrastructureClass string
InstallUpdatesOnBoot bool: Controls where to install OS and package updates when the instance boots. Defaults to true.
InstanceProfileArn string
InstanceType string: The type of instance to start
LastServiceErrorId string
LayerIds []string: The ids of the layers the instance will belong to.
Os string: Name of operating system that will be installed.
Platform string
PrivateDns string: The 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: The private IP address assigned to the instance
PublicDns string: The 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: The public IP address assigned to the instance, if applicable.
RegisteredBy string
ReportedAgentVersion string
ReportedOsFamily string
ReportedOsName string
ReportedOsVersion string
RootBlockDevices []InstanceRootBlockDevice: Customize details about the root block device of the instance. See Block Devices below for details.
RootDeviceType string: Name of the type of root device instances will have by default. Can be either "ebs" or "instance-store"
RootDeviceVolumeId string
SecurityGroupIds []string: The associated security groups.
SshHostDsaKeyFingerprint string
SshHostRsaKeyFingerprint string
SshKeyName string: Name of the SSH keypair that instances will have by default.
StackId string: The id of the stack the instance will belong to.
State string: The desired state of the instance. Can be either "running" or "stopped".
Status string
SubnetId string: Subnet ID to attach to
Tenancy string: Instance tenancy to use. Can be one of "default", "dedicated" or "host"
VirtualizationType string: Keyword to choose what virtualization mode created instances will use. Can be either "paravirtual" or "hvm".

agentVersion string: The AWS OpsWorks agent to install. Defaults to "INHERIT".
amiId string: The AMI to use for the instance. If an AMI is specified, os must be "Custom".
architecture string: Machine architecture for created instances. Can be either "x86_64" (the default) or "i386"
autoScalingType string: Creates load-based or time-based instances. If set, can be either: "load" or "timer".
availabilityZone string: Name of the availability zone where instances will be created by default.
createdAt string
deleteEbs boolean
deleteEip boolean
ebsBlockDevices InstanceEbsBlockDevice[]: Additional EBS block devices to attach to the instance. See Block Devices below for details.
ebsOptimized boolean: If true, the launched EC2 instance will be EBS-optimized.
ec2InstanceId string: EC2 instance ID
ecsClusterArn string
elasticIp string
ephemeralBlockDevices InstanceEphemeralBlockDevice[]: Customize Ephemeral (also known as “Instance Store”) volumes on the instance. See Block Devices below for details.
hostname string: The instance’s host name.
infrastructureClass string
installUpdatesOnBoot boolean: Controls where to install OS and package updates when the instance boots. Defaults to true.
instanceProfileArn string
instanceType string: The type of instance to start
lastServiceErrorId string
layerIds string[]: The ids of the layers the instance will belong to.
os string: Name of operating system that will be installed.
platform string
privateDns string: The 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: The private IP address assigned to the instance
publicDns string: The 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: The public IP address assigned to the instance, if applicable.
registeredBy string
reportedAgentVersion string
reportedOsFamily string
reportedOsName string
reportedOsVersion string
rootBlockDevices InstanceRootBlockDevice[]: Customize details about the root block device of the instance. See Block Devices below for details.
rootDeviceType string: Name of the type of root device instances will have by default. Can be either "ebs" or "instance-store"
rootDeviceVolumeId string
securityGroupIds string[]: The associated security groups.
sshHostDsaKeyFingerprint string
sshHostRsaKeyFingerprint string
sshKeyName string: Name of the SSH keypair that instances will have by default.
stackId string: The id of the stack the instance will belong to.
state string: The desired state of the instance. Can be either "running" or "stopped".
status string
subnetId string: Subnet ID to attach to
tenancy string: Instance tenancy to use. Can be one of "default", "dedicated" or "host"
virtualizationType string: Keyword to choose what virtualization mode created instances will use. Can be either "paravirtual" or "hvm".

agent_version str: The AWS OpsWorks agent to install. Defaults to "INHERIT".
ami_id str: The AMI to use for the instance. If an AMI is specified, os must be "Custom".
architecture str: Machine architecture for created instances. Can be either "x86_64" (the default) or "i386"
auto_scaling_type str: Creates load-based or time-based instances. If set, can be either: "load" or "timer".
availability_zone str: Name of the availability zone where instances will be created by default.
created_at str
delete_ebs bool
delete_eip bool
ebs_block_devices List[InstanceEbsBlockDevice]: Additional EBS block devices to attach to the instance. See Block Devices below for details.
ebs_optimized bool: If true, the launched EC2 instance will be EBS-optimized.
ec2_instance_id str: EC2 instance ID
ecs_cluster_arn str
elastic_ip str
ephemeral_block_devices List[InstanceEphemeralBlockDevice]: Customize Ephemeral (also known as “Instance Store”) volumes on the instance. See Block Devices below for details.
hostname str: The instance’s host name.
infrastructure_class str
install_updates_on_boot bool: Controls where to install OS and package updates when the instance boots. Defaults to true.
instance_profile_arn str
instance_type str: The type of instance to start
last_service_error_id str
layer_ids List[str]: The ids of the layers the instance will belong to.
os str: Name of operating system that will be installed.
platform str
private_dns str: The 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: The private IP address assigned to the instance
public_dns str: The 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: The public IP address assigned to the instance, if applicable.
registered_by str
reported_agent_version str
reported_os_family str
reported_os_name str
reported_os_version str
root_block_devices List[InstanceRootBlockDevice]: Customize details about the root block device of the instance. See Block Devices below for details.
root_device_type str: Name of the type of root device instances will have by default. Can be either "ebs" or "instance-store"
root_device_volume_id str
security_group_ids List[str]: The associated security groups.
ssh_host_dsa_key_fingerprint str
ssh_host_rsa_key_fingerprint str
ssh_key_name str: Name of the SSH keypair that instances will have by default.
stack_id str: The id of the stack the instance will belong to.
state str: The desired state of the instance. Can be either "running" or "stopped".
status str
subnet_id str: Subnet ID to attach to
tenancy str: Instance tenancy to use. Can be one of "default", "dedicated" or "host"
virtualization_type str: Keyword to choose what virtualization mode created instances will use. Can be either "paravirtual" or "hvm".