Package software.amazon.awscdk.services.apigateway

Interface CfnUsagePlanKeyProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUsagePlanKeyProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:04.151Z")
@Stability(Stable)
public interface CfnUsagePlanKeyProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnUsagePlanKey.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.apigateway.*;
 CfnUsagePlanKeyProps cfnUsagePlanKeyProps = CfnUsagePlanKeyProps.builder()
         .keyId("keyId")
         .keyType("keyType")
         .usagePlanId("usagePlanId")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnUsagePlanKeyProps.Builder	A builder for CfnUsagePlanKeyProps
static final class	CfnUsagePlanKeyProps.Jsii$Proxy	An implementation for CfnUsagePlanKeyProps

Method Summary

Modifier and Type	Method	Description
static CfnUsagePlanKeyProps.Builder	builder()
Object	getKeyId()	The Id of the UsagePlanKey resource.
String	getKeyType()	The type of a UsagePlanKey resource for a plan customer.
Object	getUsagePlanId()	The Id of the UsagePlan resource representing the usage plan containing the UsagePlanKey resource representing a plan customer.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getKeyId

@Stability(Stable)
@NotNull
Object getKeyId()

The Id of the UsagePlanKey resource.

Returns union: either String or IApiKeyRef

See Also:

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

getKeyType

@Stability(Stable)
@NotNull
String getKeyType()

The type of a UsagePlanKey resource for a plan customer.

See Also:

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

getUsagePlanId

@Stability(Stable)
@NotNull
Object getUsagePlanId()

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

Returns union: either String or IUsagePlanRef

See Also:

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

builder

@Stability(Stable)
static CfnUsagePlanKeyProps.Builder builder()

Returns:

a CfnUsagePlanKeyProps.Builder of CfnUsagePlanKeyProps