AWS Documentation » AWS CloudFormation » User Guide » Template Reference » AWS Resource and Property Types Reference » Amazon API Gateway Resource Types Reference » AWS::ApiGateway::UsagePlanKey

Filter View: All JSON YAML

AWS::ApiGateway::UsagePlanKey

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

Syntax

JSON

{
  "Type" : "AWS::ApiGateway::UsagePlanKey",
  "Properties" : {
    "KeyId" : String,
    "KeyType" : String,
    "UsagePlanId" : String
  }
}

YAML

Type: AWS::ApiGateway::UsagePlanKey
Properties:
  KeyId: String
  KeyType: String
  UsagePlanId: String

Properties

KeyId

The ID of the usage plan key.

Required: Yes

Type: String

Update requires: Replacement

KeyType

The type of usage plan key. Currently, the valid key type is API_KEY.

Required: Yes

Type: String

Update requires: Replacement

UsagePlanId

The value of the usage plan key.

Required: Yes

Type: String

Update requires: Replacement

Example

JSON

"usagePlanKey" : {
  "Type": "AWS::ApiGateway::UsagePlanKey",
  "Properties": {
    "KeyId" : {"Ref" : "myApiKey"},
    "KeyType" : "API_KEY",
    "UsagePlanId" : {"Ref" : "myUsagePlan"}
  }
}

YAML

usagePlanKey:
  Type: AWS::ApiGateway::UsagePlanKey
  Properties : 
    KeyId: !Ref 'myApiKey'
    KeyType: API_KEY
    UsagePlanId: !Ref 'myUsagePlan'