Class InstanceInformation
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<InstanceInformation.Builder,
InstanceInformation>
Describes a filter for a specific list of managed nodes.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The activation ID created by Amazon Web Services Systems Manager when the server or virtual machine (VM) was registered.final String
The version of SSM Agent running on your Linux managed node.Information about the association.final String
The status of the association.static InstanceInformation.Builder
builder()
final String
The fully qualified host name of the managed node.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
iamRole()
The Identity and Access Management (IAM) role assigned to the on-premises Systems Manager managed node.final String
The managed node ID.final String
The IP address of the managed node.final Boolean
Indicates whether the latest version of SSM Agent is running on your Linux managed node.final Instant
The date the association was last run.final Instant
The date and time when the agent last pinged the Systems Manager service.final Instant
The last date the association was successfully run.final String
name()
The name assigned to an on-premises server, edge device, or virtual machine (VM) when it is activated as a Systems Manager managed node.final PingStatus
Connection status of SSM Agent.final String
Connection status of SSM Agent.final String
The name of the operating system platform running on your managed node.final PlatformType
The operating system platform type.final String
The operating system platform type.final String
The version of the OS platform running on your managed node.final Instant
The date the server or VM was registered with Amazon Web Services as a managed node.final ResourceType
The type of instance.final String
The type of instance.static Class
<? extends InstanceInformation.Builder> final String
sourceId()
The ID of the source resource.final SourceType
The type of the source resource.final String
The type of the source resource.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
instanceId
The managed node ID.
- Returns:
- The managed node ID.
-
pingStatus
Connection status of SSM Agent.
The status
Inactive
has been deprecated and is no longer in use.If the service returns an enum value that is not available in the current SDK version,
pingStatus
will returnPingStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompingStatusAsString()
.- Returns:
- Connection status of SSM Agent.
The status
Inactive
has been deprecated and is no longer in use. - See Also:
-
pingStatusAsString
Connection status of SSM Agent.
The status
Inactive
has been deprecated and is no longer in use.If the service returns an enum value that is not available in the current SDK version,
pingStatus
will returnPingStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompingStatusAsString()
.- Returns:
- Connection status of SSM Agent.
The status
Inactive
has been deprecated and is no longer in use. - See Also:
-
lastPingDateTime
The date and time when the agent last pinged the Systems Manager service.
- Returns:
- The date and time when the agent last pinged the Systems Manager service.
-
agentVersion
The version of SSM Agent running on your Linux managed node.
- Returns:
- The version of SSM Agent running on your Linux managed node.
-
isLatestVersion
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.
- Returns:
- 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.
-
platformType
The operating system platform type.
If the service returns an enum value that is not available in the current SDK version,
platformType
will returnPlatformType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromplatformTypeAsString()
.- Returns:
- The operating system platform type.
- See Also:
-
platformTypeAsString
The operating system platform type.
If the service returns an enum value that is not available in the current SDK version,
platformType
will returnPlatformType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromplatformTypeAsString()
.- Returns:
- The operating system platform type.
- See Also:
-
platformName
The name of the operating system platform running on your managed node.
- Returns:
- The name of the operating system platform running on your managed node.
-
platformVersion
The version of the OS platform running on your managed node.
- Returns:
- The version of the OS platform running on your managed node.
-
activationId
The activation ID created by Amazon Web Services Systems Manager when the server or virtual machine (VM) was registered.
- Returns:
- The activation ID created by Amazon Web Services Systems Manager when the server or virtual machine (VM) was registered.
-
iamRole
The Identity and Access Management (IAM) role assigned to the on-premises Systems Manager managed node. This call doesn't return the IAM role for Amazon Elastic Compute Cloud (Amazon EC2) instances. To retrieve the IAM role for 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.- Returns:
- The Identity and Access Management (IAM) role assigned to the on-premises Systems Manager managed node.
This call doesn't return the IAM role for Amazon Elastic Compute Cloud (Amazon EC2) instances. To
retrieve the IAM role for 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.
-
registrationDate
The date the server or VM was registered with Amazon Web Services as a managed node.
- Returns:
- The date the server or VM was registered with Amazon Web Services as a managed node.
-
resourceType
The type of instance. Instances are either EC2 instances or managed instances.
If the service returns an enum value that is not available in the current SDK version,
resourceType
will returnResourceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromresourceTypeAsString()
.- Returns:
- The type of instance. Instances are either EC2 instances or managed instances.
- See Also:
-
resourceTypeAsString
The type of instance. Instances are either EC2 instances or managed instances.
If the service returns an enum value that is not available in the current SDK version,
resourceType
will returnResourceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromresourceTypeAsString()
.- Returns:
- The type of instance. Instances are either EC2 instances or managed instances.
- See Also:
-
name
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 Install SSM Agent for a hybrid and multicloud environment (Linux) and Install SSM Agent for a hybrid and multicloud environment (Windows). To retrieve theName
tag of an EC2 instance, use the Amazon EC2DescribeInstances
operation. For information, see DescribeInstances in the Amazon EC2 API Reference or describe-instances in the Amazon Web Services CLI Command Reference.- Returns:
- 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 Install SSM Agent for a hybrid and multicloud environment (Linux) and Install SSM Agent for a hybrid and multicloud environment (Windows). To retrieve theName
tag of an EC2 instance, use the Amazon EC2DescribeInstances
operation. For information, see DescribeInstances in the Amazon EC2 API Reference or describe-instances in the Amazon Web Services CLI Command Reference.
-
ipAddress
The IP address of the managed node.
- Returns:
- The IP address of the managed node.
-
computerName
The fully qualified host name of the managed node.
- Returns:
- The fully qualified host name of the managed node.
-
associationStatus
The status of the association.
- Returns:
- The status of the association.
-
lastAssociationExecutionDate
The date the association was last run.
- Returns:
- The date the association was last run.
-
lastSuccessfulAssociationExecutionDate
The last date the association was successfully run.
- Returns:
- The last date the association was successfully run.
-
associationOverview
Information about the association.
- Returns:
- Information about the association.
-
sourceId
The ID of the source resource. For IoT Greengrass devices,
SourceId
is the Thing name.- Returns:
- The ID of the source resource. For IoT Greengrass devices,
SourceId
is the Thing name.
-
sourceType
The type of the source resource. For IoT Greengrass devices,
SourceType
isAWS::IoT::Thing
.If the service returns an enum value that is not available in the current SDK version,
sourceType
will returnSourceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsourceTypeAsString()
.- Returns:
- The type of the source resource. For IoT Greengrass devices,
SourceType
isAWS::IoT::Thing
. - See Also:
-
sourceTypeAsString
The type of the source resource. For IoT Greengrass devices,
SourceType
isAWS::IoT::Thing
.If the service returns an enum value that is not available in the current SDK version,
sourceType
will returnSourceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsourceTypeAsString()
.- Returns:
- The type of the source resource. For IoT Greengrass devices,
SourceType
isAWS::IoT::Thing
. - See Also:
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<InstanceInformation.Builder,
InstanceInformation> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-