Sign In to the Console
AWS CloudFormation
User Guide (Version )

AWS Documentation » AWS CloudFormation » User Guide » Amazon API Gateway Resource Type Reference » AWS::ApiGateway::UsagePlanKey

AWS::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.

Syntax

To declare this entity in your AWS CloudFormation template, use the following 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 only 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

Examples

Create usage plan key

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

See Also