com.amazonaws.services.simplesystemsmanagement.model

Class StartSessionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.simplesystemsmanagement.model.StartSessionRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StartSessionRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
StartSessionRequest()

Method Summary

Modifier and Type	Method and Description
StartSessionRequest	addParametersEntry(String key, List<String> value) Add a single Parameters entry
StartSessionRequest	clearParametersEntries() Removes all the entries added into Parameters.
StartSessionRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getDocumentName() The name of the SSM document you want to use to define the type of session, input parameters, or preferences for the session.
Map<String,List<String>>	getParameters() The values you want to specify for the parameters defined in the Session document.
String	getReason() The reason for connecting to the instance.
String	getTarget() The managed node to connect to for the session.
int	hashCode()
void	setDocumentName(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.
void	setParameters(Map<String,List<String>> parameters) The values you want to specify for the parameters defined in the Session document.
void	setReason(String reason) The reason for connecting to the instance.
void	setTarget(String target) The managed node to connect to for the session.
String	toString() Returns a string representation of this object.
StartSessionRequest	withDocumentName(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	withParameters(Map<String,List<String>> parameters) The values you want to specify for the parameters defined in the Session document.
StartSessionRequest	withReason(String reason) The reason for connecting to the instance.
StartSessionRequest	withTarget(String target) The managed node to connect to for the session.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StartSessionRequest

public StartSessionRequest()

Method Detail

setTarget

public void setTarget(String target)

The managed node to connect to for the session.

Parameters:

target - The managed node to connect to for the session.

getTarget

public String getTarget()

The managed node to connect to for the session.

Returns:

The managed node to connect to for the session.

withTarget

public StartSessionRequest withTarget(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.

setDocumentName

public void setDocumentName(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.

getDocumentName

public String getDocumentName()

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.

withDocumentName

public StartSessionRequest withDocumentName(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.

setReason

public void setReason(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.

getReason

public String getReason()

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.

withReason

public StartSessionRequest withReason(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.

getParameters

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

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

Returns:

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

setParameters

public void setParameters(Map<String,List<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.

withParameters

public StartSessionRequest withParameters(Map<String,List<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.

addParametersEntry

public StartSessionRequest addParametersEntry(String key,
                                              List<String> value)

Add a single Parameters entry

See Also:

withParameters(java.util.Map<java.lang.String, java.util.List<java.lang.String>>)

clearParametersEntries

public StartSessionRequest clearParametersEntries()

Removes all the entries added into Parameters.

Returns:

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

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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public StartSessionRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()