AWS::ApiGateway::UsagePlanKey - AWS CloudFormation
SyntaxPropertiesReturn valuesExamplesSee also

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 UsagePlanKey resource.

Required: Yes

Type: String

Update requires: Replacement

KeyType

The type of a UsagePlanKey resource for a plan customer.

Required: Yes

Type: String

Allowed values: API_KEY

Update requires: Replacement

UsagePlanId

The Id of the UsagePlan resource representing the usage plan containing the UsagePlanKey resource representing a plan customer.

Required: Yes

Type: String

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ID of the key and ID of the usage plan combined with a ":", such as 123abcdef:abc123.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Id

The ID for the usage plan key. For example: abc123.

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