Package 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("software.amazon.awssdk:codegen")
public final class StartSessionRequest
extends SsmRequest
implements ToCopyableBuilder<StartSessionRequest.Builder,StartSessionRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StartSessionRequest.Builder

Method Summary

Modifier and Type	Method	Description
static StartSessionRequest.Builder	builder()
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.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasParameters()	For responses, this returns true if the service returned a value for the Parameters property.
Map<String,List<String>>	parameters()	The values you want to specify for the parameters defined in the Session document.
String	reason()	The reason for connecting to the instance.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends StartSessionRequest.Builder>	serializableBuilderClass()
String	target()	The managed node 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 final String target()

The managed node to connect to for the session.

Returns:

The managed node to connect to for the session.

documentName

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

Returns:

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.

reason

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

Returns:

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.

hasParameters

public final boolean hasParameters()

For responses, this returns true if the service returned a value for the Parameters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

parameters

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

The values you want to specify for the parameters defined in the Session document.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasParameters() method.

Returns:

The values you want to specify for the parameters defined in the Session document.

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 final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

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

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo