fix: Add intrinsic support for AWS::Serverless::Api BasePath property #3808
+72
−108
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -535,13 +535,13 @@ def _construct_api_domain( # noqa: PLR0912, PLR0915 | |
|
|
||
| self._set_optional_domain_properties(domain) | ||
|
|
||
| basepaths: Optional[List[Any]] | ||
| basepath_value = self.domain.get("BasePath") | ||
| # Create BasepathMappings | ||
| if isinstance(basepath_value, str) or is_intrinsic(basepath_value): | ||
|
There was a problem hiding this comment. Thoughts on adding this same support on http_api_generator.py file? |
||
| basepaths = [basepath_value] | ||
| elif isinstance(basepath_value, list): | ||
| basepaths = basepath_value | ||
reedham-aws marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| else: | ||
| basepaths = None | ||
|
|
||
|
|
@@ -554,13 +554,19 @@ def _construct_api_domain( # noqa: PLR0912, PLR0915 | |
| basepath_mapping = self._create_basepath_mapping(api_domain_name, rest_api, None, None) | ||
| basepath_resource_list.extend([basepath_mapping]) | ||
| else: | ||
| if not is_intrinsic(basepaths[0]): | ||
| sam_expect(basepaths, self.logical_id, "Domain.BasePath").to_be_a_list_of(ExpectedType.STRING) | ||
| for basepath in basepaths: | ||
| if is_intrinsic(basepath): | ||
| mapping_basepath = basepath | ||
|
There was a problem hiding this comment. So the parameter |
||
| logical_id = self.logical_id + "BasePathMapping" | ||
|
There was a problem hiding this comment. what happens if there are different base paths all defined with intrinsics? Will they just have the same logical id? Should we add some sort of hash for the intrinsic values here, so we actually create different resources? |
||
| else: | ||
| # Remove possible leading and trailing '/' because a base path may only | ||
| # contain letters, numbers, and one of "$-_.+!*'()" | ||
| path = "".join(e for e in basepath if e.isalnum()) | ||
| mapping_basepath = path if normalize_basepath else basepath | ||
| logical_id = "{}{}{}".format(self.logical_id, path, "BasePathMapping") | ||
|
|
||
| basepath_mapping = self._create_basepath_mapping( | ||
| api_domain_name, rest_api, logical_id, mapping_basepath | ||
| ) | ||
|
|
@@ -810,7 +816,7 @@ def _create_basepath_mapping( | |
| api_domain_name: PassThrough, | ||
| rest_api: ApiGatewayRestApi, | ||
| logical_id: Optional[str], | ||
| basepath: Optional[Any], | ||
reedham-aws marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ) -> ApiGatewayBasePathMapping: | ||
|
|
||
| basepath_mapping: ApiGatewayBasePathMapping | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -99,33 +99,12 @@ | |
| }, | ||
| "Type": "AWS::ApiGateway::RestApi" | ||
| }, | ||
| "MyApiBasePathMapping": { | ||
| "Condition": "C1", | ||
| "Properties": { | ||
| "BasePath": { | ||
| "Fn::Sub": "ap-southeast-1-api" | ||
| }, | ||
| "DomainName": { | ||
| "Ref": "ApiGatewayDomainNamec0ed6fae34" | ||
| }, | ||
|
|
@@ -138,21 +117,28 @@ | |
| }, | ||
| "Type": "AWS::ApiGateway::BasePathMapping" | ||
| }, | ||
| "MyApiDeployment651fe13005": { | ||
| "Condition": "C1", | ||
| "Properties": { | ||
| "Description": "RestApi deployment id: 651fe13005fac4c7c7f2fe93b77c7ef2c6c3e746", | ||
| "RestApiId": { | ||
| "Ref": "MyApi" | ||
| } | ||
| }, | ||
| "Type": "AWS::ApiGateway::Deployment" | ||
| }, | ||
| "MyApiProdStage": { | ||
| "Condition": "C1", | ||
| "Properties": { | ||
| "DeploymentId": { | ||
| "Ref": "MyApiDeployment651fe13005" | ||
| }, | ||
| "RestApiId": { | ||
| "Ref": "MyApi" | ||
| }, | ||
| "StageName": "Prod" | ||
| }, | ||
| "Type": "AWS::ApiGateway::Stage" | ||
| }, | ||
| "MyFunction": { | ||
| "Condition": "C1", | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -107,33 +107,12 @@ | |
| }, | ||
| "Type": "AWS::ApiGateway::RestApi" | ||
| }, | ||
| "MyApiBasePathMapping": { | ||
| "Condition": "C1", | ||
| "Properties": { | ||
| "BasePath": { | ||
| "Fn::Sub": "cn-north-1-api" | ||
| }, | ||
| "DomainName": { | ||
| "Ref": "ApiGatewayDomainNamec0cd2d9dfc" | ||
| }, | ||
|
|
@@ -146,21 +125,28 @@ | |
| }, | ||
| "Type": "AWS::ApiGateway::BasePathMapping" | ||
| }, | ||
| "MyApiDeploymente1e3e9b849": { | ||
| "Condition": "C1", | ||
| "Properties": { | ||
| "Description": "RestApi deployment id: e1e3e9b849803f87115b2cb8fcdf5d144342aaa4", | ||
| "RestApiId": { | ||
| "Ref": "MyApi" | ||
| } | ||
| }, | ||
| "Type": "AWS::ApiGateway::Deployment" | ||
| }, | ||
| "MyApiProdStage": { | ||
| "Condition": "C1", | ||
| "Properties": { | ||
| "DeploymentId": { | ||
| "Ref": "MyApiDeploymente1e3e9b849" | ||
| }, | ||
| "RestApiId": { | ||
| "Ref": "MyApi" | ||
| }, | ||
| "StageName": "Prod" | ||
| }, | ||
| "Type": "AWS::ApiGateway::Stage" | ||
| }, | ||
| "MyFunction": { | ||
| "Condition": "C1", | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -107,33 +107,12 @@ | |
| }, | ||
| "Type": "AWS::ApiGateway::RestApi" | ||
| }, | ||
| "MyApiBasePathMapping": { | ||
| "Condition": "C1", | ||
| "Properties": { | ||
| "BasePath": { | ||
| "Fn::Sub": "us-gov-west-1-api" | ||
| }, | ||
| "DomainName": { | ||
| "Ref": "ApiGatewayDomainName9c93aac102" | ||
| }, | ||
|
|
@@ -146,21 +125,28 @@ | |
| }, | ||
| "Type": "AWS::ApiGateway::BasePathMapping" | ||
| }, | ||
| "MyApiDeployment9d140ab9b8": { | ||
| "Condition": "C1", | ||
| "Properties": { | ||
| "Description": "RestApi deployment id: 9d140ab9b8b8ee141d5cd2d4a90a374c37a10db7", | ||
| "RestApiId": { | ||
| "Ref": "MyApi" | ||
| } | ||
| }, | ||
| "Type": "AWS::ApiGateway::Deployment" | ||
| }, | ||
| "MyApiProdStage": { | ||
| "Condition": "C1", | ||
| "Properties": { | ||
| "DeploymentId": { | ||
| "Ref": "MyApiDeployment9d140ab9b8" | ||
| }, | ||
| "RestApiId": { | ||
| "Ref": "MyApi" | ||
| }, | ||
| "StageName": "Prod" | ||
| }, | ||
| "Type": "AWS::ApiGateway::Stage" | ||
| }, | ||
| "MyFunction": { | ||
| "Condition": "C1", | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.