class
Amazonite::Ssm::StartSessionRequest
- Amazonite::Ssm::StartSessionRequest
- Reference
- Object
Included Modules
- JSON::Serializable
Defined in:
ssm/start_session_request.crConstructors
- .new(pull : JSON::PullParser)
- .new(target : String, document_name : String | Nil = nil, reason : String | Nil = nil, parameters : Hash(String, Array(String)) | Nil = nil)
Instance Method Summary
-
#==(other : self)
Returns
trueif this reference is the same as other. -
#document_name : String | Nil
The name of the SSM document you want to use to define the type of session, input parameters, or preferences for the session.
-
#document_name=(document_name : String | Nil)
The name of the SSM document you want to use to define the type of session, input parameters, or preferences for the session.
-
#hash(hasher)
See
Object#hash(hasher) -
#parameters : Hash(String, Array(String)) | Nil
The values you want to specify for the parameters defined in the Session document.
-
#parameters=(parameters : Hash(String, Array(String)) | Nil)
The values you want to specify for the parameters defined in the Session document.
-
#reason : String | Nil
The reason for connecting to the instance.
-
#reason=(reason : String | Nil)
The reason for connecting to the instance.
-
#target : String
The managed node to connect to for the session.
-
#target=(target : String)
The managed node to connect to for the session.
- #validate! : Nil
Constructor Detail
Instance Method Detail
Returns true if this reference is the same as other. Invokes same?.
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.
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.
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.
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.
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.
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.