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

Inherits:

Struct

• Object
• Struct
• Aws::SSM::Types::StartSessionRequest

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-ssm/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

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

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

  The values you want to specify for the parameters defined in the Session document.

• #reason ⇒ String

  The reason for connecting to the instance.

• #target ⇒ String

  The managed node to connect to for the session.

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.

Returns:

• (String)

# File 'lib/aws-sdk-ssm/types.rb', line 19217

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 in the Amazon Web Services Systems Manager User Guide.

Returns:

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

# File 'lib/aws-sdk-ssm/types.rb', line 19217

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)

# File 'lib/aws-sdk-ssm/types.rb', line 19217

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)

# File 'lib/aws-sdk-ssm/types.rb', line 19217

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