AWS::ApiGateway::Resource

ApiGateway Resource

The AWS::ApiGateway::Resource resource creates a resource in an API.

Properties

3 configurable properties. 3 required. Click a row to see details.

Filter:

Property	Type	Flags
`ParentId`	`string`	RequiredCreate-only
`PathPart`	`string`	RequiredCreate-only
`RestApiId`	`string`	RequiredCreate-only

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`ResourceId`	`string`	-

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::ApiGateway::Resource

Resources:
  MyResource:
    Type: AWS::ApiGateway::Resource
    Properties:
      ParentId: "my-parentid"
      PathPart: "value"
      RestApiId: "my-restapiid"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

read

apigateway:GET

create

apigateway:POST

update

apigateway:GETapigateway:PATCH

list

apigateway:GET

delete

apigateway:DELETE

Get the ApiGateway Cheat Sheet

Everything you need to know about ApiGateway on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

ServiceApiGateway

Properties4

Required3

TaggingNot supported

Primary IDRestApiId

Supported Operations

ReadCreateUpdateListDelete

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

PathPartParentIdRestApiId

Related Resources

External Links

AWS Documentation