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

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-ssm/types.rb

Overview

Note:

When making an API call, you may pass StartSessionRequest data as a 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`. If no document name is provided, a shell to the instance is launched by default.

Returns:

  • (String) 


15142
15143
15144
15145
15146
15147
 
# File 'lib/aws-sdk-ssm/types.rb', line 15142

class StartSessionRequest < Struct.new(
  :target,
  :document_name,
  :parameters)
  include Aws::Structure
end

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

Reserved for future use.

Returns:

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


15142
15143
15144
15145
15146
15147
 
# File 'lib/aws-sdk-ssm/types.rb', line 15142

class StartSessionRequest < Struct.new(
  :target,
  :document_name,
  :parameters)
  include Aws::Structure
end

#target ⇒ String

The instance to connect to for the session.

Returns:

  • (String) 


15142
15143
15144
15145
15146
15147
 
# File 'lib/aws-sdk-ssm/types.rb', line 15142

class StartSessionRequest < Struct.new(
  :target,
  :document_name,
  :parameters)
  include Aws::Structure
end