software.amazon.awssdk.services.ssm.model

Class InstanceInformation

java.lang.Object

software.amazon.awssdk.services.ssm.model.InstanceInformation

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<InstanceInformation.Builder,InstanceInformation>

@Generated(value="software.amazon.awssdk:codegen")
public final class InstanceInformation
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<InstanceInformation.Builder,InstanceInformation>

Describes a filter for a specific list of managed nodes.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	InstanceInformation.Builder

Method Summary

Modifier and Type	Method and Description
String	activationId() The activation ID created by Amazon Web Services Systems Manager when the server or virtual machine (VM) was registered.
String	agentVersion() The version of SSM Agent running on your Linux managed node.
InstanceAggregatedAssociationOverview	associationOverview() Information about the association.
String	associationStatus() The status of the association.
static InstanceInformation.Builder	builder()
String	computerName() The fully qualified host name of the managed node.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	iamRole() The Identity and Access Management (IAM) role assigned to the on-premises Systems Manager managed node.
String	instanceId() The managed node ID.
String	ipAddress() The IP address of the managed node.
Boolean	isLatestVersion() Indicates whether the latest version of SSM Agent is running on your Linux managed node.
Instant	lastAssociationExecutionDate() The date the association was last run.
Instant	lastPingDateTime() The date and time when the agent last pinged the Systems Manager service.
Instant	lastSuccessfulAssociationExecutionDate() The last date the association was successfully run.
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.
PingStatus	pingStatus() Connection status of SSM Agent.
String	pingStatusAsString() Connection status of SSM Agent.
String	platformName() The name of the operating system platform running on your managed node.
PlatformType	platformType() The operating system platform type.
String	platformTypeAsString() The operating system platform type.
String	platformVersion() The version of the OS platform running on your managed node.
Instant	registrationDate() The date the server or VM was registered with Amazon Web Services as a managed node.
ResourceType	resourceType() The type of instance.
String	resourceTypeAsString() The type of instance.
List<SdkField<?>>	sdkFields()
static Class<? extends InstanceInformation.Builder>	serializableBuilderClass()
String	sourceId() The ID of the source resource.
SourceType	sourceType() The type of the source resource.
String	sourceTypeAsString() The type of the source resource.
InstanceInformation.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

instanceId

public final String instanceId()

The managed node ID.

Returns:

The managed node ID.

pingStatus

public final PingStatus 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 return PingStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from pingStatusAsString().

Returns:

Connection status of SSM Agent.

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

See Also:

PingStatus

pingStatusAsString

public final String 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 return PingStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from pingStatusAsString().

Returns:

Connection status of SSM Agent.

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

See Also:

PingStatus

lastPingDateTime

public final Instant 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

public final String 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

public final Boolean 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

public final PlatformType platformType()

The operating system platform type.

If the service returns an enum value that is not available in the current SDK version, platformType will return PlatformType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from platformTypeAsString().

Returns:

The operating system platform type.

See Also:

PlatformType

platformTypeAsString

public final String platformTypeAsString()

The operating system platform type.

If the service returns an enum value that is not available in the current SDK version, platformType will return PlatformType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from platformTypeAsString().

Returns:

The operating system platform type.

See Also:

PlatformType

platformName

public final String 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

public final String 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

public final String 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

public final String 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

public final Instant 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

public final ResourceType 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 return ResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceTypeAsString().

Returns:

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

See Also:

ResourceType

resourceTypeAsString

public final String 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 return ResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceTypeAsString().

Returns:

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

See Also:

ResourceType

name

public 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. 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 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 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 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 operation. For information, see DescribeInstances in the Amazon EC2 API Reference or describe-instances in the Amazon Web Services CLI Command Reference.

ipAddress

public final String ipAddress()

The IP address of the managed node.

Returns:

The IP address of the managed node.

computerName

public final String computerName()

The fully qualified host name of the managed node.

Returns:

The fully qualified host name of the managed node.

associationStatus

public final String associationStatus()

The status of the association.

Returns:

The status of the association.

lastAssociationExecutionDate

public final Instant lastAssociationExecutionDate()

The date the association was last run.

Returns:

The date the association was last run.

lastSuccessfulAssociationExecutionDate

public final Instant lastSuccessfulAssociationExecutionDate()

The last date the association was successfully run.

Returns:

The last date the association was successfully run.

associationOverview

public final InstanceAggregatedAssociationOverview associationOverview()

Information about the association.

Returns:

Information about the association.

sourceId

public final String 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

public final SourceType sourceType()

The type of the source resource. For IoT Greengrass devices, SourceType is AWS::IoT::Thing.

If the service returns an enum value that is not available in the current SDK version, sourceType will return SourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sourceTypeAsString().

Returns:

The type of the source resource. For IoT Greengrass devices, SourceType is AWS::IoT::Thing.

See Also:

SourceType

sourceTypeAsString

public final String sourceTypeAsString()

The type of the source resource. For IoT Greengrass devices, SourceType is AWS::IoT::Thing.

If the service returns an enum value that is not available in the current SDK version, sourceType will return SourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sourceTypeAsString().

Returns:

The type of the source resource. For IoT Greengrass devices, SourceType is AWS::IoT::Thing.

See Also:

SourceType

toBuilder

public InstanceInformation.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<InstanceInformation.Builder,InstanceInformation>

builder

public static InstanceInformation.Builder builder()

serializableBuilderClass

public static Class<? extends InstanceInformation.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String 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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo