AWS serverless-application-model documentation change
Summary
Updated terminology from 'AWS CloudFormation' to 'CloudFormation' throughout the documentation. Removed redundant 'AWS' prefixes in references to CloudFormation resources, properties, and compatibility notes.
Security assessment
The changes are purely terminological updates (e.g., 'AWS CloudFormation' → 'CloudFormation') with no modifications to security-related content. The existing security recommendation about using authorizers remains unchanged. No vulnerabilities, security features, or security implications are introduced or altered.
Diff
diff --git a/serverless-application-model/latest/developerguide/sam-resource-api.md b/serverless-application-model/latest/developerguide/sam-resource-api.md index fce2b410b..fc20712d6 100644 --- a//serverless-application-model/latest/developerguide/sam-resource-api.md +++ b//serverless-application-model/latest/developerguide/sam-resource-api.md @@ -15 +15 @@ An AWS::Serverless::Api resource should be used to define and document the API u -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. @@ -17 +17 @@ 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. @@ -23 +23 @@ 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). @@ -77 +77 @@ _Required_ : No -_AWS CloudFormation compatibility_ : This property is passed directly to the `[AccessLogSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-accesslogsetting)` property of an `AWS::ApiGateway::Stage` resource. +_CloudFormation compatibility_ : This property is passed directly to the `[AccessLogSetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-accesslogsetting)` property of an `AWS::ApiGateway::Stage` resource. @@ -88 +88 @@ _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. @@ -99 +99 @@ _Required_ : No -_AWS CloudFormation compatibility_ : This property is passed directly to the `[ApiKeySourceType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-apikeysourcetype)` property of an `AWS::ApiGateway::RestApi` resource. +_CloudFormation compatibility_ : This property is passed directly to the `[ApiKeySourceType](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-apikeysourcetype)` property of an `AWS::ApiGateway::RestApi` resource. @@ -112 +112 @@ _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. @@ -123 +123 @@ _Required_ : No -_AWS CloudFormation compatibility_ : This property is similar to the `[BinaryMediaTypes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-binarymediatypes)` property of an `AWS::ApiGateway::RestApi` resource. The list of BinaryMediaTypes is added to both the AWS CloudFormation resource and the OpenAPI document. +_CloudFormation compatibility_ : This property is similar to the `[BinaryMediaTypes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-binarymediatypes)` property of an `AWS::ApiGateway::RestApi` resource. The list of BinaryMediaTypes is added to both the CloudFormation resource and the OpenAPI document. @@ -134 +134 @@ _Required_ : No -_AWS CloudFormation compatibility_ : This property is passed directly to the `[CacheClusterEnabled](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-cacheclusterenabled)` property of an `AWS::ApiGateway::Stage` resource. +_CloudFormation compatibility_ : This property is passed directly to the `[CacheClusterEnabled](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-cacheclusterenabled)` property of an `AWS::ApiGateway::Stage` resource. @@ -145 +145 @@ _Required_ : No -_AWS CloudFormation compatibility_ : This property is passed directly to the `[CacheClusterSize](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-cacheclustersize)` property of an `AWS::ApiGateway::Stage` resource. +_CloudFormation compatibility_ : This property is passed directly to the `[CacheClusterSize](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-cacheclustersize)` property of an `AWS::ApiGateway::Stage` resource. @@ -156 +156 @@ _Required_ : No -_AWS CloudFormation compatibility_ : This property is passed directly to the `[CanarySetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-canarysetting)` property of an `AWS::ApiGateway::Stage` resource. +_CloudFormation compatibility_ : This property is passed directly to the `[CanarySetting](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-canarysetting)` property of an `AWS::ApiGateway::Stage` resource. @@ -173 +173 @@ _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. @@ -186 +186 @@ _Required_ : No -_AWS CloudFormation compatibility_ : This property is similar to the `[Body](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-body)` property of an `AWS::ApiGateway::RestApi` resource. If certain properties are provided, content may be inserted or modified into the DefinitionBody before being passed to CloudFormation. Properties include `Auth`, `BinaryMediaTypes`, `Cors`, `GatewayResponses`, `Models`, and an `EventSource` of type Api for a corresponding `AWS::Serverless::Function`. +_CloudFormation compatibility_ : This property is similar to the `[Body](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-body)` property of an `AWS::ApiGateway::RestApi` resource. If certain properties are provided, content may be inserted or modified into the DefinitionBody before being passed to CloudFormation. Properties include `Auth`, `BinaryMediaTypes`, `Cors`, `GatewayResponses`, `Models`, and an `EventSource` of type Api for a corresponding `AWS::Serverless::Function`. @@ -201 +201 @@ _Required_ : No -_AWS CloudFormation compatibility_ : This property is similar to the `[BodyS3Location](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-bodys3location)` property of an `AWS::ApiGateway::RestApi` 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-apigateway-restapi.html#cfn-apigateway-restapi-bodys3location)` property of an `AWS::ApiGateway::RestApi` resource. The nested Amazon S3 properties are named differently. @@ -212 +212 @@ _Required_ : No -_AWS CloudFormation compatibility_ : This property is passed directly to the `[Description](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-description)` property of an `AWS::ApiGateway::RestApi` resource. +_CloudFormation compatibility_ : This property is passed directly to the `[Description](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-description)` property of an `AWS::ApiGateway::RestApi` resource. @@ -223 +223 @@ _Required_ : No -_AWS CloudFormation compatibility_ : This property is similar to the `[ DisableExecuteApiEndpoint](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-disableexecuteapiendpoint)` property of an `AWS::ApiGateway::RestApi` 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-apigateway-restapi.html#cfn-apigateway-restapi-body)` property of an `AWS::ApiGateway::RestApi` resource. +_CloudFormation compatibility_ : This property is similar to the `[ DisableExecuteApiEndpoint](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-disableexecuteapiendpoint)` property of an `AWS::ApiGateway::RestApi` 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-apigateway-restapi.html#cfn-apigateway-restapi-body)` property of an `AWS::ApiGateway::RestApi` resource. @@ -234 +234 @@ _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. @@ -245 +245 @@ _Required_ : No -_AWS CloudFormation compatibility_ : This property is similar to the `[EndpointConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-endpointconfiguration)` property of an `AWS::ApiGateway::RestApi` resource. The nested configuration properties are named differently. +_CloudFormation compatibility_ : This property is similar to the `[EndpointConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-endpointconfiguration)` property of an `AWS::ApiGateway::RestApi` resource. The nested configuration properties are named differently. @@ -256 +256 @@ _Required_ : No -_AWS CloudFormation compatibility_ : This property is passed directly to the `[FailOnWarnings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-failonwarnings)` property of an `AWS::ApiGateway::RestApi` resource. +_CloudFormation compatibility_ : This property is passed directly to the `[FailOnWarnings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-failonwarnings)` property of an `AWS::ApiGateway::RestApi` resource. @@ -267 +267 @@ _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. @@ -282 +282 @@ _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. @@ -293 +293 @@ _Required_ : No -_AWS CloudFormation compatibility_ : This property is passed directly to the `[MethodSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-methodsettings)` property of an `AWS::ApiGateway::Stage` resource. +_CloudFormation compatibility_ : This property is passed directly to the `[MethodSettings](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-methodsettings)` property of an `AWS::ApiGateway::Stage` resource. @@ -304 +304 @@ _Required_ : No -_AWS CloudFormation compatibility_ : This property is passed directly to the `[MinimumCompressionSize](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-minimumcompressionsize)` property of an `AWS::ApiGateway::RestApi` resource. +_CloudFormation compatibility_ : This property is passed directly to the `[MinimumCompressionSize](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-minimumcompressionsize)` property of an `AWS::ApiGateway::RestApi` resource. @@ -317 +317 @@ _Required_ : No -_AWS CloudFormation compatibility_ : This property is passed directly to the `[Mode](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-mode)` property of an `AWS::ApiGateway::RestApi` resource. +_CloudFormation compatibility_ : This property is passed directly to the `[Mode](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-mode)` property of an `AWS::ApiGateway::RestApi` resource. @@ -328 +328 @@ _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. @@ -339 +339 @@ _Required_ : No -_AWS CloudFormation compatibility_ : This property is passed directly to the `[Name](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-name)` property of an `AWS::ApiGateway::RestApi` resource. +_CloudFormation compatibility_ : This property is passed directly to the `[Name](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-name)` property of an `AWS::ApiGateway::RestApi` resource. @@ -354 +354 @@ _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. @@ -367 +367 @@ _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. @@ -378 +378 @@ _Required_ : No -_AWS CloudFormation compatibility_ : This property is passed directly to the [ Policy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-policy) property of an `AWS::ApiGateway::RestApi` resource. +_CloudFormation compatibility_ : This property is passed directly to the [ Policy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-policy) property of an `AWS::ApiGateway::RestApi` resource. @@ -385 +385 @@ The name of the stage, which API Gateway uses as the first path segment in the i -To reference the stage resource, use ``<api-logical-id>`.Stage`. For more information about referencing resources generated when an [AWS::Serverless::Api](./sam-resource-api.html) resource is specified, see [AWS CloudFormation resources generated when AWS::Serverless::Api is specified](./sam-specification-generated-resources-api.html). For general information about generated AWS CloudFormation resources, see [Generated AWS CloudFormation resources for AWS SAM](./sam-specification-generated-resources.html). +To reference the stage resource, use ``<api-logical-id>`.Stage`. For more information about referencing resources generated when an [AWS::Serverless::Api](./sam-resource-api.html) resource is specified, see [CloudFormation resources generated when AWS::Serverless::Api is specified](./sam-specification-generated-resources-api.html). For general information about generated CloudFormation resources, see [Generated CloudFormation resources for AWS SAM](./sam-specification-generated-resources.html). @@ -391 +391 @@ _Required_ : Yes -_AWS CloudFormation compatibility_ : This property is similar to the `[StageName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-stagename)` property of an `AWS::ApiGateway::Stage` resource. It is required in SAM, but not required in API Gateway +_CloudFormation compatibility_ : This property is similar to the `[StageName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-stagename)` property of an `AWS::ApiGateway::Stage` resource. It is required in SAM, but not required in API Gateway @@ -404 +404 @@ _Required_ : No -_AWS CloudFormation compatibility_ : This property is similar to the `[Tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-tags)` property of an `AWS::ApiGateway::Stage` resource. The Tags property in SAM consists of Key:Value pairs; in CloudFormation it consists of a list of Tag objects. +_CloudFormation compatibility_ : This property is similar to the `[Tags](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-tags)` property of an `AWS::ApiGateway::Stage` resource. The Tags property in SAM consists of Key:Value pairs; in CloudFormation it consists of a list of Tag objects. @@ -415 +415 @@ _Required_ : No -_AWS CloudFormation compatibility_ : This property is passed directly to the `[TracingEnabled](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-tracingenabled)` property of an `AWS::ApiGateway::Stage` resource. +_CloudFormation compatibility_ : This property is passed directly to the `[TracingEnabled](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-tracingenabled)` property of an `AWS::ApiGateway::Stage` resource. @@ -426 +426 @@ _Required_ : No -_AWS CloudFormation compatibility_ : This property is passed directly to the `[Variables](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-variables)` property of an `AWS::ApiGateway::Stage` resource. +_CloudFormation compatibility_ : This property is passed directly to the `[Variables](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-variables)` property of an `AWS::ApiGateway::Stage` resource.