CLI で StartSession を使用する - AWS Systems Manager

CLI で StartSession を使用する

次のサンプルコードは、StartSession を使用する方法を説明しています。

CLI
AWS CLI

例 1: Session Manager のセッションを開始するには

この start-session の例では、Session Manager のセッションのためにインスタンスとの接続を確立します。このインタラクティブなコマンドでは、呼び出しを実行するクライアントマシンに Session Manager プラグインがインストールされている必要があることに留意してください。

aws ssm start-session \
    --target "i-1234567890abcdef0"

出力:

Starting session with SessionId: Jane-Roe-07a16060613c408b5

例 2: SSH を使用して Session Manager のセッションを開始するには

この start-session の例では、SSH を使用して Session Manager のセッションのためにインスタンスとの接続を確立します。このインタラクティブなコマンドでは、呼び出しを実行するクライアントマシンに Session Manager プラグインがインストールされている必要があり、コマンドは Linux の EC2 インスタンスの ec2-user など、インスタンスのデフォルトユーザーを使用することに留意してください。

ssh -i /path/my-key-pair.pem ec2-user@i-02573cafcfEXAMPLE

出力:

Starting session with SessionId: ec2-user-07a16060613c408b5

詳細については、「AWS Systems Manager ユーザーガイド」の「セッションを開始する」および「AWS CLI 用の Session Manager プラグインをインストールする」を参照してください。

  • API の詳細については、「AWS CLI コマンドリファレンス」の「StartSession」を参照してください。

PowerShell
Tools for PowerShell V4

例 1: この例では、Session Manager のセッションのターゲットへの接続を開始し、ポート転送を有効にします。

Start-SSMSession -Target 'i-064578e5e7454488f' -DocumentName 'AWS-StartPortForwardingSession' -Parameter @{ localPortNumber = '8080'; portNumber = '80' }

出力:

SessionId    StreamUrl
----------    ----------
random-id0    wss://ssmmessages.amazonaws.com/v1/data-channel/random-id

  • API の詳細については、「AWS Tools for PowerShell Cmdlet リファレンス (V4)」の「StartSession」を参照してください。

Tools for PowerShell V5

例 1: この例では、Session Manager のセッションのターゲットへの接続を開始し、ポート転送を有効にします。注: AWSCredentials を使用して設定していない場合は、Region パラメータを追加する必要があります。

Start-SSMSession -Target 'i-064578e5e7454488f' -DocumentName 'AWS-StartPortForwardingSession' -Parameter @{ localPortNumber = '8080'; portNumber = '80' } -Region 'us-west-1'

出力:

Starting session with SessionId: testUser-xi4glew849asyeryde34u4dfsdfy
Port 8080 opened for sessionId testUser-xi4glew849asyeryde34u4dfsdfy.
Waiting for connections...

例 2: この例では、Session Manager セッションに指定されたインスタンスを使用してインタラクティブセッションを作成します。

Start-SSMSession -Target 'i-1234567890abcdef0' -Region 'us-west-1'

出力:

Starting session with SessionId : testUser-xi4glew849asyeryde34u4dfsdfy
Windows PowerShell
Copyright (C) Microsoft Corporation. All rights reserved.
                                                                                                                                                                                                
Install the latest PowerShell for new features and improvements!
                                                                                                                                                      
PS C:\Windows\system32> whoami
ec2amaz-fnsdrwv\ec2-test-user
PS C:\Windows\system32>

例 3: この例では、セッションに接続せずにセッションを作成し、セッションへの接続に必要な SessionId、StreamUrl、TokenValue のプロパティを返します。

Start-SSMSession -Target 'i-1234567890abcdef0' -Region 'us-west-1' -DisablePluginInvocation

出力:

SessionId        : testUser-xi4glew849asyeryde34u4dfsdfy
StreamUrl        : {StreamUrl value redacted}
TokenValue       : {Token value redacted}
ContentLength    : 1207
HttpStatusCode   : OK

  • API の詳細については、AWS Tools for PowerShell Cmdlet リファレンス (V5) の「StartSession」を参照してください。

AWS SDK デベロッパーガイドとコード例の詳細なリストについては、「このサービスを AWS SDK で使用する」を参照してください。このトピックには、使用開始方法に関する情報と、以前の SDK バージョンの詳細も含まれています。