Package software.amazon.awssdk.services.ssm.model

Interface Session.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Session.Builder,Session>, SdkBuilder<Session.Builder,Session>, SdkPojo
Enclosing class:
Session
public static interface Session.Builder extends SdkPojo, CopyableBuilder<Session.Builder,Session>

  • Method Details

    • sessionId

      Session.Builder sessionId(String sessionId)

      The ID of the session.

      Parameters:
      sessionId - The ID of the session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • target

      Session.Builder target(String target)

      The managed node that the Session Manager session connected to.

      Parameters:
      target - The managed node that the Session Manager session connected to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      Session.Builder status(String status)

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

      Parameters:
      status - The status of the session. For example, "Connected" or "Terminated".
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      Session.Builder status(SessionStatus status)

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

      Parameters:
      status - The status of the session. For example, "Connected" or "Terminated".
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • startDate

      Session.Builder startDate(Instant startDate)

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

      Parameters:
      startDate - The date and time, in ISO-8601 Extended format, when the session began.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endDate

      Session.Builder endDate(Instant endDate)

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

      Parameters:
      endDate - The date and time, in ISO-8601 Extended format, when the session was terminated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • documentName

      Session.Builder documentName(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • owner

      Session.Builder owner(String owner)

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

      Parameters:
      owner - The ID of the Amazon Web Services user that started the session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • reason

      Session.Builder reason(String reason)

      The reason for connecting to the instance.

      Parameters:
      reason - The reason for connecting to the instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • details

      Session.Builder details(String details)

      Reserved for future use.

      Parameters:
      details - Reserved for future use.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outputUrl

      Session.Builder outputUrl(SessionManagerOutputUrl outputUrl)

      Reserved for future use.

      Parameters:
      outputUrl - Reserved for future use.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outputUrl

      default Session.Builder outputUrl(Consumer<SessionManagerOutputUrl.Builder> outputUrl)

      Reserved for future use.

      This is a convenience method that creates an instance of the SessionManagerOutputUrl.Builder avoiding the need to create one manually via SessionManagerOutputUrl.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to outputUrl(SessionManagerOutputUrl).

      Parameters:
      outputUrl - a consumer that will call methods on SessionManagerOutputUrl.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • maxSessionDuration

      Session.Builder maxSessionDuration(String maxSessionDuration)

      The maximum duration of a session before it terminates.

      Parameters:
      maxSessionDuration - The maximum duration of a session before it terminates.
      Returns:
      Returns a reference to this object so that method calls can be chained together.