Class: Aws::SSM::Types::StartSessionRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::SSM::Types::StartSessionRequest
- Defined in:
- gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#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.
17370 17371 17372 17373 17374 17375 17376 17377 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17370 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.
17370 17371 17372 17373 17374 17375 17376 17377 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17370 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.
17370 17371 17372 17373 17374 17375 17376 17377 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17370 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.
17370 17371 17372 17373 17374 17375 17376 17377 |
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 17370 class StartSessionRequest < Struct.new( :target, :document_name, :reason, :parameters) SENSITIVE = [] include Aws::Structure end |