Class Session

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

Information about a Session Manager connection to a managed node.

See Also:

  • Method Details

    • sessionId

      public final String sessionId()

      The ID of the session.

      Returns:
      The ID of the session.

    • target

      public final String target()

      The managed node that the Session Manager session connected to.

      Returns:
      The managed node that the Session Manager session connected to.

    • status

      public final SessionStatus status()

      The status of the session. For example, "Connected" or "Terminated".

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

      Returns:
      The status of the session. For example, "Connected" or "Terminated".
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the session. For example, "Connected" or "Terminated".

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

      Returns:
      The status of the session. For example, "Connected" or "Terminated".
      See Also:

    • startDate

      public final Instant startDate()

      The date and time, in ISO-8601 Extended format, when the session began.

      Returns:
      The date and time, in ISO-8601 Extended format, when the session began.

    • endDate

      public final Instant endDate()

      The date and time, in ISO-8601 Extended format, when the session was terminated.

      Returns:
      The date and time, in ISO-8601 Extended format, when the session was terminated.

    • documentName

      public final String documentName()

      The name of the Session Manager SSM document used to define the parameters and plugin settings for the session. For example, SSM-SessionManagerRunShell.

      Returns:
      The name of the Session Manager SSM document used to define the parameters and plugin settings for the session. For example, SSM-SessionManagerRunShell.

    • owner

      public final String owner()

      The ID of the Amazon Web Services user that started the session.

      Returns:
      The ID of the Amazon Web Services user that started the session.

    • reason

      public final String reason()

      The reason for connecting to the instance.

      Returns:
      The reason for connecting to the instance.

    • details

      public final String details()

      Reserved for future use.

      Returns:
      Reserved for future use.

    • outputUrl

      public final SessionManagerOutputUrl outputUrl()

      Reserved for future use.

      Returns:
      Reserved for future use.

    • maxSessionDuration

      public final String maxSessionDuration()

      The maximum duration of a session before it terminates.

      Returns:
      The maximum duration of a session before it terminates.

    • accessType

      public final AccessType accessType()

      Standard access type is the default for Session Manager sessions. JustInTime is the access type for Just-in-time node access.

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

      Returns:
      Standard access type is the default for Session Manager sessions. JustInTime is the access type for Just-in-time node access.
      See Also:

    • accessTypeAsString

      public final String accessTypeAsString()

      Standard access type is the default for Session Manager sessions. JustInTime is the access type for Just-in-time node access.

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

      Returns:
      Standard access type is the default for Session Manager sessions. JustInTime is the access type for Just-in-time node access.
      See Also:

    • toBuilder

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

    • builder

      public static Session.Builder builder()

    • serializableBuilderClass

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