CfnUsagePlanKeyProps¶

class aws_cdk.aws_apigateway.CfnUsagePlanKeyProps(*, key_id, key_type, usage_plan_id)¶

Bases: object

Properties for defining a CfnUsagePlanKey.

Parameters

key_id (str) – The ID of the usage plan key.
key_type (str) – The type of usage plan key. Currently, the only valid key type is API_KEY .
usage_plan_id (str) – The ID of the usage plan.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_apigateway as apigateway

cfn_usage_plan_key_props = apigateway.CfnUsagePlanKeyProps(
    key_id="keyId",
    key_type="keyType",
    usage_plan_id="usagePlanId"
)

Attributes

key_id¶

The ID of the usage plan key.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html#cfn-apigateway-usageplankey-keyid
Return type: str

key_type¶

The type of usage plan key.

Currently, the only valid key type is API_KEY .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html#cfn-apigateway-usageplankey-keytype
Return type: str

usage_plan_id¶

The ID of the usage plan.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html#cfn-apigateway-usageplankey-usageplanid
Return type: str