게이트웨이를 통한 동기식 익스프레스 워크플로우 호출 API - AWS Step Functions

기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

게이트웨이를 통한 동기식 익스프레스 워크플로우 호출 API

이 샘플 프로젝트는 Amazon API Gateway를 통해 동기식 익스프레스 워크플로를 호출하여 직원 데이터베이스를 관리하는 방법을 보여줍니다.

이 프로젝트에서 Step Functions는 API 게이트웨이 엔드포인트를 사용하여 Step Functions 동기식 익스프레스 워크플로를 시작합니다. 그런 다음 DynamoDB를 사용하여 직원 데이터베이스에서 직원을 검색, 추가 및 제거합니다.

Step Functions 동기 Express 워크플로에 대한 자세한 내용은 Step Functions의 동기식 및 비동기식 익스프레스 워크플로우 섹션을 참조하세요.

참고

이 샘플 프로젝트를 사용할 때 요금이 발생할 수 있습니다.

새 제품의 경우 AWS 사용자에게는 프리 티어가 제공됩니다. 이 계층에서 특정 사용 수준 미만의 서비스는 무료입니다. 에 대한 자세한 내용은 AWS 비용 및 프리 티어에 대한 자세한 내용은 Step Functions 요금을 참조하십시오.

1단계: 상태 시스템 만들기

  1. Step Functions 콘솔을 열고 상태 시스템 생성을 선택합니다.

  2. 검색 Invoke Synchronous Express Workflows through API Gateway 상자에 입력한 다음 다음을 통해 동기식 익스프레스 워크플로우 호출을 선택합니다.API Gateway반환된 검색 결과에서.

  3. 다음을 선택하여 계속 진행합니다.

  4. 데모 실행을 선택하여 읽기 전용 및 ready-to-deploy 워크플로를 생성하거나 Build on it를 선택하여 빌드하고 나중에 배포할 수 있는 편집 가능한 상태 머신 정의를 생성합니다.

    이 샘플 프로젝트는 다음 리소스를 배포합니다.

    • 원래 요청 ping에 대한 Amazon API Gateway HTTPSAPI이는 스테이트 머신에서 호출합니다.

    • 원래 요청 ping에 대한 Amazon DynamoDB 테이블.

    • 3 AWS Step Functions 스테이트 머신.

    • 관련 AWS Identity and Access Management (IAM) 역할.

    다음 이미지는 동기식 익스프레스 워크플로우 호출을 통한 워크플로우 그래프를 보여줍니다.API Gateway샘플 프로젝트:

    를 통한 동기식 익스프레스 호출 워크플로의 워크플로 그래프 API Gateway샘플 프로젝트.
  5. 템플릿 사용을 선택하여 계속 선택합니다.

다음 단계는 이전 선택에 따라 달라집니다.

  1. 데모 실행 — 에서 배포한 리소스로 읽기 전용 프로젝트를 만들기 전에 상태 머신을 검토할 수 있습니다. AWS CloudFormation 다음 주소로 AWS 계정.

    상태 머신 정의를 볼 수 있으며 준비가 되면 Deploy and run을 선택하여 프로젝트를 배포하고 리소스를 생성할 수 있습니다.

    배포하는 데 리소스 및 권한을 생성하는 데 최대 10분이 걸릴 수 있습니다. Stack ID 링크를 사용하여 진행 상황을 모니터링할 수 있습니다. AWS CloudFormation.

    배포가 완료되면 콘솔에서 새 상태 머신을 확인할 수 있습니다.

  2. 기반 구축 — 워크플로 정의를 검토하고 편집할 수 있습니다. 사용자 지정 워크플로를 실행하기 전에 샘플 프로젝트에서 자리 표시자의 값을 설정해야 할 수도 있습니다.

참고

계정에 배포된 서비스에는 표준 요금이 적용될 수 있습니다.

