AWS apigateway documentation change
Summary
Updated references from 'AWS CloudFormation' to 'CloudFormation' throughout the document for consistency in terminology. Minor grammatical fixes in headings (e.g., 'an AWS CloudFormation stack' to 'an CloudFormation stack'). No functional changes to the workflow or security mechanisms.
Security assessment
The changes are purely terminological, removing redundant 'AWS' prefixes from CloudFormation references. The security mechanisms (Lambda authorizer, IAM roles) described remain unchanged. No vulnerabilities are addressed or introduced.
Diff
diff --git a/apigateway/latest/developerguide/websocket-api-step-functions-tutorial.md b/apigateway/latest/developerguide/websocket-api-step-functions-tutorial.md index f6d6c1f79..28fe8b357 100644 --- a//apigateway/latest/developerguide/websocket-api-step-functions-tutorial.md +++ b//apigateway/latest/developerguide/websocket-api-step-functions-tutorial.md @@ -15 +15 @@ This tutorial shows how to broadcast messages to connected clients and includes -After you create your resources using a AWS CloudFormation template, you'll use the API Gateway console to create a WebSocket API that integrates with your AWS resources. You'll attach a Lambda authorizer to your API and create an AWS service integration with Step Functions to start a state machine execution. The Step Functions state machine will invoke a Lambda function that sends a message to all connected clients. +After you create your resources using a CloudFormation template, you'll use the API Gateway console to create a WebSocket API that integrates with your AWS resources. You'll attach a Lambda authorizer to your API and create an AWS service integration with Step Functions to start a state machine execution. The Step Functions state machine will invoke a Lambda function that sends a message to all connected clients. @@ -57 +57 @@ We recommend that you complete the WebSocket chat app tutorial before you start -Download and unzip [the app creation template for AWS CloudFormation](samples/ws-sfn-starter.zip). You'll use this template to create the following: +Download and unzip [the app creation template for CloudFormation](samples/ws-sfn-starter.zip). You'll use this template to create the following: @@ -68 +68 @@ Download and unzip [the app creation template for AWS CloudFormation](samples/ws -###### To create an AWS CloudFormation stack +###### To create an CloudFormation stack @@ -70 +70 @@ Download and unzip [the app creation template for AWS CloudFormation](samples/ws - 1. Open the AWS CloudFormation console at [https://console.aws.amazon.com/cloudformation](https://console.aws.amazon.com/cloudformation/). + 1. Open the CloudFormation console at [https://console.aws.amazon.com/cloudformation](https://console.aws.amazon.com/cloudformation/). @@ -84 +84 @@ Download and unzip [the app creation template for AWS CloudFormation](samples/ws - 8. For **Capabilities** , acknowledge that AWS CloudFormation can create IAM resources in your account. + 8. For **Capabilities** , acknowledge that CloudFormation can create IAM resources in your account. @@ -91 +91 @@ Download and unzip [the app creation template for AWS CloudFormation](samples/ws -AWS CloudFormation provisions the resources specified in the template. It can take a few minutes to finish provisioning your resources. Choose the **Outputs** tab to see your created resources and their ARNs. When the status of your AWS CloudFormation stack is **CREATE_COMPLETE** , you're ready to move on to the next step. +CloudFormation provisions the resources specified in the template. It can take a few minutes to finish provisioning your resources. Choose the **Outputs** tab to see your created resources and their ARNs. When the status of your CloudFormation stack is **CREATE_COMPLETE** , you're ready to move on to the next step. @@ -123 +123 @@ The **$connect** and **$disconnect** routes are special routes that API Gateway - 2. For **Lambda function** , choose the corresponding **$connect** Lambda function that you created with AWS CloudFormation in Step 1. The Lambda function name should start with `websocket-step`. + 2. For **Lambda function** , choose the corresponding **$connect** Lambda function that you created with CloudFormation in Step 1. The Lambda function name should start with `websocket-step`. @@ -129 +129 @@ The **$connect** and **$disconnect** routes are special routes that API Gateway - 2. For **Lambda function** , choose the corresponding **$disconnect** Lambda function that you created with AWS CloudFormation in Step 1. The Lambda function name should start with `websocket-step`. + 2. For **Lambda function** , choose the corresponding **$disconnect** Lambda function that you created with CloudFormation in Step 1. The Lambda function name should start with `websocket-step`. @@ -146 +146 @@ In a mock integration, API Gateway manages the route response without an integra -To control access to your WebSocket API, you create a Lambda authorizer. The AWS CloudFormation template created the Lambda authorizer function for you. You can see the Lambda function in the Lambda console. The name should start with `websocket-step-functions-tutorial-AuthorizerHandler`. This Lambda function denies all calls to the WebSocket API unless the `Authorization` header is `Allow`. The Lambda function also passes the `$context.authorizer.principalId` variable to your API, which is later used in the DynamoDB table to identify API callers. +To control access to your WebSocket API, you create a Lambda authorizer. The CloudFormation template created the Lambda authorizer function for you. You can see the Lambda function in the Lambda console. The name should start with `websocket-step-functions-tutorial-AuthorizerHandler`. This Lambda function denies all calls to the WebSocket API unless the `Authorization` header is `Allow`. The Lambda function also passes the `$context.authorizer.principalId` variable to your API, which is later used in the DynamoDB table to identify API callers. @@ -160 +160 @@ In this step, you configure the **$connect** route to use the Lambda authorizer. - 5. For **Authorizer ARN** , enter the name of the authorizer created by the AWS CloudFormation template. The name should start with `websocket-step-functions-tutorial-AuthorizerHandler`. + 5. For **Authorizer ARN** , enter the name of the authorizer created by the CloudFormation template. The name should start with `websocket-step-functions-tutorial-AuthorizerHandler`. @@ -249 +249 @@ The result should look like the following: -Next, you create a **sendmessage** route. Clients can invoke the **sendmessage** route to broadcast a message to all connected clients. The **sendmessage** route has a non-proxy AWS service integration with AWS Step Functions. The integration invokes the [StartExecution](https://docs.aws.amazon.com/step-functions/latest/apireference/API_StartExecution.html) command for the Step Functions state machine that the AWS CloudFormation template created for you. +Next, you create a **sendmessage** route. Clients can invoke the **sendmessage** route to broadcast a message to all connected clients. The **sendmessage** route has a non-proxy AWS service integration with AWS Step Functions. The integration invokes the [StartExecution](https://docs.aws.amazon.com/step-functions/latest/apireference/API_StartExecution.html) command for the Step Functions state machine that the CloudFormation template created for you. @@ -261 +261 @@ Next, you create a **sendmessage** route. Clients can invoke the **sendmessage** - 5. For **AWS Region** , enter the Region where you deployed your AWS CloudFormation template. + 5. For **AWS Region** , enter the Region where you deployed your CloudFormation template. @@ -269 +269 @@ Next, you create a **sendmessage** route. Clients can invoke the **sendmessage** - 9. For **Execution role** , enter the execution role created by the AWS CloudFormation template. The name should be **WebsocketTutorialApiRole**. + 9. For **Execution role** , enter the execution role created by the CloudFormation template. The name should be **WebsocketTutorialApiRole**. @@ -304 +304 @@ Next, you create a mapping template to send request parameters to the Step Funct -Replace the `stateMachineArn` with the ARN of the state machine created by AWS CloudFormation. +Replace the `stateMachineArn` with the ARN of the state machine created by CloudFormation. @@ -416 +416 @@ When a client disconnects from your API, API Gateway invokes your API's **$disco -To prevent unnecessary costs, delete the resources that you created as part of this tutorial. The following steps delete your AWS CloudFormation stack and WebSocket API. +To prevent unnecessary costs, delete the resources that you created as part of this tutorial. The following steps delete your CloudFormation stack and WebSocket API. @@ -429 +429 @@ To prevent unnecessary costs, delete the resources that you created as part of t -###### To delete an AWS CloudFormation stack +###### To delete an CloudFormation stack @@ -431 +431 @@ To prevent unnecessary costs, delete the resources that you created as part of t - 1. Open the AWS CloudFormation console at [https://console.aws.amazon.com/cloudformation](https://console.aws.amazon.com/cloudformation/). + 1. Open the CloudFormation console at [https://console.aws.amazon.com/cloudformation](https://console.aws.amazon.com/cloudformation/). @@ -433 +433 @@ To prevent unnecessary costs, delete the resources that you created as part of t - 2. Select your AWS CloudFormation stack. + 2. Select your CloudFormation stack. @@ -442 +442 @@ To prevent unnecessary costs, delete the resources that you created as part of t -You can automate the creation and cleanup of all the AWS resources involved in this tutorial. For an example of an AWS CloudFormation template that automates these actions for this tutorial, see [ws-sfn.zip](samples/ws-sfn-complete.zip). +You can automate the creation and cleanup of all the AWS resources involved in this tutorial. For an example of an CloudFormation template that automates these actions for this tutorial, see [ws-sfn.zip](samples/ws-sfn-complete.zip).