resources

Creates, updates, deletes or gets a resource resource or lists resources in a region

Overview

Name	resources
Type	Resource
Description	The AWS::ApiGateway::Resource resource creates a resource in an API.
Id	awscc.apigateway.resources

Fields

get (all properties)

Name	Datatype	Description
parent_id	string
path_part	string
resource_id	string
rest_api_id	string
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
resource_id	string
rest_api_id	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	resources	INSERT	ParentId, PathPart, RestApiId, region
delete_resource	resources	DELETE	Identifier, region
update_resource	resources	UPDATE	Identifier, PatchDocument, region
list_resources	resources_list_only	SELECT	region
get_resource	resources	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual resource.

SELECT
  region,
  parent_id,
  path_part,
  resource_id,
  rest_api_id
FROM awscc.apigateway.resources
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ rest_api_id }}|{{ resource_id }}';

list (identifiers only)

Lists all resources in a region.

SELECT
  region,
  rest_api_id,
  resource_id
FROM awscc.apigateway.resources_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.apigateway.resources (
  ParentId,
  PathPart,
  RestApiId,
  region
)
SELECT
  '{{ parent_id }}',
  '{{ path_part }}',
  '{{ rest_api_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.apigateway.resources (
  ParentId,
  PathPart,
  RestApiId,
  region
)
SELECT
  '{{ parent_id }}',
  '{{ path_part }}',
  '{{ rest_api_id }}',
  '{{ 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: resource
  props:
    - name: parent_id
      value: '{{ parent_id }}'
    - name: path_part
      value: '{{ path_part }}'
    - name: rest_api_id
      value: '{{ rest_api_id }}'

DELETE example

/*+ delete */
DELETE FROM awscc.apigateway.resources
WHERE
  Identifier = '{{ rest_api_id }}|{{ resource_id }}' 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 resources resource, the following permissions are required:

Read

apigateway:GET

Create

apigateway:POST

Update

apigateway:GET,
apigateway:PATCH

List

apigateway:GET

Delete

apigateway:DELETE