Menu
AWS OpsWorks
API Reference (API Version 2013-02-18)

Instance

Describes an instance.

Contents

AgentVersion

The agent version. This parameter is set to INHERIT if the instance inherits the default stack setting or to a a version number for a fixed agent version.

Type: String

Required: No

AmiId

A custom AMI ID to be used to create the instance. For more information, see Instances

Type: String

Required: No

Architecture

The instance architecture: "i386" or "x86_64".

Type: String

Valid Values: x86_64 | i386

Required: No

Arn

Type: String

Required: No

AutoScalingType

For load-based or time-based instances, the type.

Type: String

Valid Values: load | timer

Required: No

AvailabilityZone

The instance Availability Zone. For more information, see Regions and Endpoints.

Type: String

Required: No

BlockDeviceMappings

An array of BlockDeviceMapping objects that specify the instance's block device mappings.

Type: Array of BlockDeviceMapping objects

Required: No

CreatedAt

The time that the instance was created.

Type: String

Required: No

EbsOptimized

Whether this is an Amazon EBS-optimized instance.

Type: Boolean

Required: No

Ec2InstanceId

The ID of the associated Amazon EC2 instance.

Type: String

Required: No

EcsClusterArn

For container instances, the Amazon ECS cluster's ARN.

Type: String

Required: No

EcsContainerInstanceArn

For container instances, the instance's ARN.

Type: String

Required: No

ElasticIp

The instance Elastic IP address .

Type: String

Required: No

Hostname

The instance host name.

Type: String

Required: No

InfrastructureClass

For registered instances, the infrastructure class: ec2 or on-premises.

Type: String

Required: No

InstallUpdatesOnBoot

Whether to install operating system and package updates when the instance boots. The default value is true. If this value is set to false, you must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

Note

We strongly recommend using the default value of true, to ensure that your instances have the latest security updates.

Type: Boolean

Required: No

InstanceId

The instance ID.

Type: String

Required: No

InstanceProfileArn

The ARN of the instance's IAM profile. For more information about IAM ARNs, see Using Identifiers.

Type: String

Required: No

InstanceType

The instance type, such as t2.micro.

Type: String

Required: No

LastServiceErrorId

The ID of the last service error. For more information, call DescribeServiceErrors.

Type: String

Required: No

LayerIds

An array containing the instance layer IDs.

Type: Array of strings

Required: No

Os

The instance's operating system.

Type: String

Required: No

Platform

The instance's platform.

Type: String

Required: No

PrivateDns

The instance's private DNS name.

Type: String

Required: No

PrivateIp

The instance's private IP address.

Type: String

Required: No

PublicDns

The instance public DNS name.

Type: String

Required: No

PublicIp

The instance public IP address.

Type: String

Required: No

RegisteredBy

For registered instances, who performed the registration.

Type: String

Required: No

ReportedAgentVersion

The instance's reported AWS OpsWorks Stacks agent version.

Type: String

Required: No

ReportedOs

For registered instances, the reported operating system.

Type: ReportedOs object

Required: No

RootDeviceType

The instance's root device type. For more information, see Storage for the Root Device.

Type: String

Valid Values: ebs | instance-store

Required: No

RootDeviceVolumeId

The root device volume ID.

Type: String

Required: No

SecurityGroupIds

An array containing the instance security group IDs.

Type: Array of strings

Required: No

SshHostDsaKeyFingerprint

The SSH key's Deep Security Agent (DSA) fingerprint.

Type: String

Required: No

SshHostRsaKeyFingerprint

The SSH key's RSA fingerprint.

Type: String

Required: No

SshKeyName

The instance's Amazon EC2 key-pair name.

Type: String

Required: No

StackId

The stack ID.

Type: String

Required: No

Status

The instance status:

  • booting

  • connection_lost

  • online

  • pending

  • rebooting

  • requested

  • running_setup

  • setup_failed

  • shutting_down

  • start_failed

  • stop_failed

  • stopped

  • stopping

  • terminated

  • terminating

Type: String

Required: No

SubnetId

The instance's subnet ID; applicable only if the stack is running in a VPC.

Type: String

Required: No

Tenancy

The instance's tenancy option, such as dedicated or host.

Type: String

Required: No

VirtualizationType

The instance's virtualization type: paravirtual or hvm.

Type: String

Valid Values: paravirtual | hvm

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: