StartSessionRequest

import type { StartSessionRequest } from "https://aws-api.deno.dev/v0.3/services/ssm.ts?docs=full";

interface StartSessionRequest {

DocumentName?: string | null;

Parameters?: {

[key: string]: string[] | null | undefined;

} | null;

Reason?: string | null;

Target: string;

}

§Properties

DocumentName?: string | null

[src]

The name of the SSM document to define the parameters and plugin settings 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.

Parameters?: {

[key: string]: string[] | null | undefined;

} | null

[src]

Reserved for future use.

Reason?: string | null

[src]

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.

Target: string

[src]

The managed node to connect to for the session.