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	awscc.apigateway.base_path_mappings

Fields

get (all properties)

Name	Datatype	Description
base_path	string
domain_name	string
rest_api_id	string
stage	string
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
base_path	string
domain_name	string
region	string	AWS region.

For more information, see AWS::ApiGateway::BasePathMapping.

Methods

Name	Resource	Accessible by	Required Params
create_resource	base_path_mappings	INSERT	DomainName, region
delete_resource	base_path_mappings	DELETE	Identifier, region
update_resource	base_path_mappings	UPDATE	Identifier, PatchDocument, region
list_resources	base_path_mappings_list_only	SELECT	region
get_resource	base_path_mappings	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual base_path_mapping.

SELECT
  region,
  base_path,
  domain_name,
  rest_api_id,
  stage
FROM awscc.apigateway.base_path_mappings
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ domain_name }}|{{ base_path }}';

list (identifiers only)

Lists all base_path_mappings in a region.

SELECT
  region,
  domain_name,
  base_path
FROM awscc.apigateway.base_path_mappings_list_only
WHERE
  region = '{{ region }}';

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 awscc.apigateway.base_path_mappings (
  DomainName,
  region
)
SELECT
  '{{ domain_name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.apigateway.base_path_mappings (
  BasePath,
  DomainName,
  RestApiId,
  Stage,
  region
)
SELECT
  '{{ base_path }}',
  '{{ domain_name }}',
  '{{ rest_api_id }}',
  '{{ stage }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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: base_path
      value: '{{ base_path }}'
    - name: domain_name
      value: '{{ domain_name }}'
    - name: rest_api_id
      value: '{{ rest_api_id }}'
    - name: stage
      value: '{{ stage }}'

UPDATE example

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

/*+ update */
UPDATE awscc.apigateway.base_path_mappings
SET PatchDocument = string('{{ {
    "RestApiId": rest_api_id,
    "Stage": stage
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ domain_name }}|{{ base_path }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.apigateway.base_path_mappings
WHERE
  Identifier = '{{ domain_name }}|{{ base_path }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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