Show / Hide Table of Contents

Interface IUsagePlan

A UsagePlan, either managed by this CDK app, or imported.

Inherited Members
IResource.ApplyRemovalPolicy(RemovalPolicy)
IResource.Env
IResource.Stack
Namespace: Amazon.CDK.AWS.APIGateway
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IUsagePlan : IResource
Syntax (vb)
Public Interface IUsagePlan
    Inherits IResource, IConstruct, IDependable

Synopsis

Properties

UsagePlanId

Id of the usage plan.

Methods

AddApiKey(IApiKey, IAddApiKeyOptions)

Adds an ApiKey.

Properties

UsagePlanId

Id of the usage plan.

string UsagePlanId { get; }
Property Value

System.String

Remarks

Attribute: true

Methods

AddApiKey(IApiKey, IAddApiKeyOptions)

Adds an ApiKey.

void AddApiKey(IApiKey apiKey, IAddApiKeyOptions options = null)
Parameters
apiKey IApiKey

the api key to associate with this usage plan.

options IAddApiKeyOptions

options that control the behaviour of this method.

Back to top Generated by DocFX