AWS serverless-application-model documentation change
Summary
Updated DomainConfiguration properties - added AccessAssociation reference, reordered properties, added PRIVATE endpoint type option, and moved NormalizeBasePath documentation
Security assessment
Added support for PRIVATE endpoint type which enables VPC-bound API access control. While this enhances security configuration options, there's no evidence it addresses a specific vulnerability. The NormalizeBasePath change improves path handling but isn't explicitly security-related.
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 a79286725..893b5ea85 100644 --- a//serverless-application-model/latest/developerguide/sam-property-api-domainconfiguration.md +++ b//serverless-application-model/latest/developerguide/sam-property-api-domainconfiguration.md @@ -17,0 +18 @@ To declare this entity in your AWS Serverless Application Model (AWS SAM) templa + AccessAssociation: [DomainAccessAssociation](./sam-property-api-domainaccessassociation.html) @@ -19 +19,0 @@ To declare this entity in your AWS Serverless Application Model (AWS SAM) templa - NormalizeBasePath: Boolean @@ -23,0 +24 @@ To declare this entity in your AWS Serverless Application Model (AWS SAM) templa + NormalizeBasePath: Boolean @@ -32 +33 @@ To declare this entity in your AWS Serverless Application Model (AWS SAM) templa -`BasePath` +`AccessAssociation` @@ -35,3 +36 @@ To declare this entity in your AWS Serverless Application Model (AWS SAM) templa -A list of the basepaths to configure with the Amazon API Gateway domain name. - -_Type_ : List +The configuration required to generate ` AWS::ApiGateway::DomainNameAccessAssociation` resource. @@ -39 +38 @@ _Type_ : List -_Required_ : No +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). @@ -41 +40 @@ _Required_ : No -_Default_ : / +_Type_ : [DomainAccessAssociation](./sam-property-api-domainaccessassociation.html) @@ -43 +42 @@ _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. +_Required_ : No @@ -45 +44 @@ _AWS CloudFormation compatibility_ : This property is similar to the `[BasePath] -`NormalizeBasePath` +_AWS CloudFormation compatibility_ : This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent. @@ -46,0 +46 @@ _AWS CloudFormation compatibility_ : This property is similar to the `[BasePath] +`BasePath` @@ -48 +47,0 @@ _AWS CloudFormation compatibility_ : This property is similar to the `[BasePath] -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. @@ -50 +49 @@ Indicates whether non-alphanumeric characters are allowed in basepaths defined b -Use `NormalizeBasePath` with the `BasePath` property. +A list of the basepaths to configure with the Amazon API Gateway domain name. @@ -52 +51 @@ Use `NormalizeBasePath` with the `BasePath` property. -_Type_ : Boolean +_Type_ : List @@ -56 +55 @@ _Required_ : No -_Default_ : True +_Default_ : / @@ -58 +57 @@ _Default_ : True -_AWS CloudFormation compatibility_ : This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent. +_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. @@ -91 +90 @@ Defines the type of API Gateway endpoint to map to the custom domain. The value -_Valid values_ : `REGIONAL` or `EDGE` +_Valid values_ : `EDGE`, `REGIONAL`, or `PRIVATE` @@ -111,0 +111,15 @@ _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. + @@ -184 +198 @@ CorsConfiguration -Route53Configuration +DomainAccessAssociation