建立 Session Manager 偏好設定文件 (命令列)

請使用下列步驟來建立定義 AWS Systems Manager Session Manager工作階段偏好設定的SSM文件。您可以使用該文件來設定工作階段選項，包括資料加密、工作階段持續時間和日誌記錄。例如，您可以指定是在 Amazon 簡單儲存服務 (Amazon S3) 儲存貯體還是 Amazon 日誌日誌群組中存放工作階段 CloudWatch 日誌資料。您可以建立定義和所有工作階段之一般偏好設定的文件 AWS 帳戶 AWS 區域，或定義個別工作階段之偏好設定的文件。

注意

您也可以使用 Session Manager 主控台設定一般工作階段偏好設定。

用來設定 Session Manager 偏好設定的文件的 sessionType 必須為 Standard_Stream。如需有關工作階段文件的詳細資訊，請參閱工作階段文件結構描述。

如需使用命令列來更新現有 Session Manager 偏好設定的資訊，請參閱更新 Session Manager 偏好設定 (命令列)。

有關如何使用建立工作階段偏好設定的範例 AWS CloudFormation，請參閱《使AWS CloudFormation 用指南》中的Session Manager偏好設定建立 Systems Manager 文件。

注意

此程序描述如何建立文件，以便在 AWS 帳戶階層設定Session Manager偏好設定。若要建立將用於設定工作階段層級偏好設定的文件，請為檔案名稱相關指令輸入指定初 SSM-SessionManagerRunShell 之外的值。

若要使用文件來設定從 AWS Command Line Interface (AWS CLI) 啟動之工作階段的偏好設定，請提供文件名稱作為 --document-name 參數值。若要為從 Session Manager 主控台啟動的工作階段設定偏好設定，您可以輸入文件名稱或從清單中選取文件的名稱。

建立 Session Manager 偏好設定 (命令列)

在本機電腦上使用名稱 (例如) 建立JSON檔案SessionManagerRunShell.json，然後將下列內容貼到其中。


{
    "schemaVersion": "1.0",
    "description": "Document to hold regional settings for Session Manager",
    "sessionType": "Standard_Stream",
    "inputs": {
        "s3BucketName": "",
        "s3KeyPrefix": "",
        "s3EncryptionEnabled": true,
        "cloudWatchLogGroupName": "",
        "cloudWatchEncryptionEnabled": true,
        "cloudWatchStreamingEnabled": false,
        "kmsKeyId": "",
        "runAsEnabled": false,
        "runAsDefaultUser": "",
        "idleSessionTimeout": "",
        "maxSessionDuration": "",
        "shellProfile": {
            "windows": "date",
            "linux": "pwd;ls"
        }
    }
}

您也可以使用參數將值傳遞到工作階段偏好設定，而不是對這些值進行硬編碼，如以下範例所示。


{
   "schemaVersion":"1.0",
   "description":"Session Document Parameter Example JSON Template",
   "sessionType":"Standard_Stream",
   "parameters":{
      "s3BucketName":{
         "type":"String",
         "default":""
      },
      "s3KeyPrefix":{
         "type":"String",
         "default":""
      },
      "s3EncryptionEnabled":{
         "type":"Boolean",
         "default":"false"
      },
      "cloudWatchLogGroupName":{
         "type":"String",
         "default":""
      },
      "cloudWatchEncryptionEnabled":{
         "type":"Boolean",
         "default":"false"
      }
   },
   "inputs":{
      "s3BucketName":"{{s3BucketName}}",
      "s3KeyPrefix":"{{s3KeyPrefix}}",
      "s3EncryptionEnabled":"{{s3EncryptionEnabled}}",
      "cloudWatchLogGroupName":"{{cloudWatchLogGroupName}}",
      "cloudWatchEncryptionEnabled":"{{cloudWatchEncryptionEnabled}}",
      "kmsKeyId":""
   }
}

指定您要傳送工作階段資料的位置。您可以指定 S3 儲存貯體名稱 (使用選用前置詞) 或 CloudWatch 日誌記錄群組名稱。如果您想要進一步加密本機用戶端和受管節點之間的資料，請提供用於加密的KMS金鑰。以下是範例。
```
{
  "schemaVersion": "1.0",
  "description": "Document to hold regional settings for Session Manager",
  "sessionType": "Standard_Stream",
  "inputs": {
    "s3BucketName": "amzn-s3-demo-bucket",
    "s3KeyPrefix": "MyS3Prefix",
    "s3EncryptionEnabled": true,
    "cloudWatchLogGroupName": "MyLogGroupName",
    "cloudWatchEncryptionEnabled": true,
    "cloudWatchStreamingEnabled": false,
    "kmsKeyId": "MyKMSKeyID",
    "runAsEnabled": true,
    "runAsDefaultUser": "MyDefaultRunAsUser",
    "idleSessionTimeout": "20",
    "maxSessionDuration": "60",
    "shellProfile": {
        "windows": "MyCommands",
        "linux": "MyCommands"
    }
  }
}
```
注意
如果您不想加密工作階段日誌資料，請將 s3EncryptionEnabled 的 true 設為 false。
如果您不將日誌傳送到 Amazon S3 儲存貯體或 CloudWatch 日誌日誌群組，不想加密作用中工作階段資料，或者不想為帳戶中的工作階段開啟執行身分支援，您可以刪除這些選項的行。請確定在 inputs 部分最後一行不是用逗號結尾。
如果您新增KMS金鑰 ID 來加密工作階段資料，則啟動工作階段的使用者和他們連線的受管理節點都必須具有使用金鑰的權限。您提供Session Manager透過IAM原則使用KMS金鑰的權限。如需詳細資訊，請參閱以下主題：
- 為帳戶中的使用者新增 AWS KMS 權限：的 IAM政策範例 Session Manager
- 為帳戶中的受管節點新增 AWS KMS 權限：步驟 2：為 Session Manager 確認或新增執行個體許可
儲存檔案。

在您建立JSON檔案的目錄中，執行下列命令。

如果成功，此命令傳回的輸出會類似如下。

{
    "DocumentDescription": {
        "Status": "Creating",
        "Hash": "ce4fd0a2ab9b0fae759004ba603174c3ec2231f21a81db8690a33eb66EXAMPLE",
        "Name": "SSM-SessionManagerRunShell",
        "Tags": [],
        "DocumentType": "Session",
        "PlatformTypes": [
            "Windows",
            "Linux"
        ],
        "DocumentVersion": "1",
        "HashType": "Sha256",
        "CreatedDate": 1547750660.918,
        "Owner": "111122223333",
        "SchemaVersion": "1.0",
        "DefaultVersion": "1",
        "DocumentFormat": "JSON",
        "LatestVersion": "1"
    }
}

您的瀏覽器已停用或無法使用 Javascript。

您必須啟用 Javascript，才能使用 AWS 文件。請參閱您的瀏覽器說明頁以取得說明。

文件慣用形式

開啟工作階段資料的 KMS 金鑰加密（主控台）

更新 Session Manager 偏好設定 (命令列)