Skip to content
v2.275.0

CfnUsagePlanKeyProps Struct ​

Properties for defining a CfnUsagePlanKey.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apigateway as apigateway } from 'aws-cdk-lib';
const cfnUsagePlanKeyProps: apigateway.CfnUsagePlanKeyProps = {
  keyId: 'keyId',
  keyType: 'keyType',
  usagePlanId: 'usagePlanId',
};

Properties ​

keyIdstring | IApiKeyRefkey_idtyping.Union[str, IApiKeyRef]keyIdStringKeyIdstringKeyIdinterface{}required#
The Id of the UsagePlanKey resource.
keyTypestringkey_typestrkeyTypeStringKeyTypestringKeyType*stringrequired#
The type of a UsagePlanKey resource for a plan customer.
usagePlanIdstring | IUsagePlanRefusage_plan_idtyping.Union[str, IUsagePlanRef]usagePlanIdStringUsagePlanIdstringUsagePlanIdinterface{}required#
The Id of the UsagePlan resource representing the usage plan containing the UsagePlanKey resource representing a plan customer.