AWS Systems Manager のアクション

このページでは、ワークフロー自動化アクションカタログで利用可能な AWS Systems Manager アクションのリファレンスを提供します。これらのアクションを使用して、AWS Systems Manager オートメーションドキュメントを作成、実行、管理してください。

前提条件

前提条件と認証情報のセットアップについては、AWS認証情報のセットアップをご覧ください。

ドキュメントの作成

アクション識別子はaws.systemsManager.writeDocumentです。

AWSアカウントでSSMドキュメントを作成または更新します。AWS Systems Managerドキュメントをご覧ください。

次の表に、このアクションの入力フィールドについて説明します。

入力	タイプ	説明	例
`awsRoleArn`	弦	オプション。 AWS APIコール用に引き受けるIAMロールARN。	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	弦	オプション。 AWSアクセスキーID。シークレットとして渡します。	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	弦	オプション。 AWSシークレットアクセスキー。シークレットとして渡します。	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	弦	オプション。 STS認証用の一時的なセッショントークンです。シークレットとして渡してください。	`${{ :secrets:awsSessionToken }}`
`region`	弦	必須。ドキュメントが作成されるAWSリージョン。	`us-east-2`
`documentName`	弦	必須。 SSM ドキュメントの名前。	`my-ssm-document`
`documentType`	弦	オプション。 SSMドキュメントのタイプ。有効な値は、 AWS Systems Manager APIリファレンスに記載されています。	`Command`
`documentFormat`	弦	オプション。ドキュメントコンテンツのフォーマット。有効な値： `JSON` 、 `YAML` 、 `TEXT` 。	`YAML`
`documentContent`	弦	必須。文字列としてのSSMドキュメントのコンテンツ。	以下の例を参照してください。
`override`	ブール値	オプション。 `true` （デフォルト）の場合、同じ名前の既存のドキュメントを上書きします。 `false` の場合、その名前のドキュメントがすでに存在する場合はエラーを返します。	`true`
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "documentName", "expression": ".documentName"}]`

次の表は、このアクションの出力フィールドについて説明しています。

出力	タイプ	例
`documentName`	弦	`my-ssm-document`
`documentVersion`	弦	`1`
`documentType`	弦	`Command`
`documentStatus`	弦	`Active` 。値は、 AWS Systems Manager APIリファレンスのステータスのいずれかになります。
`success`	ブール値	`true`
`errorMessage`	弦	`"Some error message from ssm"`

例：すべてのLambda関数を一覧表示する

SSMドキュメントのコンテンツ：

schemaVersion: '0.3'
description: List all Lambda function names.
mainSteps:
  - name: ExecuteAwsApi
    action: aws:executeAwsApi
    isEnd: true
    inputs:
      Service: lambda
      Api: ListFunctions
    outputs:
      - Name: resultFunctionName
        Selector: $..FunctionName
        Type: StringList
outputs:
  - ExecuteAwsApi.resultFunctionName

このドキュメントを使用する完全なワークフロー：

name: aws-api
workflowInputs:
  key:
    type: String
    defaultValue: "${{ :secrets:11933347:USERNAME_AWS_ACCESS_KEY_ID }}"
  access:
    type: String
    defaultValue: "${{ :secrets:11933347:USERNAME_AWS_SECRET_ACCESS_KEY }}"
  token:
    type: String
    defaultValue: "${{ :secrets:11933347:USERNAME_AWS_SESSION_TOKEN }}"
  region:
    type: String
    defaultValue: us-east-2
steps:
  - name: createSsmDocument
    type: action
    action: aws.systemsManager.writeDocument
    version: 1
    inputs:
      awsAccessKeyId: ${{ .workflowInputs.key }}
      awsSecretAccessKey: ${{ .workflowInputs.access }}
      awsSessionToken: ${{ .workflowInputs.token }}
      region: ${{ .workflowInputs.region }}
      documentName: "LambdaListFunctionNames"
      documentContent: |
        schemaVersion: '0.3'
        description: List all Lambda function names.
        mainSteps:
          - name: ExecuteAwsApi
            action: aws:executeAwsApi
            isEnd: true
            inputs:
              Service: lambda
              Api: ListFunctions
            outputs:
              - Name: resultFunctionName
                Selector: $..FunctionName
                Type: StringList
        outputs:
          - ExecuteAwsApi.resultFunctionName
  - name: start1
    type: action
    action: aws.systemsManager.startAutomation
    version: 1
    inputs:
      awsAccessKeyId: ${{ .workflowInputs.key }}
      awsSecretAccessKey: ${{ .workflowInputs.access }}
      awsSessionToken: ${{ .workflowInputs.token }}
      region: ${{ .workflowInputs.region }}
      documentName: "${{ .steps.createSsmDocument.outputs.documentName }}"

ドキュメントの削除

アクション識別子はaws.systemsManager.deleteDocumentです。

アカウントからAWS SSMドキュメントを削除します。AWS Systems Managerドキュメントを参照してください。

次の表に、このアクションの入力フィールドについて説明します。

入力	タイプ	説明	例
`awsRoleArn`	弦	オプション。 AWS APIコール用に引き受けるIAMロールARN。	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	弦	オプション。 AWSアクセスキーID。シークレットとして渡します。	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	弦	オプション。 AWSシークレットアクセスキー。シークレットとして渡します。	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	弦	オプション。 STS認証用の一時的なセッショントークンです。シークレットとして渡してください。	`${{ :secrets:awsSessionToken }}`
`region`	弦	必須。ドキュメントが配置されているAWSリージョンです。	`us-east-2`
`documentName`	弦	必須。削除するSSMドキュメントの名前。	`my-ssm-document`
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "success", "expression": ".success"}]`

