AWS Fundamentals Logo
AWS Fundamentals
AWS::ApiGateway::UsagePlanKey

ApiGateway UsagePlanKey

The AWS::ApiGateway::UsagePlanKey resource associates an API key with a usage plan. This association determines which users the usage plan is applied to.

Properties

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

Filter:
PropertyTypeFlags
KeyId
string
RequiredCreate-only
KeyType
string
RequiredCreate-only
UsagePlanId
string
RequiredCreate-only

Return Values

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

AttributeTypeDescription
Idstring-

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::UsagePlanKey

Resources:
  MyResource:
    Type: AWS::ApiGateway::UsagePlanKey
    Properties:
      KeyType: "API_KEY"
      UsagePlanId: "my-usageplanid"
      KeyId: "my-keyid"

Required IAM Permissions

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

create

apigateway:POSTapigateway:GET

read

apigateway:GET

delete

apigateway:DELETEapigateway:GET

list

apigateway:GET

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 IDId

Supported Operations

CreateReadDeleteList

Immutable After Creation

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

KeyIdUsagePlanIdKeyType

Related Resources

External Links