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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.142Z")
 @Stability(value=Stable)
public class CfnUsagePlanKey
extends CfnResource
implements IInspectable

A CloudFormation `AWS::ApiGateway::UsagePlanKey`.

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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static 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.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnUsagePlanKey(software.constructs.Construct scope, String id, CfnUsagePlanKeyProps props) Create a new `AWS::ApiGateway::UsagePlanKey`.
protected	CfnUsagePlanKey(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnUsagePlanKey(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrId()
protected Map<String,Object>	getCfnProperties()
String	getKeyId() The ID of the usage plan key.
String	getKeyType() The type of usage plan key.
String	getUsagePlanId() The ID of the usage plan.
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 usage plan key.
void	setKeyType(String value) The type of usage plan key.
void	setUsagePlanId(String value) The ID of the usage plan.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, 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.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnUsagePlanKey

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

CfnUsagePlanKey

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

CfnUsagePlanKey

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

Create a new `AWS::ApiGateway::UsagePlanKey`.

Parameters:

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

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrId()

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getKeyId

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

The ID of the usage plan key.

setKeyId

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

The ID of the usage plan key.

getKeyType

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

The type of usage plan key.

Currently, the only valid key type is API_KEY .

setKeyType

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

The type of usage plan key.

Currently, the only valid key type is API_KEY .

getUsagePlanId

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

The ID of the usage plan.

setUsagePlanId

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

The ID of the usage plan.