instance_properties

Creates, updates, deletes, gets or lists an instance_properties resource.

Overview

Name	instance_properties
Type	Resource
Id	aws.ssm.instance_properties

Fields

The following fields are returned by SELECT queries:

describe_instance_properties

Name	Datatype	Description
activation_id	string	The activation ID created by Systems Manager when the server or virtual machine (VM) was registered (pattern: <code>^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$</code>)
agent_version	string	The version of SSM Agent running on your managed node. (pattern: <code>^[0-9]{1,6}(.[0-9]{1,6}){2,3}$</code>)
architecture	string	The CPU architecture of the node. For example, x86_64.
association_overview	object	Status information about the aggregated associations.
association_status	string	The status of the State Manager association applied to the managed node.
availability_zone	string	The Availability Zone where the managed node is located.
computer_name	string	The fully qualified host name of the managed node.
ip_address	string	The public IPv4 address assigned to the node. If a public IPv4 address isn't assigned to the node, this value is blank.
iam_role	string	The IAM role used in the hybrid activation to register the node with Systems Manager.
instance_id	string	The ID of the managed node. (pattern: <code>(^i-(\w{8}|\w{17})$)|(^mi-\w{17}$)</code>)
instance_role	string	The instance profile attached to the node. If an instance profile isn't attached to the node, this value is blank.
instance_state	string	The current state of the node.
instance_type	string	The instance type of the managed node. For example, t3.large.
key_name	string	The name of the key pair associated with the node. If a key pair isnt't associated with the node, this value is blank.
last_association_execution_date	string (date-time)	The date the association was last run.
last_ping_date_time	string (date-time)	The date and time when the SSM Agent last pinged the Systems Manager service.
last_successful_association_execution_date	string (date-time)	The last date the association was successfully run.
launch_time	string (date-time)	The timestamp for when the node was launched.
name	string	The value of the EC2 Name tag associated with the node. If a Name tag hasn't been applied to the node, this value is blank.
ping_status	string	Connection status of the SSM Agent on the managed node. (Online, ConnectionLost, Inactive)
platform_name	string	The name of the operating system platform running on your managed node.
platform_type	string	The operating system platform type of the managed node. For example, Windows Server or Amazon Linux 2. (Windows, Linux, MacOS)
platform_version	string	The version of the OS platform running on your managed node.
registration_date	string (date-time)	The date the node was registered with Systems Manager.
resource_type	string	The type of managed node.
source_id	string	The ID of the source resource. (pattern: <code>^[a-zA-Z0-9:_-]*$</code>)
source_location	string	The location of the source resource in the third-party cloud environment. (pattern: <code>^.{1,128}$</code>)
source_type	string	The type of the source resource. Valid values: AWS::EC2::Instance | AWS::SSM::ManagedInstance | AWS::IoT::Thing | Microsoft.Compute/virtualMachines. (AWS::EC2::Instance, AWS::IoT::Thing, AWS::SSM::ManagedInstance, Microsoft.Compute/virtualMachines)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_instance_properties	select	region		An API operation used by the Systems Manager console to display information about Systems Manager managed nodes.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_instance_properties

An API operation used by the Systems Manager console to display information about Systems Manager managed nodes.

SELECT
activation_id,
agent_version,
architecture,
association_overview,
association_status,
availability_zone,
computer_name,
ip_address,
iam_role,
instance_id,
instance_role,
instance_state,
instance_type,
key_name,
last_association_execution_date,
last_ping_date_time,
last_successful_association_execution_date,
launch_time,
name,
ping_status,
platform_name,
platform_type,
platform_version,
registration_date,
resource_type,
source_id,
source_location,
source_type
FROM aws.ssm.instance_properties
WHERE region = '{{ region }}' -- required
;