class Aws::OpsWorks::Types::Instance

Describes an instance.

@!attribute [rw] agent_version

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.
@return [String]

@!attribute [rw] ami_id

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

[1]: https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html
@return [String]

@!attribute [rw] architecture

The instance architecture: "i386" or "x86\_64".
@return [String]

@!attribute [rw] arn

The instance's Amazon Resource Number (ARN).
@return [String]

@!attribute [rw] auto_scaling_type

For load-based or time-based instances, the type.
@return [String]

@!attribute [rw] availability_zone

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

[1]: https://docs.aws.amazon.com/general/latest/gr/rande.html
@return [String]

@!attribute [rw] block_device_mappings

An array of `BlockDeviceMapping` objects that specify the
instance's block device mappings.
@return [Array<Types::BlockDeviceMapping>]

@!attribute [rw] created_at

The time that the instance was created.
@return [String]

@!attribute [rw] ebs_optimized

Whether this is an Amazon EBS-optimized instance.
@return [Boolean]

@!attribute [rw] ec2_instance_id

The ID of the associated Amazon EC2 instance.
@return [String]

@!attribute [rw] ecs_cluster_arn

For container instances, the Amazon ECS cluster's ARN.
@return [String]

@!attribute [rw] ecs_container_instance_arn

For container instances, the instance's ARN.
@return [String]

@!attribute [rw] elastic_ip

The instance [Elastic IP address ][1].

[1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html
@return [String]

@!attribute [rw] hostname

The instance host name.
@return [String]

@!attribute [rw] infrastructure_class

For registered instances, the infrastructure class: `ec2` or
`on-premises`.
@return [String]

@!attribute [rw] install_updates_on_boot

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 markdown="1"> We strongly recommend using the default value of `true`, to ensure
that your instances have the latest security updates.

 </note>
@return [Boolean]

@!attribute [rw] instance_id

The instance ID.
@return [String]

@!attribute [rw] instance_profile_arn

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

[1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html
@return [String]

@!attribute [rw] instance_type

The instance type, such as `t2.micro`.
@return [String]

@!attribute [rw] last_service_error_id

The ID of the last service error. For more information, call
DescribeServiceErrors.
@return [String]

@!attribute [rw] layer_ids

An array containing the instance layer IDs.
@return [Array<String>]

@!attribute [rw] os

The instance's operating system.
@return [String]

@!attribute [rw] platform

The instance's platform.
@return [String]

@!attribute [rw] private_dns

The instance's private DNS name.
@return [String]

@!attribute [rw] private_ip

The instance's private IP address.
@return [String]

@!attribute [rw] public_dns

The instance public DNS name.
@return [String]

@!attribute [rw] public_ip

The instance public IP address.
@return [String]

@!attribute [rw] registered_by

For registered instances, who performed the registration.
@return [String]

@!attribute [rw] reported_agent_version

The instance's reported AWS OpsWorks Stacks agent version.
@return [String]

@!attribute [rw] reported_os

For registered instances, the reported operating system.
@return [Types::ReportedOs]

@!attribute [rw] root_device_type

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

[1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device
@return [String]

@!attribute [rw] root_device_volume_id

The root device volume ID.
@return [String]

@!attribute [rw] security_group_ids

An array containing the instance security group IDs.
@return [Array<String>]

@!attribute [rw] ssh_host_dsa_key_fingerprint

The SSH key's Deep Security Agent (DSA) fingerprint.
@return [String]

@!attribute [rw] ssh_host_rsa_key_fingerprint

The SSH key's RSA fingerprint.
@return [String]

@!attribute [rw] ssh_key_name

The instance's Amazon EC2 key-pair name.
@return [String]

@!attribute [rw] stack_id

The stack ID.
@return [String]

@!attribute [rw] 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`
@return [String]

@!attribute [rw] subnet_id

The instance's subnet ID; applicable only if the stack is running
in a VPC.
@return [String]

@!attribute [rw] tenancy

The instance's tenancy option, such as `dedicated` or `host`.
@return [String]

@!attribute [rw] virtualization_type

The instance's virtualization type: `paravirtual` or `hvm`.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/opsworks-2013-02-18/Instance AWS API Documentation

Constants

SENSITIVE