models

Creates, updates, deletes or gets a model resource or lists models in a region

Overview

Name	models
Type	Resource
Description	The ``AWS::ApiGateway::Model`` resource defines the structure of a request or response payload for an API method.
Id	awscc.apigateway.models

Fields

get (all properties)

Name	Datatype	Description
content_type	string
description	string
name	string	A name for the model. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the model name. For more information, see &#91;Name Type&#93;(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).<br />If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
rest_api_id	string
schema	object
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
name	string	A name for the model. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the model name. For more information, see &#91;Name Type&#93;(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).<br />If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
rest_api_id	string
region	string	AWS region.

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

Methods

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

SELECT examples

get (all properties)

Gets all properties from an individual model.

SELECT
  region,
  content_type,
  description,
  name,
  rest_api_id,
  schema
FROM awscc.apigateway.models
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ rest_api_id }}|{{ name }}';

list (identifiers only)

Lists all models in a region.

SELECT
  region,
  rest_api_id,
  name
FROM awscc.apigateway.models_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.apigateway.models (
  RestApiId,
  region
)
SELECT
  '{{ rest_api_id }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.apigateway.models (
  ContentType,
  Description,
  Name,
  RestApiId,
  Schema,
  region
)
SELECT
  '{{ content_type }}',
  '{{ description }}',
  '{{ name }}',
  '{{ rest_api_id }}',
  '{{ schema }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: model
    props:
      - name: content_type
        value: '{{ content_type }}'
      - name: description
        value: '{{ description }}'
      - name: name
        value: '{{ name }}'
      - name: rest_api_id
        value: '{{ rest_api_id }}'
      - name: schema
        value: {}

UPDATE example

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

/*+ update */
UPDATE awscc.apigateway.models
SET PatchDocument = string('{{ {
    "Description": description,
    "Schema": schema
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ rest_api_id }}|{{ name }}';

DELETE example

/*+ delete */
DELETE FROM awscc.apigateway.models
WHERE
  Identifier = '{{ rest_api_id }}|{{ name }}' AND
  region = 'us-east-1';

Permissions

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

Create

apigateway:POST,
apigateway:GET

Read

apigateway:GET

Update

apigateway:PATCH,
apigateway:GET

Delete

apigateway:GET,
apigateway:DELETE

List

apigateway:GET