Class CfnUsagePlanKey
The AWS::ApiGateway::UsagePlanKey
resource associates an API key with a usage plan.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.APIGateway
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnUsagePlanKey : CfnResource, IInspectable
Syntax (vb)
Public Class CfnUsagePlanKey
Inherits CfnResource
Implements IInspectable
Remarks
This association determines which users the usage plan is applied to.
CloudformationResource: AWS::ApiGateway::UsagePlanKey
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.APIGateway;
var cfnUsagePlanKey = new CfnUsagePlanKey(this, "MyCfnUsagePlanKey", new CfnUsagePlanKeyProps {
KeyId = "keyId",
KeyType = "keyType",
UsagePlanId = "usagePlanId"
});
Synopsis
Constructors
CfnUsagePlanKey(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnUsagePlanKey(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnUsagePlanKey(Construct, String, ICfnUsagePlanKeyProps) |
Properties
AttrId | The ID for the usage plan key. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
KeyId | The Id of the UsagePlanKey resource. |
KeyType | The type of a UsagePlanKey resource for a plan customer. |
UsagePlanId | The Id of the UsagePlan resource representing the usage plan containing the UsagePlanKey resource representing a plan customer. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnUsagePlanKey(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnUsagePlanKey(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnUsagePlanKey(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnUsagePlanKey(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnUsagePlanKey(Construct, String, ICfnUsagePlanKeyProps)
public CfnUsagePlanKey(Construct scope, string id, ICfnUsagePlanKeyProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnUsagePlanKeyProps
Resource properties.
Properties
AttrId
The ID for the usage plan key.
public virtual string AttrId { get; }
Property Value
System.String
Remarks
For example: abc123
.
CloudformationAttribute: Id
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
KeyId
The Id of the UsagePlanKey resource.
public virtual string KeyId { get; set; }
Property Value
System.String
KeyType
The type of a UsagePlanKey resource for a plan customer.
public virtual string KeyType { get; set; }
Property Value
System.String
UsagePlanId
The Id of the UsagePlan resource representing the usage plan containing the UsagePlanKey resource representing a plan customer.
public virtual string UsagePlanId { get; set; }
Property Value
System.String
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>