AWS serverless-application-model documentation change
Summary
Updated documentation to replace 'AWS CloudFormation' with 'CloudFormation' in multiple instances for consistency
Security assessment
Changes are purely branding/naming updates (removing 'AWS' prefix from CloudFormation references). No security vulnerabilities, mitigations, or new security features are introduced. The existing security recommendation about using authorizers remains unchanged except for terminology.
Diff
diff --git a/serverless-application-model/latest/developerguide/sam-resource-httpapi.md b/serverless-application-model/latest/developerguide/sam-resource-httpapi.md index d30815ff0..185328522 100644 --- a//serverless-application-model/latest/developerguide/sam-resource-httpapi.md +++ b//serverless-application-model/latest/developerguide/sam-resource-httpapi.md @@ -11 +11 @@ Creates an Amazon API Gateway HTTP API, which enables you to create RESTful APIs -We recommend that you use AWS CloudFormation hooks or IAM policies to verify that API Gateway resources have authorizers attached to them to control access to them. +We recommend that you use CloudFormation hooks or IAM policies to verify that API Gateway resources have authorizers attached to them to control access to them. @@ -13 +13 @@ We recommend that you use AWS CloudFormation hooks or IAM policies to verify tha -For more information about using AWS CloudFormation hooks, see [Registering hooks](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/registering-hook-python.html) in the _AWS CloudFormation CLI user guide_ and the [apigw-enforce-authorizer](https://github.com/aws-cloudformation/aws-cloudformation-samples/tree/main/hooks/python-hooks/apigw-enforce-authorizer/) GitHub repository. +For more information about using CloudFormation hooks, see [Registering hooks](https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/registering-hook-python.html) in the _CloudFormation CLI user guide_ and the [apigw-enforce-authorizer](https://github.com/aws-cloudformation/aws-cloudformation-samples/tree/main/hooks/python-hooks/apigw-enforce-authorizer/) GitHub repository. @@ -19 +19 @@ For more information about using IAM policies, see [Require that API routes have -When you deploy to AWS CloudFormation, AWS SAM transforms your AWS SAM resources into AWS CloudFormation resources. For more information, see [Generated AWS CloudFormation resources for AWS SAM](./sam-specification-generated-resources.html). +When you deploy to AWS CloudFormation, AWS SAM transforms your AWS SAM resources into CloudFormation resources. For more information, see [Generated CloudFormation resources for AWS SAM](./sam-specification-generated-resources.html). @@ -59 +59 @@ _Required_ : No -_AWS CloudFormation compatibility_ : This property is passed directly to the `[AccessLogSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-accesslogsettings)` property of an `AWS::ApiGatewayV2::Stage` resource. +_CloudFormation compatibility_ : This property is passed directly to the `[AccessLogSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-accesslogsettings)` property of an `AWS::ApiGatewayV2::Stage` resource. @@ -72 +72 @@ _Required_ : No -_AWS CloudFormation compatibility_ : This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent. +_CloudFormation compatibility_ : This property is unique to AWS SAM and doesn't have an CloudFormation equivalent. @@ -89 +89 @@ _Required_ : No -_AWS CloudFormation compatibility_ : This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent. +_CloudFormation compatibility_ : This property is unique to AWS SAM and doesn't have an CloudFormation equivalent. @@ -100 +100 @@ _Required_ : No -_AWS CloudFormation compatibility_ : This property is passed directly to the `[RouteSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-routesettings)` property of an `AWS::ApiGatewayV2::Stage` resource. +_CloudFormation compatibility_ : This property is passed directly to the `[RouteSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-routesettings)` property of an `AWS::ApiGatewayV2::Stage` resource. @@ -111 +111 @@ _Required_ : No -_AWS CloudFormation compatibility_ : This property is similar to the `[Body](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-body)` property of an `AWS::ApiGatewayV2::Api` resource. If certain properties are provided, AWS SAM may insert content into or modify the `DefinitionBody` before it is passed to AWS CloudFormation. Properties include `Auth` and an `EventSource` of type HttpApi for a corresponding `AWS::Serverless::Function` resource. +_CloudFormation compatibility_ : This property is similar to the `[Body](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-body)` property of an `AWS::ApiGatewayV2::Api` resource. If certain properties are provided, AWS SAM may insert content into or modify the `DefinitionBody` before it is passed to CloudFormation. Properties include `Auth` and an `EventSource` of type HttpApi for a corresponding `AWS::Serverless::Function` resource. @@ -126 +126 @@ _Required_ : No -_AWS CloudFormation compatibility_ : This property is similar to the `[BodyS3Location](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-bodys3location)` property of an `AWS::ApiGatewayV2::Api` resource. The nested Amazon S3 properties are named differently. +_CloudFormation compatibility_ : This property is similar to the `[BodyS3Location](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-bodys3location)` property of an `AWS::ApiGatewayV2::Api` resource. The nested Amazon S3 properties are named differently. @@ -146 +146 @@ _Required_ : No -_AWS CloudFormation compatibility_ : This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent. +_CloudFormation compatibility_ : This property is unique to AWS SAM and doesn't have an CloudFormation equivalent. @@ -159 +159 @@ _Required_ : No -_AWS CloudFormation compatibility_ : This property is similar to the `[ DisableExecuteApiEndpoint](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-disableexecuteapiendpoint)` property of an `AWS::ApiGatewayV2::Api` resource. It is passed directly to the `disableExecuteApiEndpoint` property of an `[ x-amazon-apigateway-endpoint-configuration](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-endpoint-configuration.html)` extension, which gets added to the ` [ Body](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-body)` property of an `AWS::ApiGatewayV2::Api` resource. +_CloudFormation compatibility_ : This property is similar to the `[ DisableExecuteApiEndpoint](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-disableexecuteapiendpoint)` property of an `AWS::ApiGatewayV2::Api` resource. It is passed directly to the `disableExecuteApiEndpoint` property of an `[ x-amazon-apigateway-endpoint-configuration](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-endpoint-configuration.html)` extension, which gets added to the ` [ Body](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-body)` property of an `AWS::ApiGatewayV2::Api` resource. @@ -170 +170 @@ _Required_ : No -_AWS CloudFormation compatibility_ : This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent. +_CloudFormation compatibility_ : This property is unique to AWS SAM and doesn't have an CloudFormation equivalent. @@ -181 +181 @@ _Required_ : No -_AWS CloudFormation compatibility_ : This property is passed directly to the `[FailOnWarnings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-failonwarnings)` property of an `AWS::ApiGatewayV2::Api` resource. +_CloudFormation compatibility_ : This property is passed directly to the `[FailOnWarnings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-failonwarnings)` property of an `AWS::ApiGatewayV2::Api` resource. @@ -201 +201 @@ _Required_ : No -_AWS CloudFormation compatibility_ : This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent. +_CloudFormation compatibility_ : This property is unique to AWS SAM and doesn't have an CloudFormation equivalent. @@ -214 +214 @@ _Default_ : `False` -_AWS CloudFormation compatibility_ : This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent. +_CloudFormation compatibility_ : This property is unique to AWS SAM and doesn't have an CloudFormation equivalent. @@ -225 +225 @@ _Required_ : No -_AWS CloudFormation compatibility_ : This property is passed directly to the `[RouteSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-routesettings)` property of an `AWS::ApiGatewayV2::Stage` resource. +_CloudFormation compatibility_ : This property is passed directly to the `[RouteSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-routesettings)` property of an `AWS::ApiGatewayV2::Stage` resource. @@ -238 +238 @@ _Default_ : $default -_AWS CloudFormation compatibility_ : This property is passed directly to the `[StageName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-stagename)` property of an `AWS::ApiGatewayV2::Stage` resource. +_CloudFormation compatibility_ : This property is passed directly to the `[StageName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-stagename)` property of an `AWS::ApiGatewayV2::Stage` resource. @@ -249 +249 @@ _Required_ : No -_AWS CloudFormation compatibility_ : This property is passed directly to the `[StageVariables](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-stagevariables)` property of an `AWS::ApiGatewayV2::Stage` resource. +_CloudFormation compatibility_ : This property is passed directly to the `[StageVariables](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-stagevariables)` property of an `AWS::ApiGatewayV2::Stage` resource. @@ -260 +260 @@ _Required_ : No -_AWS CloudFormation compatibility_ : This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent. +_CloudFormation compatibility_ : This property is unique to AWS SAM and doesn't have an CloudFormation equivalent.