base_path_mapping
Gets an individual base_path_mapping
resource
Overview
Name | base_path_mapping |
Type | Resource |
Description | base_path_mapping |
Id | awscc.apigateway.base_path_mapping |
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
Currently only SELECT
is supported for this resource resource.
Example
SELECT
region,
base_path,
domain_name,
rest_api_id,
stage
FROM awscc.apigateway.base_path_mapping
WHERE data__Identifier = '<DomainName>|<BasePath>';
Permissions
To operate on the base_path_mapping
resource, the following permissions are required:
Read
apigateway:GET
Update
apigateway:GET,
apigateway:DELETE,
apigateway:PATCH
Delete
apigateway:DELETE