base_path_mappings

Creates, updates, deletes or gets a base_path_mapping resource or lists base_path_mappings in a region

Overview

Name	base_path_mappings
Type	Resource
Description	The AWS::ApiGateway::BasePathMapping resource creates a base path that clients who call your API must use in the invocation URL.
Id	aws.apigateway.base_path_mappings

Fields

Name	Datatype	Description
base_path	string	The base path name that callers of the API must provide as part of the URL after the domain name.
domain_name	string	The domain name of the BasePathMapping resource to be described.
rest_api_id	string	The string identifier of the associated RestApi.
stage	string	The name of the associated stage.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	DomainName, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all base_path_mappings in a region.

SELECT
region,
base_path,
domain_name,
rest_api_id,
stage
FROM aws.apigateway.base_path_mappings
WHERE region = 'us-east-1';

Gets all properties from an individual base_path_mapping.

SELECT
region,
base_path,
domain_name,
rest_api_id,
stage
FROM aws.apigateway.base_path_mappings
WHERE region = 'us-east-1' AND data__Identifier = '<DomainName>|<BasePath>';

INSERT example

Use the following StackQL query and manifest file to create a new base_path_mapping resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.apigateway.base_path_mappings (
 DomainName,
 region
)
SELECT 
'{{ DomainName }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.apigateway.base_path_mappings (
 BasePath,
 DomainName,
 RestApiId,
 Stage,
 region
)
SELECT 
 '{{ BasePath }}',
 '{{ DomainName }}',
 '{{ RestApiId }}',
 '{{ Stage }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: base_path_mapping
    props:
      - name: BasePath
        value: '{{ BasePath }}'
      - name: DomainName
        value: '{{ DomainName }}'
      - name: RestApiId
        value: '{{ RestApiId }}'
      - name: Stage
        value: '{{ Stage }}'

DELETE example

/*+ delete */
DELETE FROM aws.apigateway.base_path_mappings
WHERE data__Identifier = '<DomainName|BasePath>'
AND region = 'us-east-1';

Permissions

To operate on the base_path_mappings resource, the following permissions are required:

Create

apigateway:POST,
apigateway:GET

Read

apigateway:GET

Update

apigateway:GET,
apigateway:DELETE,
apigateway:PATCH

Delete

apigateway:DELETE

List

apigateway:GET