InstanceProperty - Amazon Systems Manager
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

InstanceProperty

An object containing various properties of a managed node.

Contents

ActivationId

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

Type: String

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Required: No

AgentVersion

The version of SSM Agent running on your managed node.

Type: String

Pattern: ^[0-9]{1,6}(\.[0-9]{1,6}){2,3}$

Required: No

Architecture

The CPU architecture of the node. For example, x86_64.

Type: String

Length Constraints: Maximum length of 120.

Required: No

AssociationOverview

Status information about the aggregated associations.

Type: InstanceAggregatedAssociationOverview object

Required: No

AssociationStatus

The status of the State Manager association applied to the managed node.

Type: String

Required: No

ComputerName

The fully qualified host name of the managed node.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: No

IamRole

The IAM role used in the hybrid activation to register the node with Systems Manager.

Type: String

Length Constraints: Maximum length of 64.

Required: No

InstanceId

The ID of the managed node.

Type: String

Pattern: (^i-(\w{8}|\w{17})$)|(^mi-\w{17}$)

Required: No

InstanceRole

The instance profile attached to the node. If an instance profile isn't attached to the node, this value is blank.

Type: String

Length Constraints: Maximum length of 120.

Required: No

InstanceState

The current state of the node.

Type: String

Length Constraints: Maximum length of 120.

Required: No

InstanceType

The instance type of the managed node. For example, t3.large.

Type: String

Length Constraints: Maximum length of 120.

Required: No

IPAddress

The public IPv4 address assigned to the node. If a public IPv4 address isn't assigned to the node, this value is blank.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 46.

Required: No

KeyName

The name of the key pair associated with the node. If a key pair isnt't associated with the node, this value is blank.

Type: String

Length Constraints: Maximum length of 255.

Required: No

LastAssociationExecutionDate

The date the association was last run.

Type: Timestamp

Required: No

LastPingDateTime

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

Type: Timestamp

Required: No

LastSuccessfulAssociationExecutionDate

The last date the association was successfully run.

Type: Timestamp

Required: No

LaunchTime

The timestamp for when the node was launched.

Type: Timestamp

Required: No

Name

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.

Type: String

Length Constraints: Maximum length of 255.

Required: No

PingStatus

Connection status of the SSM Agent on the managed node.

Type: String

Valid Values: Online | ConnectionLost | Inactive

Required: No

PlatformName

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

Type: String

Length Constraints: Maximum length of 120.

Required: No

PlatformType

The operating system platform type of the managed node. For example, Windows.

Type: String

Valid Values: Windows | Linux | MacOS

Required: No

PlatformVersion

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

Type: String

Length Constraints: Maximum length of 120.

Required: No

RegistrationDate

The date the node was registered with Systems Manager.

Type: Timestamp

Required: No

ResourceType

The type of managed node.

Type: String

Required: No

SourceId

The ID of the source resource.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 128.

Pattern: ^[a-zA-Z0-9:_-]*$

Required: No

SourceType

The type of the source resource.

Type: String

Valid Values: AWS::EC2::Instance | AWS::IoT::Thing | AWS::SSM::ManagedInstance

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: