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 UsagePlanKey resource to be deleted.

  • key_type (str) – The type of a UsagePlanKey resource for a plan customer.

  • usage_plan_id (str) – The Id of the UsagePlan resource representing the usage plan containing the to-be-deleted UsagePlanKey resource representing a plan customer.

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 UsagePlanKey resource to be deleted.

Link:

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

key_type

The type of a UsagePlanKey resource for a plan customer.

Link:

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

usage_plan_id

The Id of the UsagePlan resource representing the usage plan containing the to-be-deleted UsagePlanKey resource representing a plan customer.

Link:

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