Package software.amazon.awscdk.services.apigateway

Class CfnUsagePlanKey

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.apigateway.CfnUsagePlanKey

All Implemented Interfaces:

IInspectable, IUsagePlanKeyRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-29T11:15:31.453Z")
@Stability(Stable)
public class CfnUsagePlanKey
extends CfnResource
implements IInspectable, IUsagePlanKeyRef

The AWS::ApiGateway::UsagePlanKey resource associates an API key with a usage plan.

This association determines which users the usage plan is applied to.

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.*;
 CfnUsagePlanKey cfnUsagePlanKey = CfnUsagePlanKey.Builder.create(this, "MyCfnUsagePlanKey")
         .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	Class	Description
static final class	CfnUsagePlanKey.Builder	A fluent builder for CfnUsagePlanKey.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigateway.IUsagePlanKeyRef

IUsagePlanKeyRef.Jsii$Default, IUsagePlanKeyRef.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnUsagePlanKey(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnUsagePlanKey(software.amazon.jsii.JsiiObjectRef objRef)
	CfnUsagePlanKey(software.constructs.Construct scope, String id, CfnUsagePlanKeyProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrId()	The ID for the usage plan key.
protected Map<String,Object>	getCfnProperties()
String	getKeyId()	The Id of the UsagePlanKey resource.
String	getKeyType()	The type of a UsagePlanKey resource for a plan customer.
String	getUsagePlanId()	The Id of the UsagePlan resource representing the usage plan containing the UsagePlanKey resource representing a plan customer.
UsagePlanKeyReference	getUsagePlanKeyRef()	A reference to a UsagePlanKey resource.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setKeyId(String value)	The Id of the UsagePlanKey resource.
void	setKeyType(String value)	The type of a UsagePlanKey resource for a plan customer.
void	setUsagePlanId(String value)	The Id of the UsagePlan resource representing the usage plan containing the UsagePlanKey resource representing a plan customer.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnUsagePlanKey

protected CfnUsagePlanKey(software.amazon.jsii.JsiiObjectRef objRef)

CfnUsagePlanKey

protected CfnUsagePlanKey(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnUsagePlanKey

@Stability(Stable)
public CfnUsagePlanKey(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnUsagePlanKeyProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrId

@Stability(Stable)
@NotNull
public String getAttrId()

The ID for the usage plan key.

For example: abc123 .

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getUsagePlanKeyRef

@Stability(Stable)
@NotNull
public UsagePlanKeyReference getUsagePlanKeyRef()

A reference to a UsagePlanKey resource.

Specified by:

getUsagePlanKeyRef in interface IUsagePlanKeyRef

getKeyId

@Stability(Stable)
@NotNull
public String getKeyId()

The Id of the UsagePlanKey resource.

setKeyId

@Stability(Stable)
public void setKeyId(@NotNull
 String value)

The Id of the UsagePlanKey resource.

getKeyType

@Stability(Stable)
@NotNull
public String getKeyType()

The type of a UsagePlanKey resource for a plan customer.

setKeyType

@Stability(Stable)
public void setKeyType(@NotNull
 String value)

The type of a UsagePlanKey resource for a plan customer.

getUsagePlanId

@Stability(Stable)
@NotNull
public String getUsagePlanId()

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

setUsagePlanId

@Stability(Stable)
public void setUsagePlanId(@NotNull
 String value)

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