software.amazon.awssdk.services.ssm.model

Interface StartSessionRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<StartSessionRequest.Builder,StartSessionRequest>, SdkBuilder<StartSessionRequest.Builder,StartSessionRequest>, SdkPojo, SdkRequest.Builder, SsmRequest.Builder

Enclosing class:

StartSessionRequest

public static interface StartSessionRequest.Builder
extends SsmRequest.Builder, SdkPojo, CopyableBuilder<StartSessionRequest.Builder,StartSessionRequest>

Method Summary

Modifier and Type	Method and Description
StartSessionRequest.Builder	documentName(String documentName) The name of the SSM document to define the parameters and plugin settings for the session.
StartSessionRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
StartSessionRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
StartSessionRequest.Builder	parameters(Map<String,? extends Collection<String>> parameters) Reserved for future use.
StartSessionRequest.Builder	reason(String reason) The reason for connecting to the instance.
StartSessionRequest.Builder	target(String target) The instance to connect to for the session.

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

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

target

StartSessionRequest.Builder target(String target)

The instance to connect to for the session.

Parameters:

target - The instance to connect to for the session.

Returns:

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

documentName

StartSessionRequest.Builder documentName(String documentName)

The name of the SSM document to define the parameters and plugin settings for the session. For example, SSM-SessionManagerRunShell. You can call the GetDocument API to verify the document exists before attempting to start a session. If no document name is provided, a shell to the instance is launched by default.

Parameters:

documentName - The name of the SSM document to define the parameters and plugin settings for the session. For example, SSM-SessionManagerRunShell. You can call the GetDocument API to verify the document exists before attempting to start a session. If no document name is provided, a shell to the instance is launched by default.

Returns:

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

reason

StartSessionRequest.Builder reason(String reason)

The reason for connecting to the instance. This value is included in the details for the Amazon CloudWatch Events event created when you start the session.

Parameters:

reason - The reason for connecting to the instance. This value is included in the details for the Amazon CloudWatch Events event created when you start the session.

Returns:

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

parameters

StartSessionRequest.Builder parameters(Map<String,? extends Collection<String>> parameters)

Reserved for future use.

Parameters:

parameters - Reserved for future use.

Returns:

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

overrideConfiguration

StartSessionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

StartSessionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder