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:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface InstanceProperty.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`activationId()`	The activation ID created by Systems Manager when the server or virtual machine (VM) was registered
`String`	`agentVersion()`	The version of SSM Agent running on your managed node.
`String`	`architecture()`	The CPU architecture of the node.
`InstanceAggregatedAssociationOverview`	`associationOverview()`	Returns the value of the AssociationOverview property for this object.
`String`	`associationStatus()`	The status of the State Manager association applied to the managed node.
`static InstanceProperty.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 IAM role used in the hybrid activation to register the node with Systems Manager.
`String`	`instanceId()`	The ID of the managed node.
`String`	`instanceRole()`	The instance profile attached to the node.
`String`	`instanceState()`	The current state of the node.
`String`	`instanceType()`	The instance type of the managed node.
`String`	`ipAddress()`	The public IPv4 address assigned to the node.
`String`	`keyName()`	The name of the key pair associated with the node.
`Instant`	`lastAssociationExecutionDate()`	The date the association was last run.
`Instant`	`lastPingDateTime()`	The date and time when the SSM Agent last pinged the Systems Manager service.
`Instant`	`lastSuccessfulAssociationExecutionDate()`	The last date the association was successfully run.
`Instant`	`launchTime()`	The timestamp for when the node was launched.
`String`	`name()`	The value of the EC2 `Name` tag associated with the node.
`PingStatus`	`pingStatus()`	Connection status of the SSM Agent on the managed node.
`String`	`pingStatusAsString()`	Connection status of the SSM Agent on the managed node.
`String`	`platformName()`	The name of the operating system platform running on your managed node.
`PlatformType`	`platformType()`	The operating system platform type of the managed node.
`String`	`platformTypeAsString()`	The operating system platform type of the managed node.
`String`	`platformVersion()`	The version of the OS platform running on your managed node.
`Instant`	`registrationDate()`	The date the node was registered with Systems Manager.
`String`	`resourceType()`	The type of managed node.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends InstanceProperty.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.
`InstanceProperty.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
  - 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:
    
    PingStatus
  - 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:
    
    PingStatus
  - 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.
    
    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.
    
    See Also:
    
    PlatformType
  - platformTypeAsString
```
public final String platformTypeAsString()
```
    The operating system platform type of the managed node. For example, Windows.
    
    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.
    
    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 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:
    
    SourceType
  - 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:
    
    SourceType
  - toBuilder
```
public InstanceProperty.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<InstanceProperty.Builder,InstanceProperty>
  - 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)
```
    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

Class InstanceProperty

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

name

instanceId

instanceType

instanceRole

keyName

instanceState

architecture

ipAddress

launchTime

pingStatus

pingStatusAsString

lastPingDateTime

agentVersion

platformType

platformTypeAsString

platformName

platformVersion

activationId

iamRole

registrationDate

resourceType

computerName

associationStatus

lastAssociationExecutionDate

lastSuccessfulAssociationExecutionDate

associationOverview

sourceId

sourceType

sourceTypeAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields