Class: Aws::SSM::Types::Session

Inherits:

Struct

• Object
• Struct
• Aws::SSM::Types::Session

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-ssm/types.rb

Overview

Information about a Session Manager connection to a managed node.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #details ⇒ String

  Reserved for future use.

• #document_name ⇒ String

  The name of the Session Manager SSM document used to define the parameters and plugin settings for the session.

• #end_date ⇒ Time

  The date and time, in ISO-8601 Extended format, when the session was terminated.

• #max_session_duration ⇒ String

  The maximum duration of a session before it terminates.

• #output_url ⇒ Types::SessionManagerOutputUrl

  Reserved for future use.

• #owner ⇒ String

  The ID of the Amazon Web Services user that started the session.

• #reason ⇒ String

  The reason for connecting to the instance.

• #session_id ⇒ String

  The ID of the session.

• #start_date ⇒ Time

  The date and time, in ISO-8601 Extended format, when the session began.

• #status ⇒ String

  The status of the session.

• #target ⇒ String

  The managed node that the Session Manager session connected to.

Instance Attribute Details

#details ⇒ String

Reserved for future use.

Returns:

• (String)

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

class Session < Struct.new(
  :session_id,
  :target,
  :status,
  :start_date,
  :end_date,
  :document_name,
  :owner,
  :reason,
  :details,
  :output_url,
  :max_session_duration)
  SENSITIVE = []
  include Aws::Structure
end

#document_name ⇒ String

The name of the Session Manager SSM document used to define the parameters and plugin settings for the session. For example, ‘SSM-SessionManagerRunShell`.

Returns:

• (String)

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

class Session < Struct.new(
  :session_id,
  :target,
  :status,
  :start_date,
  :end_date,
  :document_name,
  :owner,
  :reason,
  :details,
  :output_url,
  :max_session_duration)
  SENSITIVE = []
  include Aws::Structure
end

#end_date ⇒ Time

The date and time, in ISO-8601 Extended format, when the session was terminated.

Returns:

• (Time)

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

class Session < Struct.new(
  :session_id,
  :target,
  :status,
  :start_date,
  :end_date,
  :document_name,
  :owner,
  :reason,
  :details,
  :output_url,
  :max_session_duration)
  SENSITIVE = []
  include Aws::Structure
end

#max_session_duration ⇒ String

The maximum duration of a session before it terminates.

Returns:

• (String)

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

class Session < Struct.new(
  :session_id,
  :target,
  :status,
  :start_date,
  :end_date,
  :document_name,
  :owner,
  :reason,
  :details,
  :output_url,
  :max_session_duration)
  SENSITIVE = []
  include Aws::Structure
end

#output_url ⇒ Types::SessionManagerOutputUrl

Reserved for future use.

Returns:

• (Types::SessionManagerOutputUrl)

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

class Session < Struct.new(
  :session_id,
  :target,
  :status,
  :start_date,
  :end_date,
  :document_name,
  :owner,
  :reason,
  :details,
  :output_url,
  :max_session_duration)
  SENSITIVE = []
  include Aws::Structure
end

#owner ⇒ String

The ID of the Amazon Web Services user that started the session.

Returns:

• (String)

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

class Session < Struct.new(
  :session_id,
  :target,
  :status,
  :start_date,
  :end_date,
  :document_name,
  :owner,
  :reason,
  :details,
  :output_url,
  :max_session_duration)
  SENSITIVE = []
  include Aws::Structure
end

#reason ⇒ String

The reason for connecting to the instance.

Returns:

• (String)

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

class Session < Struct.new(
  :session_id,
  :target,
  :status,
  :start_date,
  :end_date,
  :document_name,
  :owner,
  :reason,
  :details,
  :output_url,
  :max_session_duration)
  SENSITIVE = []
  include Aws::Structure
end

#session_id ⇒ String

The ID of the session.

Returns:

• (String)

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

class Session < Struct.new(
  :session_id,
  :target,
  :status,
  :start_date,
  :end_date,
  :document_name,
  :owner,
  :reason,
  :details,
  :output_url,
  :max_session_duration)
  SENSITIVE = []
  include Aws::Structure
end

#start_date ⇒ Time

The date and time, in ISO-8601 Extended format, when the session began.

Returns:

• (Time)

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

class Session < Struct.new(
  :session_id,
  :target,
  :status,
  :start_date,
  :end_date,
  :document_name,
  :owner,
  :reason,
  :details,
  :output_url,
  :max_session_duration)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the session. For example, “Connected” or “Terminated”.

Returns:

• (String)

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

class Session < Struct.new(
  :session_id,
  :target,
  :status,
  :start_date,
  :end_date,
  :document_name,
  :owner,
  :reason,
  :details,
  :output_url,
  :max_session_duration)
  SENSITIVE = []
  include Aws::Structure
end

#target ⇒ String

The managed node that the Session Manager session connected to.

Returns:

• (String)

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

class Session < Struct.new(
  :session_id,
  :target,
  :status,
  :start_date,
  :end_date,
  :document_name,
  :owner,
  :reason,
  :details,
  :output_url,
  :max_session_duration)
  SENSITIVE = []
  include Aws::Structure
end