2단계: 상태 시스템 실행

  1. 상태 시스템 페이지에서 샘플 프로젝트를 선택합니다.

  2. 샘플 프로젝트 페이지에서 실행 시작을 선택합니다.

  3. 실행 시작 대화 상자에서 다음을 수행합니다.

    1. (선택 사항) 생성된 기본값을 재정의하려면 사용자 지정 실행 이름을 입력합니다.

      ASCII비이름 및 로깅

      Step Functions는 ASCII -자가 아닌 문자를 포함하는 상태 머신, 실행, 액티비티 및 레이블의 이름을 허용합니다. CloudWatchAmazon에서는 이러한 문자를 사용할 수 없으므로 지표를 추적할 수 있도록 ASCII 문자만 사용하는 것이 좋습니다 CloudWatch.

    2. (선택 사항) 입력 상자에 입력 값을 로 입력합니다JSON. 데모를 실행 중인 경우 이 단계를 건너뛸 수 있습니다.

    3. 실행 시작을 선택합니다.

    Step Functions 콘솔은 그래프 보기에서 상태를 선택하여 단계 세부 정보 창에서 관련 정보를 탐색할 수 있는 실행 세부 정보 페이지로 안내합니다.

예제 상태 머신 코드

이 샘플 프로젝트의 상태 머신은 API Gateway를 사용하여 동기식 익스프레스 워크플로를 호출함으로써 Gateway 및 DynamoDB와 통합됩니다. 그러면 API DynamoDB를 사용하여 직원 데이터베이스를 업데이트하거나 직원 데이터베이스에서 데이터를 읽습니다.

이 예제 상태 시스템을 살펴보고 Step Functions가 DynamoDB에서 읽고 직원 정보를 검색하는 방법을 확인합니다.

APIGateway를 사용하여 Step Functions를 호출하는 방법에 대한 자세한 내용은 다음을 참조하십시오.

방법에 대한 자세한 내용은 AWS Step Functions 다른 사람을 제어할 수 있습니다. AWS 서비스, 참조Step Functions와 서비스 통합.

{ "Comment": "This state machine returns an employee entry from DynamoDB", "StartAt": "Read From DynamoDB", "States": { "Read From DynamoDB": { "Type": "Task", "Resource": "arn:aws:states:::dynamodb:getItem", "Parameters": { "TableName": "StepFunctionsSample-SynchronousExpressWorkflowAKIAIOSFODNN7EXAMPLE-DynamoDBTable-ANPAJ2UCCR6DPCEXAMPLE", "Key": { "EmployeeId": {"S.$": "$.employee"} } }, "Retry": [ { "ErrorEquals": [ "DynamoDB.AmazonDynamoDBException" ], "IntervalSeconds": 3, "MaxAttempts": 2, "BackoffRate": 1.5 } ], "Next": "Is Get Successful" }, "Is Get Successful": { "Type": "Choice", "Choices": [ { "Variable": "$.Item", "IsPresent": true, "Next": "Succeed Execution" } ], "Default": "Fail Execution" }, "Succeed Execution": { "Type": "Pass", "Parameters" : { "employee.$": "$.Item.EmployeeId.S", "jobTitle.$": "$.Item.JobTitle.S" }, "End": true }, "Fail Execution": { "Type": "Fail", "Error": "EmployeeDoesNotExist" } } }

Step Functions를 다른 기능과 함께 사용할 IAM 때 구성하는 방법에 대한 자세한 내용은 AWS 서비스는 을 참조하십시오Step Functions가 통합 서비스를 위한 IAM 정책을 생성하는 방법.

IAM예시

이 예시 AWS Identity and Access Management 샘플 프로젝트에서 생성된 (IAM) 정책에는 상태 머신 및 관련 리소스를 실행하는 데 필요한 최소 권한이 포함됩니다. IAM정책에 필요한 권한만 포함하는 것이 좋습니다.

{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "logs:CreateLogDelivery", "logs:GetLogDelivery", "logs:UpdateLogDelivery", "logs:DeleteLogDelivery", "logs:ListLogDeliveries", "logs:PutResourcePolicy", "logs:DescribeResourcePolicies", "logs:DescribeLogGroups" ], "Resource": "*" } ] }
{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "dynamodb:GetItem", "dynamodb:PutItem", "dynamodb:UpdateItem", "dynamodb:DeleteItem" ], "Resource": [ "arn:aws:dynamodb:us-east-1:111122223333:table/Write" ] } ] }

Step Functions를 다른 기능과 함께 사용할 IAM 때 구성하는 방법에 대한 자세한 내용은 AWS 서비스는 을 참조하십시오Step Functions가 통합 서비스를 위한 IAM 정책을 생성하는 방법.