class Amazonite::Ssm::InstanceInformation

Overview

Describes a filter for a specific list of managed nodes.

Included Modules

Defined in:

ssm/instance_information.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(instance_id : String | Nil = nil, ping_status : PingStatus | Nil = nil, last_ping_date_time : Time | Nil = nil, agent_version : String | Nil = nil, is_latest_version : Bool | Nil = nil, platform_type : PlatformType | Nil = nil, platform_name : String | Nil = nil, platform_version : String | Nil = nil, activation_id : String | Nil = nil, iam_role : String | Nil = nil, registration_date : Time | Nil = nil, resource_type : ResourceType | Nil = nil, name : String | Nil = nil, ip_address : String | Nil = nil, computer_name : String | Nil = nil, association_status : String | Nil = nil, last_association_execution_date : Time | Nil = nil, last_successful_association_execution_date : Time | Nil = nil, association_overview : InstanceAggregatedAssociationOverview | Nil = nil, source_id : String | Nil = nil, source_type : SourceType | Nil = nil, source_location : String | Nil = nil) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def activation_id : String | Nil #

The activation ID created by Amazon Web Services Systems Manager when the server or virtual machine (VM) was registered.


[View source]
def activation_id=(activation_id : String | Nil) #

The activation ID created by Amazon Web Services Systems Manager when the server or virtual machine (VM) was registered.


[View source]
def agent_version : String | Nil #

The version of SSM Agent running on your Linux managed node.


[View source]
def agent_version=(agent_version : String | Nil) #

The version of SSM Agent running on your Linux managed node.


[View source]
def association_overview : InstanceAggregatedAssociationOverview | Nil #

Information about the association.


[View source]
def association_overview=(association_overview : InstanceAggregatedAssociationOverview | Nil) #

Information about the association.


[View source]
def association_status : String | Nil #

The status of the association.


[View source]
def association_status=(association_status : String | Nil) #

The status of the association.


[View source]
def computer_name : String | Nil #

The fully qualified host name of the managed node.


[View source]
def computer_name=(computer_name : String | Nil) #

The fully qualified host name of the managed node.


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def iam_role : String | Nil #

The role assigned to an Amazon EC2 instance configured with a Systems Manager Quick Setup host management configuration or the role assigned to an on-premises managed node.

This call doesn't return the IAM role for unmanaged Amazon EC2 instances (instances not configured for Systems Manager). To retrieve the role for an unmanaged instance, use the Amazon EC2 DescribeInstances operation. For information, see DescribeInstances in the Amazon EC2 API Reference or describe-instances in the Amazon Web Services CLI Command Reference.


[View source]
def iam_role=(iam_role : String | Nil) #

The role assigned to an Amazon EC2 instance configured with a Systems Manager Quick Setup host management configuration or the role assigned to an on-premises managed node.

This call doesn't return the IAM role for unmanaged Amazon EC2 instances (instances not configured for Systems Manager). To retrieve the role for an unmanaged instance, use the Amazon EC2 DescribeInstances operation. For information, see DescribeInstances in the Amazon EC2 API Reference or describe-instances in the Amazon Web Services CLI Command Reference.


[View source]
def instance_id : String | Nil #

The managed node ID.


[View source]
def instance_id=(instance_id : String | Nil) #

The managed node ID.


[View source]
def ip_address : String | Nil #

The IP address of the managed node.


[View source]
def ip_address=(ip_address : String | Nil) #

The IP address of the managed node.


[View source]
def is_latest_version : Bool | Nil #

Indicates whether the latest version of SSM Agent is running on your Linux managed node. This field doesn't indicate whether or not the latest version is installed on Windows managed nodes, because some older versions of Windows Server use the EC2Config service to process Systems Manager requests.


[View source]
def is_latest_version=(is_latest_version : Bool | Nil) #

Indicates whether the latest version of SSM Agent is running on your Linux managed node. This field doesn't indicate whether or not the latest version is installed on Windows managed nodes, because some older versions of Windows Server use the EC2Config service to process Systems Manager requests.


[View source]
def last_association_execution_date : Time | Nil #

The date the association was last run.


[View source]
def last_association_execution_date=(last_association_execution_date : Time | Nil) #

The date the association was last run.


[View source]
def last_ping_date_time : Time | Nil #

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


[View source]
def last_ping_date_time=(last_ping_date_time : Time | Nil) #

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


[View source]
def last_successful_association_execution_date : Time | Nil #

The last date the association was successfully run.


[View source]
def last_successful_association_execution_date=(last_successful_association_execution_date : Time | Nil) #

The last date the association was successfully run.


[View source]
def name : String | Nil #

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


[View source]
def name=(name : String | Nil) #

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


[View source]
def ping_status : PingStatus | Nil #

Connection status of SSM Agent.

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


[View source]
def ping_status=(ping_status : PingStatus | Nil) #

Connection status of SSM Agent.

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


[View source]
def platform_name : String | Nil #

The name of the operating system platform running on your managed node.


[View source]
def platform_name=(platform_name : String | Nil) #

The name of the operating system platform running on your managed node.


[View source]
def platform_type : PlatformType | Nil #

The operating system platform type.


[View source]
def platform_type=(platform_type : PlatformType | Nil) #

The operating system platform type.


[View source]
def platform_version : String | Nil #

The version of the OS platform running on your managed node.


[View source]
def platform_version=(platform_version : String | Nil) #

The version of the OS platform running on your managed node.


[View source]
def registration_date : Time | Nil #

The date the server or VM was registered with Amazon Web Services as a managed node.


[View source]
def registration_date=(registration_date : Time | Nil) #

The date the server or VM was registered with Amazon Web Services as a managed node.


[View source]
def resource_type : ResourceType | Nil #

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


[View source]
def resource_type=(resource_type : ResourceType | Nil) #

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


[View source]
def source_id : String | Nil #

The ID of the source resource. For IoT Greengrass devices, SourceId is the Thing name.


[View source]
def source_id=(source_id : String | Nil) #

The ID of the source resource. For IoT Greengrass devices, SourceId is the Thing name.


[View source]
def source_location : String | Nil #

The location of the source resource in the third-party cloud environment.


[View source]
def source_location=(source_location : String | Nil) #

The location of the source resource in the third-party cloud environment.


[View source]
def source_type : SourceType | Nil #

The type of the source resource. For IoT Greengrass devices, SourceType is AWS::IoT::Thing. For Azure Virtual Machines, SourceType is Microsoft.Compute/virtualMachines.


[View source]
def source_type=(source_type : SourceType | Nil) #

The type of the source resource. For IoT Greengrass devices, SourceType is AWS::IoT::Thing. For Azure Virtual Machines, SourceType is Microsoft.Compute/virtualMachines.


[View source]
def validate! : Nil #

[View source]