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"],
  },
}

Constant Summary collapse

SENSITIVE =
[]

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`. 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)

18797
18798
18799
18800
18801
18802
18803
# File 'lib/aws-sdk-ssm/types.rb', line 18797

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

#parametersHash<String,Array<String>>

Reserved for future use.

Returns:

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

18797
18798
18799
18800
18801
18802
18803
# File 'lib/aws-sdk-ssm/types.rb', line 18797

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

#targetString

The instance to connect to for the session.

Returns:

  • (String)

18797
18798
18799
18800
18801
18802
18803
# File 'lib/aws-sdk-ssm/types.rb', line 18797

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