次の表は、このアクションの出力フィールドについて説明しています。

出力	タイプ	例
`documentName`	弦	`my-ssm-document`
`success`	ブール値	`true`
`errorMessage`	弦	`"Some error message from ssm"`

自動化を開始

アクション識別子はaws.systemsManager.startAutomationです。

AWS SSMドキュメントを使用してオートメーションを開始します。AWS Systems Managerドキュメントを参照してください。

次の表に、このアクションの入力フィールドについて説明します。

入力	タイプ	説明	例
`awsRoleArn`	弦	オプション。 AWS APIコール用に引き受けるIAMロールARN。	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	弦	オプション。 AWSアクセスキーID。シークレットとして渡します。	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	弦	オプション。 AWSシークレットアクセスキー。シークレットとして渡します。	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	弦	オプション。 STS認証用の一時的なセッショントークンです。シークレットとして渡してください。	`${{ :secrets:awsSessionToken }}`
`region`	弦	必須。 SSMドキュメントが配置されているAWSリージョン。	`us-east-2`
`documentName`	弦	必須。実行するSSMドキュメントの名前。	`my-ssm-document`
`parameters`	地図	オプション。 SSMドキュメントにパラメーターとして渡すキーの値のペアです。	`{"myKey": "myValue"}`
`idempotencyToken`	UUID	オプション。オートメーションの開始時に、べき等性を確保するためのクライアントトークンとして渡されます。	`any-token`
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "automationExecutionId", "expression": ".automationExecutionId"}]`

次の表は、このアクションの出力フィールドについて説明しています。

出力	タイプ	例
`automationExecutionId`	弦	`3143a28d-241c-4abd-a3ca-9c0ff3890241`
`success`	ブール値	`true`
`errorMessage`	弦	`"Some error message from ssm"`

自動化ステータスを待つ

アクション識別子はaws.systemsManager.waitForAutomationStatusです。

指定された終了ステータスのいずれかに達するか、タイムアウトになるまで、AWS SSMオートメーション実行をポーリングします。AWS Systems Managerドキュメントを参照してください。

次の表に、このアクションの入力フィールドについて説明します。

入力	タイプ	説明	例
`awsRoleArn`	弦	オプション。 AWS APIコール用に引き受けるIAMロールARN。	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	弦	オプション。 AWSアクセスキーID。シークレットとして渡します。	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	弦	オプション。 AWSシークレットアクセスキー。シークレットとして渡します。	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	弦	オプション。 STS認証用の一時的なセッショントークンです。シークレットとして渡してください。	`${{ :secrets:awsSessionToken }}`
`region`	弦	必須。オートメーション実行が行われているAWSリージョン。	`us-east-2`
`automationExecutionId`	弦	必須。待機する実行ID。	`3143a28d-241c-4abd-a3ca-9c0ff3890241`
`automationExecutionStatuses`	リスト	オプション。待機を停止する AutomationExecutionステータスのリスト。デフォルト： `["Success", "Failed"]` 。	`["Success", "Failed"]`
`timeout`	Int	オプション。待機する時間（秒）。デフォルトは `180` 、最大は `600` です。超過した場合、 `errorMessage: "Timeout waiting for automation status"` とともに `success: false` を返します。	`180`
`selectors`	リスト	オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。	`[{"name": "automationExecutionStatus", "expression": ".automationExecutionStatus"}]`

次の表は、このアクションの出力フィールドについて説明しています。

出力	タイプ	例
`automationExecutionId`	弦	`3143a28d-241c-4abd-a3ca-9c0ff3890241`
`automationExecutionStatus`	弦	`Success` 。 `automationExecutionStatuses` で渡されたステータスのいずれか、またはアクションが失敗した場合はnull。
`automationExecutionOutputs`	地図	`{"ExecuteGetApiResources": {"resultResourceId": ["pky3cb"]}}` 。SSM ドキュメントからの出力値のマップ；これらを後続のワークフローステップで使用します。
`success`	ブール値	`true`
`errorMessage`	弦	`"Some error message from ssm"`

この機械翻訳は、参考として提供されています。

前提条件.css-21sua1{background:none;border:none;width:0;padding:0;}

ドキュメントの作成

ドキュメントの削除

自動化を開始

自動化ステータスを待つ

前提条件