Interface IUsagePlan

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

Inherited Members

IResource.ApplyRemovalPolicy(RemovalPolicy)

IResource.Stack

IUsagePlanRef.UsagePlanRef

IEnvironmentAware.Env

Namespace: Amazon.CDK.AWS.Apigatewayv2

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IUsagePlan : IResource, IUsagePlanRef, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public Interface IUsagePlan Inherits IResource, IUsagePlanRef, IConstruct, IDependable, IEnvironmentAware

Synopsis

Properties

UsagePlanId

Id of the usage plan.

Methods

AddApiKey(IApiKeyRef, IAddApiKeyOptions?)

Adds an ApiKey.

Properties

UsagePlanId

Id of the usage plan.

string UsagePlanId { get; }

Property Value

string

Remarks

Attribute: true

Methods

AddApiKey(IApiKeyRef, IAddApiKeyOptions?)

Adds an ApiKey.

void AddApiKey(IApiKeyRef apiKey, IAddApiKeyOptions? options = null)

Parameters

apiKey IApiKeyRef

the api key to associate with this usage plan.

options IAddApiKeyOptions

options that control the behaviour of this method.