AWS serverless-application-model documentation change
Summary
Removed AccessAssociation property, added NormalizeBasePath documentation, reorganized BasePath details, updated EndpointConfiguration valid values from 'EDGE, REGIONAL, or PRIVATE' to 'REGIONAL or EDGE', and replaced DomainAccessAssociation with Route53Configuration references.
Security assessment
The addition of NormalizeBasePath documentation explains how non-alphanumeric characters are handled in basepaths, which helps prevent potential path manipulation or injection attacks by sanitizing inputs. However, there is no explicit evidence this addresses a specific disclosed vulnerability.
Diff
diff --git a/serverless-application-model/latest/developerguide/sam-property-api-domainconfiguration.md b/serverless-application-model/latest/developerguide/sam-property-api-domainconfiguration.md index 893b5ea85..a79286725 100644 --- a//serverless-application-model/latest/developerguide/sam-property-api-domainconfiguration.md +++ b//serverless-application-model/latest/developerguide/sam-property-api-domainconfiguration.md @@ -18 +17,0 @@ To declare this entity in your AWS Serverless Application Model (AWS SAM) templa - AccessAssociation: [DomainAccessAssociation](./sam-property-api-domainaccessassociation.html) @@ -19,0 +19 @@ To declare this entity in your AWS Serverless Application Model (AWS SAM) templa + NormalizeBasePath: Boolean @@ -24 +23,0 @@ To declare this entity in your AWS Serverless Application Model (AWS SAM) templa - NormalizeBasePath: Boolean @@ -33,2 +32 @@ To declare this entity in your AWS Serverless Application Model (AWS SAM) templa -`AccessAssociation` - +`BasePath` @@ -36 +33,0 @@ To declare this entity in your AWS Serverless Application Model (AWS SAM) templa -The configuration required to generate ` AWS::ApiGateway::DomainNameAccessAssociation` resource. @@ -38 +35 @@ The configuration required to generate ` AWS::ApiGateway::DomainNameAccessAssoci -AWS SAM generates an [AWS::ApiGateway::DomainNameAccessAssociation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainnameaccessassociation.html) resource when this property is set. For information about generated AWS CloudFormation resources, see [Generated AWS CloudFormation resources for AWS SAM](./sam-specification-generated-resources.html). +A list of the basepaths to configure with the Amazon API Gateway domain name. @@ -40 +37 @@ AWS SAM generates an [AWS::ApiGateway::DomainNameAccessAssociation](https://docs -_Type_ : [DomainAccessAssociation](./sam-property-api-domainaccessassociation.html) +_Type_ : List @@ -44 +41 @@ _Required_ : No -_AWS CloudFormation compatibility_ : This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent. +_Default_ : / @@ -46 +43 @@ _AWS CloudFormation compatibility_ : This property is unique to AWS SAM and does -`BasePath` +_AWS CloudFormation compatibility_ : This property is similar to the `[BasePath](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-basepath)` property of an `AWS::ApiGateway::BasePathMapping` resource. AWS SAM creates multiple `AWS::ApiGateway::BasePathMapping` resources, one per `BasePath` specified in this property. @@ -47,0 +45 @@ _AWS CloudFormation compatibility_ : This property is unique to AWS SAM and does +`NormalizeBasePath` @@ -49 +46,0 @@ _AWS CloudFormation compatibility_ : This property is unique to AWS SAM and does -A list of the basepaths to configure with the Amazon API Gateway domain name. @@ -51 +48,5 @@ A list of the basepaths to configure with the Amazon API Gateway domain name. -_Type_ : List +Indicates whether non-alphanumeric characters are allowed in basepaths defined by the `BasePath` property. When set to `True`, non-alphanumeric characters are removed from basepaths. + +Use `NormalizeBasePath` with the `BasePath` property. + +_Type_ : Boolean @@ -55 +56 @@ _Required_ : No -_Default_ : / +_Default_ : True @@ -57 +58 @@ _Default_ : / -_AWS CloudFormation compatibility_ : This property is similar to the `[BasePath](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-basepath)` property of an `AWS::ApiGateway::BasePathMapping` resource. AWS SAM creates multiple `AWS::ApiGateway::BasePathMapping` resources, one per `BasePath` specified in this property. +_AWS CloudFormation compatibility_ : This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent. @@ -90 +91 @@ Defines the type of API Gateway endpoint to map to the custom domain. The value -_Valid values_ : `EDGE`, `REGIONAL`, or `PRIVATE` +_Valid values_ : `REGIONAL` or `EDGE` @@ -111,15 +111,0 @@ _AWS CloudFormation compatibility_ : This property is passed directly to the `[M -`NormalizeBasePath` - - -Indicates whether non-alphanumeric characters are allowed in basepaths defined by the `BasePath` property. When set to `True`, non-alphanumeric characters are removed from basepaths. - -Use `NormalizeBasePath` with the `BasePath` property. - -_Type_ : Boolean - -_Required_ : No - -_Default_ : True - -_AWS CloudFormation compatibility_ : This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent. - @@ -198 +184 @@ CorsConfiguration -DomainAccessAssociation +Route53Configuration