Class UsagePlan

Inheritance

System.Object

Construct

Resource

UsagePlan

Implements

IResource

IConstruct

Constructs.IConstruct

IDependable

Inherited Members

Resource.IsResource(IConstruct)

Resource.ApplyRemovalPolicy(RemovalPolicy)

Resource.GeneratePhysicalName()

Resource.GetResourceArnAttribute(String, IArnComponents)

Resource.GetResourceNameAttribute(String)

Resource.Env

Resource.PhysicalName

Resource.Stack

Construct.IsConstruct(Object)

Construct.OnPrepare()

Construct.OnSynthesize(ISynthesisSession)

Construct.OnValidate()

Construct.Prepare()

Construct.Synthesize(ISynthesisSession)

Construct.Validate()

Construct.Node

Namespace: Amazon.CDK.AWS.APIGateway

Assembly: Amazon.CDK.AWS.APIGateway.dll

Syntax (csharp)

public class UsagePlan : Resource, IResource, IConstruct, IConstruct, IDependable

Syntax (vb)

Public Class UsagePlan
    Inherits Resource
    Implements IResource, IConstruct, IConstruct, IDependable

Synopsis

Constructors

UsagePlan(ByRefValue)	Used by jsii to construct an instance of this class from a Javascript-owned object reference
UsagePlan(DeputyBase.DeputyProps)	Used by jsii to construct an instance of this class from DeputyProps
UsagePlan(Construct, String, IUsagePlanProps)

Properties

UsagePlanId

Methods

AddApiKey(IApiKey, IAddApiKeyOptions)	Adds an ApiKey.
AddApiStage(IUsagePlanPerApiStage)	Adds an apiStage.

Constructors

UsagePlan(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected UsagePlan(ByRefValue reference)

Parameters

reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

UsagePlan(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected UsagePlan(DeputyBase.DeputyProps props)

Parameters

props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

UsagePlan(Construct, String, IUsagePlanProps)

public UsagePlan(Construct scope, string id, IUsagePlanProps props = null)

Parameters

scope Constructs.Construct

id System.String

props IUsagePlanProps

Properties

UsagePlanId

public virtual string UsagePlanId { get; }

Property Value

System.String

Remarks

Attribute: true

Methods

AddApiKey(IApiKey, IAddApiKeyOptions)

Adds an ApiKey.

public virtual 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.

AddApiStage(IUsagePlanPerApiStage)

Adds an apiStage.

public virtual void AddApiStage(IUsagePlanPerApiStage apiStage)

Parameters

apiStage IUsagePlanPerApiStage

Implements

IResource

IConstruct

Constructs.IConstruct

IDependable