Class InstanceInfo

java.lang.Object
software.amazon.awssdk.services.ssm.model.InstanceInfo
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<InstanceInfo.Builder,InstanceInfo>
@Generated("software.amazon.awssdk:codegen") public final class InstanceInfo extends Object implements SdkPojo, Serializable, ToCopyableBuilder<InstanceInfo.Builder,InstanceInfo>

Details about a specific managed node.

See Also:

  • Method Details

    • agentType

      public final String agentType()

      The type of agent installed on the node.

      Returns:
      The type of agent installed on the node.

    • agentVersion

      public final String agentVersion()

      The version number of the agent installed on the node.

      Returns:
      The version number of the agent installed on the 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.

    • instanceStatus

      public final String instanceStatus()

      The current status of the managed node.

      Returns:
      The current status of the managed node.

    • ipAddress

      public final String ipAddress()

      The IP address of the managed node.

      Returns:
      The IP address of the managed node.

    • managedStatus

      public final ManagedStatus managedStatus()

      Indicates whether the node is managed by Systems Manager.

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

      Returns:
      Indicates whether the node is managed by Systems Manager.
      See Also:

    • managedStatusAsString

      public final String managedStatusAsString()

      Indicates whether the node is managed by Systems Manager.

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

      Returns:
      Indicates whether the node is managed by Systems Manager.
      See Also:

    • name

      public final String name()

      The name assigned to the managed node.

      Returns:
      The name assigned to the managed node.

    • platformType

      public final PlatformType platformType()

      The operating system platform type of the managed node.

      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 of the managed node.
      See Also:

    • platformTypeAsString

      public final String platformTypeAsString()

      The operating system platform type of the managed node.

      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 of the managed node.
      See Also:

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

    • resourceType

      public final ResourceType resourceType()

      The type of instance, either an EC2 instance or another supported machine type in a hybrid fleet.

      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, either an EC2 instance or another supported machine type in a hybrid fleet.
      See Also:

    • resourceTypeAsString

      public final String resourceTypeAsString()

      The type of instance, either an EC2 instance or another supported machine type in a hybrid fleet.

      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, either an EC2 instance or another supported machine type in a hybrid fleet.
      See Also:

    • 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:

    • 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:

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

    • sourceLocation

      public final String sourceLocation()

      The location of the source resource in the third-party cloud environment.

      Returns:
      The location of the source resource in the third-party cloud environment.

    • availabilityZone

      public final String availabilityZone()

      The Availability Zone where the managed node is located.

      Returns:
      The Availability Zone where the managed node is located.

    • availabilityZoneId

      public final String availabilityZoneId()

      The Availability Zone ID where the managed node is located.

      Returns:
      The Availability Zone ID where the managed node is located.

    • toBuilder

      public InstanceInfo.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<InstanceInfo.Builder,InstanceInfo>
      Returns:
      a builder for type T

    • builder

      public static InstanceInfo.Builder builder()

    • serializableBuilderClass

      public static Class<? extends InstanceInfo.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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.