Class InstanceProperty

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

An object containing various properties of a managed node.

See Also:

  • Method Details

    • name

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

      Returns:
      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.

    • instanceId

      public final String instanceId()

      The ID of the managed node.

      Returns:
      The ID of the managed node.

    • instanceType

      public final String instanceType()

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

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

    • instanceRole

      public final String instanceRole()

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

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

    • keyName

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

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

    • instanceState

      public final String instanceState()

      The current state of the node.

      Returns:
      The current state of the node.

    • architecture

      public final String architecture()

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

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

    • ipAddress

      public final String ipAddress()

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

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

    • launchTime

      public final Instant launchTime()

      The timestamp for when the node was launched.

      Returns:
      The timestamp for when the node was launched.

    • pingStatus

      public final PingStatus pingStatus()

      Connection status of the SSM Agent on the managed node.

      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 the SSM Agent on the managed node.
      See Also:

    • pingStatusAsString

      public final String pingStatusAsString()

      Connection status of the SSM Agent on the managed node.

      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 the SSM Agent on the managed node.
      See Also:

    • lastPingDateTime

      public final Instant lastPingDateTime()

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

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

    • agentVersion

      public final String agentVersion()

      The version of SSM Agent running on your managed node.

      Returns:
      The version of SSM Agent running on your managed node.

    • platformType

      public final PlatformType platformType()

      The operating system platform type of the managed node. For example, Windows Server or Amazon Linux 2.

      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. For example, Windows Server or Amazon Linux 2.
      See Also:

    • platformTypeAsString

      public final String platformTypeAsString()

      The operating system platform type of the managed node. For example, Windows Server or Amazon Linux 2.

      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. For example, Windows Server or Amazon Linux 2.
      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.

    • activationId

      public final String activationId()

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

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

    • iamRole

      public final String iamRole()

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

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

    • registrationDate

      public final Instant registrationDate()

      The date the node was registered with Systems Manager.

      Returns:
      The date the node was registered with Systems Manager.

    • resourceType

      public final String resourceType()

      The type of managed node.

      Returns:
      The type of 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 State Manager association applied to the managed node.

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

    • 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()
      Returns the value of the AssociationOverview property for this object.
      Returns:
      The value of the AssociationOverview property for this object.

    • sourceId

      public final String sourceId()

      The ID of the source resource.

      Returns:
      The ID of the source resource.

    • sourceType

      public final SourceType sourceType()

      The type of the source resource.

      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.
      See Also:

    • sourceTypeAsString

      public final String sourceTypeAsString()

      The type of the source resource.

      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.
      See Also:

    • toBuilder

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

    • builder

      public static InstanceProperty.Builder builder()

    • serializableBuilderClass

      public static Class<? extends InstanceProperty.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.