You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::SSM::Types::StartSessionRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing StartSessionRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  target: "SessionTarget", # required
  document_name: "DocumentARN",
  parameters: {
    "SessionManagerParameterName" => ["SessionManagerParameterValue"],
  },
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#document_name ⇒ String

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:

  • (String) —

    The name of the SSM document to define the parameters and plugin settings for the session.

#parameters ⇒ Hash<String,Array<String>>

Reserved for future use.

Returns:

  • (Hash<String,Array<String>>) —

    Reserved for future use.

#target ⇒ String

The instance to connect to for the session.

Returns:

  • (String) —

    The instance to connect to for the session.