software.amazon.awssdk.services.ssm.model

Class StartSessionRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ssm.model.SsmRequest

software.amazon.awssdk.services.ssm.model.StartSessionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartSessionRequest.Builder,StartSessionRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class StartSessionRequest
extends SsmRequest
implements ToCopyableBuilder<StartSessionRequest.Builder,StartSessionRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StartSessionRequest.Builder

Method Summary

Modifier and Type	Method and Description
static StartSessionRequest.Builder	builder()
String	documentName() The name of the SSM document to define the parameters and plugin settings for the session.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasParameters() Returns true if the Parameters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
Map<String,List<String>>	parameters() Reserved for future use.
List<SdkField<?>>	sdkFields()
static Class<? extends StartSessionRequest.Builder>	serializableBuilderClass()
String	target() The instance to connect to for the session.
StartSessionRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

target

public String target()

The instance to connect to for the session.

Returns:

The instance to connect to for the session.

documentName

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

Returns:

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.

hasParameters

public boolean hasParameters()

Returns true if the Parameters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

parameters

public Map<String,List<String>> parameters()

Reserved for future use.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasParameters() to see if a value was sent in this field.

Returns:

Reserved for future use.

toBuilder

public StartSessionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartSessionRequest.Builder,StartSessionRequest>

Specified by:

toBuilder in class SsmRequest

builder

public static StartSessionRequest.Builder builder()

serializableBuilderClass

public static Class<? extends StartSessionRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo