software.amazon.awscdk.services.apigateway

Class CfnUsagePlanKey

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.apigateway.CfnUsagePlanKey

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:47.591Z")
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 interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnUsagePlanKey(Construct scope, java.lang.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
java.lang.String	getAttrId() The ID for the usage plan key.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getKeyId() The Id of the UsagePlanKey resource to be deleted.
java.lang.String	getKeyType() The type of a UsagePlanKey resource for a plan customer.
java.lang.String	getUsagePlanId() The Id of the UsagePlan resource representing the usage plan containing the to-be-deleted UsagePlanKey resource representing a plan customer.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setKeyId(java.lang.String value) The Id of the UsagePlanKey resource to be deleted.
void	setKeyType(java.lang.String value) The type of a UsagePlanKey resource for a plan customer.
void	setUsagePlanId(java.lang.String value) The Id of the UsagePlan resource representing the usage plan containing the to-be-deleted UsagePlanKey resource representing a plan customer.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.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

public CfnUsagePlanKey(Construct scope,
                       java.lang.String id,
                       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

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrId

public java.lang.String getAttrId()

The ID for the usage plan key.

For example: abc123 .

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getKeyId

public java.lang.String getKeyId()

The Id of the UsagePlanKey resource to be deleted.

setKeyId

public void setKeyId(java.lang.String value)

The Id of the UsagePlanKey resource to be deleted.

getKeyType

public java.lang.String getKeyType()

The type of a UsagePlanKey resource for a plan customer.

setKeyType

public void setKeyType(java.lang.String value)

The type of a UsagePlanKey resource for a plan customer.

getUsagePlanId

public java.lang.String getUsagePlanId()

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

setUsagePlanId

public void setUsagePlanId(java.lang.String value)

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