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

Class: Aws::SSM::Types::InstanceInformation

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

Overview

Describes a filter for a specific list of instances.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#activation_id ⇒ String

The activation ID created by Systems Manager when the server or VM was registered.

Returns:

  • (String) —

    The activation ID created by Systems Manager when the server or VM was registered.

#agent_version ⇒ String

The version of SSM Agent running on your Linux instance.

Returns:

  • (String) —

    The version of SSM Agent running on your Linux instance.

#association_overview ⇒ Types::InstanceAggregatedAssociationOverview

Information about the association.

Returns:

#association_status ⇒ String

The status of the association.

Returns:

  • (String) —

    The status of the association.

#computer_name ⇒ String

The fully qualified host name of the managed instance.

Returns:

  • (String) —

    The fully qualified host name of the managed instance.

#iam_role ⇒ String

The Amazon Identity and Access Management (IAM) role assigned to the on-premises Systems Manager managed instance. This call does not return the IAM role for EC2 instances. To retrieve the IAM role for an EC2 instance, use the Amazon EC2 DescribeInstances action. For information, see DescribeInstances in the Amazon EC2 API Reference or describe-instances in the AWS CLI Command Reference.

Returns:

  • (String) —

    The Amazon Identity and Access Management (IAM) role assigned to the on-premises Systems Manager managed instance.

#instance_id ⇒ String

The instance ID.

Returns:

  • (String) —

    The instance ID.

#ip_address ⇒ String

The IP address of the managed instance.

Returns:

  • (String) —

    The IP address of the managed instance.

#is_latest_version ⇒ Boolean

Indicates whether the latest version of SSM Agent is running on your Linux Managed Instance. This field does not indicate whether or not the latest version is installed on Windows managed instances, because some older versions of Windows Server use the EC2Config service to process SSM requests.

Returns:

  • (Boolean) —

    Indicates whether the latest version of SSM Agent is running on your Linux Managed Instance.

#last_association_execution_date ⇒ Time

The date the association was last run.

Returns:

  • (Time) —

    The date the association was last run.

#last_ping_date_time ⇒ Time

The date and time when agent last pinged Systems Manager service.

Returns:

  • (Time) —

    The date and time when agent last pinged Systems Manager service.

#last_successful_association_execution_date ⇒ Time

The last date the association was successfully run.

Returns:

  • (Time) —

    The last date the association was successfully run.

#name ⇒ String

The name assigned to an on-premises server or virtual machine (VM) when it is activated as a Systems Manager managed instance. The name is specified as the DefaultInstanceName property using the CreateActivation command. It is applied to the managed instance by specifying the Activation Code and Activation ID when you install SSM Agent on the instance, as explained in Install SSM Agent for a hybrid environment (Linux) and Install SSM Agent for a hybrid environment (Windows). To retrieve the Name tag of an EC2 instance, use the Amazon EC2 DescribeInstances action. For information, see DescribeInstances in the Amazon EC2 API Reference or describe-instances in the AWS CLI Command Reference.

Returns:

  • (String) —

    The name assigned to an on-premises server or virtual machine (VM) when it is activated as a Systems Manager managed instance.

#ping_status ⇒ String

Connection status of SSM Agent.

The status Inactive has been deprecated and is no longer in use.

Possible values:

  • Online
  • ConnectionLost
  • Inactive

Returns:

  • (String) —

    Connection status of SSM Agent.

#platform_name ⇒ String

The name of the operating system platform running on your instance.

Returns:

  • (String) —

    The name of the operating system platform running on your instance.

#platform_type ⇒ String

The operating system platform type.

Possible values:

  • Windows
  • Linux

Returns:

  • (String) —

    The operating system platform type.

#platform_version ⇒ String

The version of the OS platform running on your instance.

Returns:

  • (String) —

    The version of the OS platform running on your instance.

#registration_date ⇒ Time

The date the server or VM was registered with AWS as a managed instance.

Returns:

  • (Time) —

    The date the server or VM was registered with AWS as a managed instance.

#resource_type ⇒ String

The type of instance. Instances are either EC2 instances or managed instances.

Possible values:

  • ManagedInstance
  • Document
  • EC2Instance

Returns:

  • (String) —

    The type of instance.