L1 Construct
AWS::ApiGateway::UsagePlanKeyCfnUsagePlanKey
The `AWS::ApiGateway::UsagePlanKey` resource associates an API key with a usage plan. This association determines which users the usage plan is applied to.
Import
import { CfnUsagePlanKey } from 'aws-cdk-lib/aws-apigateway';Or use the module namespace:
import * as apigateway from 'aws-cdk-lib/aws-apigateway';
// apigateway.CfnUsagePlanKeyProperties
Configuration passed to the constructor as CfnUsagePlanKeyProps.
keyIdRequiredstring | IApiKeyRefThe Id of the UsagePlanKey resource.
keyTypeRequiredstringThe type of a UsagePlanKey resource for a plan customer.
usagePlanIdRequiredstring | IUsagePlanRefThe Id of the UsagePlan resource representing the usage plan containing the UsagePlanKey resource representing a plan customer.
CloudFormation Resource
This L1 construct maps directly to the following CloudFormation resource type.
Get the Amazon API Gateway Cheat Sheet
Everything you need to know about Amazon API Gateway on one page. HD quality, print-friendly.
Download Free InfographicQuick Facts
LevelL1 (CloudFormation)
Module
aws-apigatewayCFN Type
AWS::ApiGateway::UsagePlanKeyProperties3