software.amazon.awssdk.services.ssm.model

Interface StartSessionResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<StartSessionResponse.Builder,StartSessionResponse>, SdkBuilder<StartSessionResponse.Builder,StartSessionResponse>, SdkPojo, SdkResponse.Builder, SsmResponse.Builder

Enclosing class:

StartSessionResponse

public static interface StartSessionResponse.Builder
extends SsmResponse.Builder, SdkPojo, CopyableBuilder<StartSessionResponse.Builder,StartSessionResponse>

Method Summary

Modifier and Type	Method and Description
StartSessionResponse.Builder	sessionId(String sessionId) The ID of the session.
StartSessionResponse.Builder	streamUrl(String streamUrl) A URL back to SSM Agent on the managed node that the Session Manager client uses to send commands and receive output from the node.
StartSessionResponse.Builder	tokenValue(String tokenValue) An encrypted token value containing session and caller information.

Methods inherited from interface software.amazon.awssdk.services.ssm.model.SsmResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

sessionId

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

tokenValue

StartSessionResponse.Builder tokenValue(String tokenValue)

An encrypted token value containing session and caller information. This token is used to authenticate the connection to the managed node, and is valid only long enough to ensure the connection is successful. Never share your session's token.

Parameters:

tokenValue - An encrypted token value containing session and caller information. This token is used to authenticate the connection to the managed node, and is valid only long enough to ensure the connection is successful. Never share your session's token.

Returns:

Returns a reference to this object so that method calls can be chained together.

streamUrl

StartSessionResponse.Builder streamUrl(String streamUrl)

A URL back to SSM Agent on the managed node that the Session Manager client uses to send commands and receive output from the node. Format: wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output)

region represents the Region identifier for an Amazon Web Services Region supported by Amazon Web Services Systems Manager, such as us-east-2 for the US East (Ohio) Region. For a list of supported region values, see the Region column in Systems Manager service endpoints in the Amazon Web Services General Reference.

session-id represents the ID of a Session Manager session, such as 1a2b3c4dEXAMPLE.

Parameters:

streamUrl - A URL back to SSM Agent on the managed node that the Session Manager client uses to send commands and receive output from the node. Format: wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output)

region represents the Region identifier for an Amazon Web Services Region supported by Amazon Web Services Systems Manager, such as us-east-2 for the US East (Ohio) Region. For a list of supported region values, see the Region column in Systems Manager service endpoints in the Amazon Web Services General Reference.

session-id represents the ID of a Session Manager session, such as 1a2b3c4dEXAMPLE.

Returns:

Returns a reference to this object so that method calls can be chained together.