AWS Systems Manager 작업

이 페이지는 워크플로우 자동화 액션 카탈로그에서 사용할 수 있는 AWS Systems Manager 액션에 대한 참조를 제공합니다. 이러한 액션을 사용하여 AWS Systems Manager 자동화 문서를 생성, 실행 및 관리하십시오.

전제 조건

사전 요구 사항 및 자격 증명 설정에 대해서는 AWS 자격 증명 설정을 참조하십시오.

문서 생성

작업 식별자는 aws.systemsManager.writeDocument입니다.

AWS 계정에서 SSM 문서를 생성하거나 업데이트합니다. AWS 시스템 관리자 설명서를 참조하십시오.

다음 표에서는 이 작업의 입력 필드를 설명합니다.

입력	유형	설명	예시
`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 Reference 의 상태 중 하나입니다.
`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 시스템 관리자 설명서를 참조하십시오.

다음 표에서는 이 작업의 입력 필드를 설명합니다.

입력	유형	설명	예시
`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 시스템 관리자 설명서를 참조하십시오.

다음 표에서는 이 작업의 입력 필드를 설명합니다.

입력	유형	설명	예시
`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 시스템 관리자 설명서를 참조하십시오.

다음 표에서는 이 작업의 입력 필드를 설명합니다.

입력	유형	설명	예시
`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;}

문서 생성

문서 삭제

자동화 시작

자동화 상태를 기다리세요

전제 조건