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 instances.

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 Systems Manager when the server or VM was registered.
String	agentVersion() The version of SSM Agent running on your Linux instance.
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 instance.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	iamRole() The Amazon Identity and Access Management (IAM) role assigned to the on-premises Systems Manager managed instances.
String	instanceId() The instance ID.
String	ipAddress() The IP address of the managed instance.
Boolean	isLatestVersion() Indicates whether latest version of SSM Agent is running on your instance.
Instant	lastAssociationExecutionDate() The date the association was last executed.
Instant	lastPingDateTime() The date and time when agent last pinged Systems Manager service.
Instant	lastSuccessfulAssociationExecutionDate() The last date the association was successfully run.
String	name() The name of the managed instance.
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 instance.
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 instance.
Instant	registrationDate() The date the server or VM was registered with AWS as a managed instance.
ResourceType	resourceType() The type of instance.
String	resourceTypeAsString() The type of instance.
List<SdkField<?>>	sdkFields()
static Class<? extends InstanceInformation.Builder>	serializableBuilderClass()
InstanceInformation.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

instanceId

public String instanceId()

The instance ID.

Returns:

The instance ID.

pingStatus

public PingStatus pingStatus()

Connection status of SSM Agent.

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.

See Also:

PingStatus

pingStatusAsString

public String pingStatusAsString()

Connection status of SSM Agent.

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.

See Also:

PingStatus

lastPingDateTime

public Instant lastPingDateTime()

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

Returns:

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

agentVersion

public String agentVersion()

The version of SSM Agent running on your Linux instance.

Returns:

The version of SSM Agent running on your Linux instance.

isLatestVersion

public Boolean isLatestVersion()

Indicates whether latest version of SSM Agent is running on your instance. Some older versions of Windows Server use the EC2Config service to process SSM requests. For this reason, this field does not indicate whether or not the latest version is installed on Windows managed instances.

Returns:

Indicates whether latest version of SSM Agent is running on your instance. Some older versions of Windows Server use the EC2Config service to process SSM requests. For this reason, this field does not indicate whether or not the latest version is installed on Windows managed instances.

platformType

public 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 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 String platformName()

The name of the operating system platform running on your instance.

Returns:

The name of the operating system platform running on your instance.

platformVersion

public String platformVersion()

The version of the OS platform running on your instance.

Returns:

The version of the OS platform running on your instance.

activationId

public String activationId()

The activation ID created by Systems Manager when the server or VM was registered.

Returns:

The activation ID created by Systems Manager when the server or VM was registered.

iamRole

public String iamRole()

The Amazon Identity and Access Management (IAM) role assigned to the on-premises Systems Manager managed instances. This call does not return the IAM role for Amazon EC2 instances.

Returns:

The Amazon Identity and Access Management (IAM) role assigned to the on-premises Systems Manager managed instances. This call does not return the IAM role for Amazon EC2 instances.

registrationDate

public Instant registrationDate()

The date the server or VM was registered with AWS as a managed instance.

Returns:

The date the server or VM was registered with AWS as a managed instance.

resourceType

public 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 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 String name()

The name of the managed instance.

Returns:

The name of the managed instance.

ipAddress

public String ipAddress()

The IP address of the managed instance.

Returns:

The IP address of the managed instance.

computerName

public String computerName()

The fully qualified host name of the managed instance.

Returns:

The fully qualified host name of the managed instance.

associationStatus

public String associationStatus()

The status of the association.

Returns:

The status of the association.

lastAssociationExecutionDate

public Instant lastAssociationExecutionDate()

The date the association was last executed.

Returns:

The date the association was last executed.

lastSuccessfulAssociationExecutionDate

public Instant lastSuccessfulAssociationExecutionDate()

The last date the association was successfully run.

Returns:

The last date the association was successfully run.

associationOverview

public InstanceAggregatedAssociationOverview associationOverview()

Information about the association.

Returns:

Information about the association.

toBuilder

public InstanceInformation.Builder 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 interface ToCopyableBuilder<InstanceInformation.Builder,InstanceInformation>

Returns:

a builder for type T

builder

public static InstanceInformation.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.