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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#document_name ⇒ 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*.

[1]: docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-sessions-start.html

Returns:

  • (String) 


18327
18328
18329
18330
18331
18332
18333
18334
 
# File 'lib/aws-sdk-ssm/types.rb', line 18327

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

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

The values you want to specify for the parameters defined in the Session document. For more information about these parameters, see

Create a Session Manager preferences document][1

in the *Amazon

Web Services Systems Manager User Guide*.

[1]: docs.aws.amazon.com/systems-manager/latest/userguide/getting-started-create-preferences-cli.html

Returns:

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


18327
18328
18329
18330
18331
18332
18333
18334
 
# File 'lib/aws-sdk-ssm/types.rb', line 18327

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

#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.

Returns:

  • (String) 


18327
18328
18329
18330
18331
18332
18333
18334
 
# File 'lib/aws-sdk-ssm/types.rb', line 18327

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

#target ⇒ String

The managed node to connect to for the session.

Returns:

  • (String) 


18327
18328
18329
18330
18331
18332
18333
18334
 
# File 'lib/aws-sdk-ssm/types.rb', line 18327

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