View a markdown version of this page

AWS::SSM::Session - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::SSM::Session

Information about a Session Manager connection to a managed node.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::SSM::Session",
  "Properties" : {
      "Reason" : String,
      "Target" : String
    }
}

YAML

Type: AWS::SSM::Session
Properties:
  Reason: String
  Target: String

Properties

Reason

The reason for connecting to the instance.

Required: No

Type: String

Pattern: ^.{1,256}$

Minimum: 1

Maximum: 256

Update requires: Replacement

Target

The managed node that the Session Manager session connected to.

Required: No

Type: String

Minimum: 1

Maximum: 400

Update requires: Replacement

Return values

Ref

Fn::GetAtt

AccessType

Standard access type is the default for Session Manager sessions. JustInTime is the access type for Just-in-time node access.

Arn

Property description not available.

Owner

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

SessionId

The ID of the session.

StartDate

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

Status

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