You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::OpsWorks::Types::Instance

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Describes an instance.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#agent_version ⇒ String

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.

Returns:

  • (String) —

    The agent version.

#ami_id ⇒ String

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

Returns:

  • (String) —

    A custom AMI ID to be used to create the instance.

#architecture ⇒ String

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

Possible values:

  • x86_64
  • i386

Returns:

  • (String) —

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

#arn ⇒ String

The instance\'s Amazon Resource Number (ARN).

Returns:

  • (String) —

    The instance\'s Amazon Resource Number (ARN).

#auto_scaling_type ⇒ String

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

Possible values:

  • load
  • timer

Returns:

  • (String) —

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

#availability_zone ⇒ String

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

Returns:

  • (String) —

    The instance Availability Zone.

#block_device_mappings ⇒ Array<Types::BlockDeviceMapping>

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

Returns:

  • (Array<Types::BlockDeviceMapping>) —

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

#created_at ⇒ String

The time that the instance was created.

Returns:

  • (String) —

    The time that the instance was created.

#ebs_optimized ⇒ Boolean

Whether this is an Amazon EBS-optimized instance.

Returns:

  • (Boolean) —

    Whether this is an Amazon EBS-optimized instance.

#ec2_instance_id ⇒ String

The ID of the associated Amazon EC2 instance.

Returns:

  • (String) —

    The ID of the associated Amazon EC2 instance.

#ecs_cluster_arn ⇒ String

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

Returns:

  • (String) —

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

#ecs_container_instance_arn ⇒ String

For container instances, the instance\'s ARN.

Returns:

  • (String) —

    For container instances, the instance\'s ARN.

#elastic_ip ⇒ String

The instance Elastic IP address .

Returns:

  • (String) —

    The instance [Elastic IP address ][1].

#hostname ⇒ String

The instance host name.

Returns:

  • (String) —

    The instance host name.

#infrastructure_class ⇒ String

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

Returns:

  • (String) —

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

#install_updates_on_boot ⇒ Boolean

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.

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

Returns:

  • (Boolean) —

    Whether to install operating system and package updates when the instance boots.

#instance_id ⇒ String

The instance ID.

Returns:

  • (String) —

    The instance ID.

#instance_profile_arn ⇒ String

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

Returns:

  • (String) —

    The ARN of the instance\'s IAM profile.

#instance_type ⇒ String

The instance type, such as t2.micro.

Returns:

  • (String) —

    The instance type, such as t2.micro.

#last_service_error_id ⇒ String

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

Returns:

  • (String) —

    The ID of the last service error.

#layer_ids ⇒ Array<String>

An array containing the instance layer IDs.

Returns:

  • (Array<String>) —

    An array containing the instance layer IDs.

#os ⇒ String

The instance\'s operating system.

Returns:

  • (String) —

    The instance\'s operating system.

#platform ⇒ String

The instance\'s platform.

Returns:

  • (String) —

    The instance\'s platform.

#private_dns ⇒ String

The instance\'s private DNS name.

Returns:

  • (String) —

    The instance\'s private DNS name.

#private_ip ⇒ String

The instance\'s private IP address.

Returns:

  • (String) —

    The instance\'s private IP address.

#public_dns ⇒ String

The instance public DNS name.

Returns:

  • (String) —

    The instance public DNS name.

#public_ip ⇒ String

The instance public IP address.

Returns:

  • (String) —

    The instance public IP address.

#registered_by ⇒ String

For registered instances, who performed the registration.

Returns:

  • (String) —

    For registered instances, who performed the registration.

#reported_agent_version ⇒ String

The instance\'s reported AWS OpsWorks Stacks agent version.

Returns:

  • (String) —

    The instance\'s reported AWS OpsWorks Stacks agent version.

#reported_os ⇒ Types::ReportedOs

For registered instances, the reported operating system.

Returns:

#root_device_type ⇒ String

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

Returns:

  • (String) —

    The instance\'s root device type.

#root_device_volume_id ⇒ String

The root device volume ID.

Returns:

  • (String) —

    The root device volume ID.

#security_group_ids ⇒ Array<String>

An array containing the instance security group IDs.

Returns:

  • (Array<String>) —

    An array containing the instance security group IDs.

#ssh_host_dsa_key_fingerprint ⇒ String

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

Returns:

  • (String) —

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

#ssh_host_rsa_key_fingerprint ⇒ String

The SSH key\'s RSA fingerprint.

Returns:

  • (String) —

    The SSH key\'s RSA fingerprint.

#ssh_key_name ⇒ String

The instance\'s Amazon EC2 key-pair name.

Returns:

  • (String) —

    The instance\'s Amazon EC2 key-pair name.

#stack_id ⇒ String

The stack ID.

Returns:

  • (String) —

    The stack ID.

#status ⇒ String

The instance status:

  • booting

  • connection_lost

  • online

  • pending

  • rebooting

  • requested

  • running_setup

  • setup_failed

  • shutting_down

  • start_failed

  • stop_failed

  • stopped

  • stopping

  • terminated

  • terminating

Returns:

  • (String) —

    The instance status:.

#subnet_id ⇒ String

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

Returns:

  • (String) —

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

#tenancy ⇒ String

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

Returns:

  • (String) —

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

#virtualization_type ⇒ String

The instance\'s virtualization type: paravirtual or hvm.

Possible values:

  • paravirtual
  • hvm

Returns:

  • (String) —

    The instance\'s virtualization type: paravirtual or hvm.