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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ssm/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"],
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#document_nameString

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)


14569
14570
14571
14572
14573
14574
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 14569

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

#parametersHash<String,Array<String>>

Reserved for future use.

Returns:

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


14569
14570
14571
14572
14573
14574
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 14569

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

#targetString

The instance to connect to for the session.

Returns:

  • (String)


14569
14570
14571
14572
14573
14574
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 14569

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