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

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

Overview

Information about a Session Manager connection to a managed node.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#details ⇒ String

Reserved for future use.

Returns:

  • (String) 


16925
16926
16927
16928
16929
16930
16931
16932
16933
16934
16935
16936
16937
16938
16939
 
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 16925

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) 


16925
16926
16927
16928
16929
16930
16931
16932
16933
16934
16935
16936
16937
16938
16939
 
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 16925

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) 


16925
16926
16927
16928
16929
16930
16931
16932
16933
16934
16935
16936
16937
16938
16939
 
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 16925

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) 


16925
16926
16927
16928
16929
16930
16931
16932
16933
16934
16935
16936
16937
16938
16939
 
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 16925

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:



16925
16926
16927
16928
16929
16930
16931
16932
16933
16934
16935
16936
16937
16938
16939
 
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 16925

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) 


16925
16926
16927
16928
16929
16930
16931
16932
16933
16934
16935
16936
16937
16938
16939
 
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 16925

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) 


16925
16926
16927
16928
16929
16930
16931
16932
16933
16934
16935
16936
16937
16938
16939
 
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 16925

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) 


16925
16926
16927
16928
16929
16930
16931
16932
16933
16934
16935
16936
16937
16938
16939
 
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 16925

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) 


16925
16926
16927
16928
16929
16930
16931
16932
16933
16934
16935
16936
16937
16938
16939
 
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 16925

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) 


16925
16926
16927
16928
16929
16930
16931
16932
16933
16934
16935
16936
16937
16938
16939
 
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 16925

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) 


16925
16926
16927
16928
16929
16930
16931
16932
16933
16934
16935
16936
16937
16938
16939
 
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 16925

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