gateway_responses

Creates, updates, deletes or gets a gateway_response resource or lists gateway_responses in a region

Overview

Name	gateway_responses
Type	Resource
Description	The AWS::ApiGateway::GatewayResponse resource creates a gateway response for your API. For more information, see API Gateway Responses in the API Gateway Developer Guide.
Id	awscc.apigateway.gateway_responses

Fields

get (all properties)

Name	Datatype	Description
id	string
rest_api_id	string
response_type	string
status_code	string
response_parameters	object
response_templates	object
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
id	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	gateway_responses	INSERT	ResponseType, RestApiId, region
delete_resource	gateway_responses	DELETE	Identifier, region
update_resource	gateway_responses	UPDATE	Identifier, PatchDocument, region
list_resources	gateway_responses_list_only	SELECT	region
get_resource	gateway_responses	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual gateway_response.

SELECT
  region,
  id,
  rest_api_id,
  response_type,
  status_code,
  response_parameters,
  response_templates
FROM awscc.apigateway.gateway_responses
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}';

list (identifiers only)

Lists all gateway_responses in a region.

SELECT
  region,
  id
FROM awscc.apigateway.gateway_responses_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.apigateway.gateway_responses (
  RestApiId,
  ResponseType,
  region
)
SELECT
  '{{ rest_api_id }}',
  '{{ response_type }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.apigateway.gateway_responses (
  RestApiId,
  ResponseType,
  StatusCode,
  ResponseParameters,
  ResponseTemplates,
  region
)
SELECT
  '{{ rest_api_id }}',
  '{{ response_type }}',
  '{{ status_code }}',
  '{{ response_parameters }}',
  '{{ response_templates }}',
  '{{ 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: gateway_response
  props:
    - name: rest_api_id
      value: '{{ rest_api_id }}'
    - name: response_type
      value: '{{ response_type }}'
    - name: status_code
      value: '{{ status_code }}'
    - name: response_parameters
      value: {}
    - name: response_templates
      value: {}

UPDATE example

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

/*+ update */
UPDATE awscc.apigateway.gateway_responses
SET PatchDocument = string('{{ {
    "StatusCode": status_code,
    "ResponseParameters": response_parameters,
    "ResponseTemplates": response_templates
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

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

Create

apigateway:PUT,
apigateway:GET

Read

apigateway:GET

Update

apigateway:GET,
apigateway:PUT

Delete

apigateway:GET,
apigateway:DELETE

List

apigateway:GET