AWS apigateway documentation change
Summary
Updated references from 'AWS CloudFormation' to 'CloudFormation' throughout the documentation, removing redundant AWS branding for service names
Security assessment
The changes are purely branding/terminology updates (removing 'AWS' from CloudFormation references). No security-related content was added or modified. The core security configuration (VPC endpoint restrictions, resource policies) remains unchanged in the tutorial steps.
Diff
diff --git a/apigateway/latest/developerguide/private-api-tutorial.md b/apigateway/latest/developerguide/private-api-tutorial.md index 6ceb56616..05739ea7e 100644 --- a//apigateway/latest/developerguide/private-api-tutorial.md +++ b//apigateway/latest/developerguide/private-api-tutorial.md @@ -5 +5 @@ -Step 1: Create dependenciesStep 2: Create a private APIStep 3: Create a method and integrationStep 4: Attach a resource policyStep 5: Deploy your APIStep 6: Verify that your API isn't publicly accessibleStep 7: Connect to an instance in your VPC and invoke your APIStep 8: Clean upNext steps: Automate with AWS CloudFormation +Step 1: Create dependenciesStep 2: Create a private APIStep 3: Create a method and integrationStep 4: Attach a resource policyStep 5: Deploy your APIStep 6: Verify that your API isn't publicly accessibleStep 7: Connect to an instance in your VPC and invoke your APIStep 8: Clean upNext steps: Automate with CloudFormation @@ -11 +11 @@ In this tutorial, you create a private REST API. Clients can access the API only -This tutorial takes approximately 30 minutes to complete. First, you use an AWS CloudFormation template to create an Amazon VPC, a VPC endpoint, an AWS Lambda function, and launch an Amazon EC2 instance that you'll use to test your API. Next, you use the AWS Management Console to create a private API and attach a resource policy that allows access only from your VPC endpoint. Lastly, you test your API. +This tutorial takes approximately 30 minutes to complete. First, you use an CloudFormation template to create an Amazon VPC, a VPC endpoint, an AWS Lambda function, and launch an Amazon EC2 instance that you'll use to test your API. Next, you use the AWS Management Console to create a private API and attach a resource policy that allows access only from your VPC endpoint. Lastly, you test your API. @@ -17 +17 @@ To complete this tutorial, you need an AWS account and an AWS Identity and Acces -In this tutorial, you use the AWS Management Console. For an AWS CloudFormation template that creates this API and all related resources, see [template.yaml](samples/private-api-full-template.zip). +In this tutorial, you use the AWS Management Console. For an CloudFormation template that creates this API and all related resources, see [template.yaml](samples/private-api-full-template.zip). @@ -37 +37 @@ In this tutorial, you use the AWS Management Console. For an AWS CloudFormation - * Next steps: Automate with AWS CloudFormation + * Next steps: Automate with CloudFormation @@ -44 +44 @@ In this tutorial, you use the AWS Management Console. For an AWS CloudFormation -Download and unzip [this AWS CloudFormation template](samples/private-api-starter-template.zip). You use the template to create all of the dependencies for your private API, including an Amazon VPC, a VPC endpoint, and a Lambda function that serves as the backend of your API. You create the private API later. +Download and unzip [this CloudFormation template](samples/private-api-starter-template.zip). You use the template to create all of the dependencies for your private API, including an Amazon VPC, a VPC endpoint, and a Lambda function that serves as the backend of your API. You create the private API later. @@ -46 +46 @@ Download and unzip [this AWS CloudFormation template](samples/private-api-starte -###### To create an AWS CloudFormation stack +###### To create an CloudFormation stack @@ -48 +48 @@ Download and unzip [this AWS CloudFormation template](samples/private-api-starte - 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/). @@ -62 +62 @@ Download and unzip [this AWS CloudFormation template](samples/private-api-starte - 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. @@ -69 +69 @@ Download and unzip [this AWS CloudFormation template](samples/private-api-starte -AWS CloudFormation provisions the dependencies for your API, which can take a few minutes. When the status of your AWS CloudFormation stack is **CREATE_COMPLETE** , choose **Outputs**. Note your VPC endpoint ID. You need it for later steps in this tutorial. +CloudFormation provisions the dependencies for your API, which can take a few minutes. When the status of your CloudFormation stack is **CREATE_COMPLETE** , choose **Outputs**. Note your VPC endpoint ID. You need it for later steps in this tutorial. @@ -85 +85 @@ You create a private API to allow only clients within your VPC to access it. - 5. For **VPC endpoint IDs** , enter the VPC endpoint ID from the **Outputs** of your AWS CloudFormation stack. + 5. For **VPC endpoint IDs** , enter the VPC endpoint ID from the **Outputs** of your CloudFormation stack. @@ -112 +112 @@ You create a `GET` method and Lambda integration to handle `GET` requests to you - 7. For **Lambda function** , choose the function that you created with the AWS CloudFormation template in Step 1. The function's name begins with `private-api-tutorial`. + 7. For **Lambda function** , choose the function that you created with the CloudFormation template in Step 1. The function's name begins with `private-api-tutorial`. @@ -131 +131 @@ You attach a [resource policy](./apigateway-resource-policies.html) to your API - 4. Enter the following policy. Replace `vpceID` with your VPC endpoint ID from the **Outputs** of your AWS CloudFormation stack. + 4. Enter the following policy. Replace `vpceID` with your VPC endpoint ID from the **Outputs** of your CloudFormation stack. @@ -230 +230 @@ Next, you test your API from within your Amazon VPC. To access your private API, - 3. Choose the instance named **private-api-tutorial** that you created with the AWS CloudFormation template in Step 1. + 3. Choose the instance named **private-api-tutorial** that you created with the CloudFormation template in Step 1. @@ -251 +251 @@ You successfully created an API that's accessible only from within your Amazon V -To prevent unnecessary costs, delete the resources that you created as part of this tutorial. The following steps delete your REST API and your AWS CloudFormation stack. +To prevent unnecessary costs, delete the resources that you created as part of this tutorial. The following steps delete your REST API and your CloudFormation stack. @@ -262 +262 @@ 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 @@ -264 +264 @@ 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/). @@ -266 +266 @@ 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. @@ -273 +273 @@ To prevent unnecessary costs, delete the resources that you created as part of t -## Next steps: Automate with AWS CloudFormation +## Next steps: Automate with CloudFormation @@ -275 +275 @@ To prevent unnecessary costs, delete the resources that you created as part of t -You can automate the creation and cleanup of all AWS resources involved in this tutorial. For a full example AWS CloudFormation template, see [template.yaml](samples/private-api-full-template.zip). +You can automate the creation and cleanup of all AWS resources involved in this tutorial. For a full example CloudFormation template, see [template.yaml](samples/private-api-full-template.zip).