@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:47.591Z") public class CfnUsagePlanKey extends CfnResource implements IInspectable
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();
Modifier and Type | Class and Description |
---|---|
static class |
CfnUsagePlanKey.Builder
A fluent builder for
CfnUsagePlanKey . |
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
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) |
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.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnUsagePlanKey(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnUsagePlanKey(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnUsagePlanKey(Construct scope, java.lang.String id, CfnUsagePlanKeyProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrId()
For example: abc123
.
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.String getKeyId()
public void setKeyId(java.lang.String value)
public java.lang.String getKeyType()
public void setKeyType(java.lang.String value)
public java.lang.String getUsagePlanId()
public void setUsagePlanId(java.lang.String value)