ssm/aws.sdk.kotlin.services.ssm.model/StartSessionRequest

StartSessionRequest

class StartSessionRequest

Types

Builder

class Builder

Companion

object Companion

Properties

documentName

val documentName: String?

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

val parameters: Map<String, List<String>>?

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

reason

val reason: String?

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.

target

val target: String?

The managed node to connect to for the session.

Functions

copy

inline fun copy(block: StartSessionRequest.Builder.() -> Unit = {}): StartSessionRequest

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String