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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StartSessionRequest.Builder
documentName(String documentName)
The name of the SSM document you want to use to define the type of session, input parameters, or preferences for the session.StartSessionRequest.Builder
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
StartSessionRequest.Builder
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
StartSessionRequest.Builder
parameters(Map<String,? extends Collection<String>> parameters)
The values you want to specify for the parameters defined in the Session document.StartSessionRequest.Builder
reason(String reason)
The reason for connecting to the instance.StartSessionRequest.Builder
target(String target)
The managed node to connect to for the session.-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Methods inherited from interface software.amazon.awssdk.services.ssm.model.SsmRequest.Builder
build
-
-
-
-
Method Detail
-
target
StartSessionRequest.Builder target(String target)
The managed node to connect to for the session.
- Parameters:
target
- The managed node 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 you want to use to define the type of session, input parameters, or preferences 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 managed node is launched by default. For more information, see Start a session in the Amazon Web Services Systems Manager User Guide.- Parameters:
documentName
- The name of the SSM document you want to use to define the type of session, input parameters, or preferences 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 managed node is launched by default. For more information, see Start a session in the Amazon Web Services Systems Manager User Guide.- 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)
The values you want to specify for the parameters defined in the Session document.
- Parameters:
parameters
- The values you want to specify for the parameters defined in the Session document.- 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 interfaceAwsRequest.Builder
-
overrideConfiguration
StartSessionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
-