apiGatewayUsagePlan.md

apiGatewayUsagePlan Submodule

Constructs

ApiGatewayUsagePlan

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_usage_plan aws_api_gateway_usage_plan}.

Initializers

import { apiGatewayUsagePlan } from '@cdktf/aws-cdk'

new apiGatewayUsagePlan.ApiGatewayUsagePlan(scope: Construct, id: string, config: ApiGatewayUsagePlanConfig)

Name	Type	Description
scope	constructs.Construct	The scope in which to define this construct.
id	string	The scoped construct ID.
config	ApiGatewayUsagePlanConfig	No description.

---

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

id^Required

• Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

---

config^Required

• Type: ApiGatewayUsagePlanConfig

---

Methods

Name	Description
toString	Returns a string representation of this construct.
addOverride	No description.
overrideLogicalId	Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId	Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform	No description.
toMetadata	No description.
toTerraform	Adds this resource to the terraform JSON output.
addMoveTarget	Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
getAnyMapAttribute	No description.
getBooleanAttribute	No description.
getBooleanMapAttribute	No description.
getListAttribute	No description.
getNumberAttribute	No description.
getNumberListAttribute	No description.
getNumberMapAttribute	No description.
getStringAttribute	No description.
getStringMapAttribute	No description.
hasResourceMove	No description.
importFrom	No description.
interpolationForAttribute	No description.
moveFromId	Move the resource corresponding to "id" to this resource.
moveTo	Moves this resource to the target resource given by moveTarget.
moveToId	Moves this resource to the resource corresponding to "id".
putApiStages	No description.
putQuotaSettings	No description.
putThrottleSettings	No description.
resetApiStages	No description.
resetDescription	No description.
resetId	No description.
resetProductCode	No description.
resetQuotaSettings	No description.
resetTags	No description.
resetTagsAll	No description.
resetThrottleSettings	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

addOverride

public addOverride(path: string, value: any): void

path^Required

• Type: string

---

value^Required

• Type: any

---

overrideLogicalId

public overrideLogicalId(newLogicalId: string): void

Overrides the auto-generated logical ID with a specific ID.

newLogicalId^Required

• Type: string

The new logical ID to use for this stack element.

---

resetOverrideLogicalId

public resetOverrideLogicalId(): void

Resets a previously passed logical Id to use the auto-generated logical id again.

toHclTerraform

public toHclTerraform(): any

toMetadata

public toMetadata(): any

toTerraform

public toTerraform(): any

Adds this resource to the terraform JSON output.

addMoveTarget

public addMoveTarget(moveTarget: string): void

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

moveTarget^Required

• Type: string

The string move target that will correspond to this resource.

---

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

hasResourceMove

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

importFrom

public importFrom(id: string, provider?: TerraformProvider): void

id^Required

• Type: string

---

provider^Optional

• Type: cdktf.TerraformProvider

---

interpolationForAttribute

public interpolationForAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

moveFromId

public moveFromId(id: string): void

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

id^Required

• Type: string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

---

moveTo

public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

moveTarget^Required

• Type: string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

---

index^Optional

• Type: string | number

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

---

moveToId

public moveToId(id: string): void

Moves this resource to the resource corresponding to "id".

id^Required

• Type: string

Full id of resource to move to, e.g. "aws_s3_bucket.example".

---

putApiStages

public putApiStages(value: IResolvable | ApiGatewayUsagePlanApiStages[]): void

value^Required

• Type: cdktf.IResolvable | ApiGatewayUsagePlanApiStages[]

---

putQuotaSettings

public putQuotaSettings(value: ApiGatewayUsagePlanQuotaSettings): void

value^Required

• Type: ApiGatewayUsagePlanQuotaSettings

---

putThrottleSettings

public putThrottleSettings(value: ApiGatewayUsagePlanThrottleSettings): void

value^Required

• Type: ApiGatewayUsagePlanThrottleSettings

---

resetApiStages

public resetApiStages(): void

resetDescription

public resetDescription(): void

resetId

public resetId(): void

resetProductCode

public resetProductCode(): void

resetQuotaSettings

public resetQuotaSettings(): void

resetTags

public resetTags(): void

resetTagsAll

public resetTagsAll(): void

resetThrottleSettings

public resetThrottleSettings(): void

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isTerraformElement	No description.
isTerraformResource	No description.
generateConfigForImport	Generates CDKTF code for importing a ApiGatewayUsagePlan resource upon running "cdktf plan ".

---

isConstruct

import { apiGatewayUsagePlan } from '@cdktf/aws-cdk'

apiGatewayUsagePlan.ApiGatewayUsagePlan.isConstruct(x: any)

Checks if x is a construct.

x^Required

• Type: any

Any object.

---

isTerraformElement

import { apiGatewayUsagePlan } from '@cdktf/aws-cdk'

apiGatewayUsagePlan.ApiGatewayUsagePlan.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

import { apiGatewayUsagePlan } from '@cdktf/aws-cdk'

apiGatewayUsagePlan.ApiGatewayUsagePlan.isTerraformResource(x: any)

x^Required

• Type: any

---

generateConfigForImport

import { apiGatewayUsagePlan } from '@cdktf/aws-cdk'

apiGatewayUsagePlan.ApiGatewayUsagePlan.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a ApiGatewayUsagePlan resource upon running "cdktf plan ".

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

importToId^Required

• Type: string

The construct id used in the generated config for the ApiGatewayUsagePlan to import.

---

importFromId^Required

• Type: string

The id of the existing ApiGatewayUsagePlan that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_usage_plan#import import section} in the documentation of this resource for the id to use

---

provider^Optional

• Type: cdktf.TerraformProvider

? Optional instance of the provider where the ApiGatewayUsagePlan to import is found.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
cdktfStack	cdktf.TerraformStack	No description.
fqn	string	No description.
friendlyUniqueId	string	No description.
terraformMetaArguments	{[ key: string ]: any}	No description.
terraformResourceType	string	No description.
terraformGeneratorMetadata	cdktf.TerraformProviderGeneratorMetadata	No description.
connection	cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection	No description.
count	number | cdktf.TerraformCount	No description.
dependsOn	string[]	No description.
forEach	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
provisioners	cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]	No description.
apiStages	ApiGatewayUsagePlanApiStagesList	No description.
arn	string	No description.
quotaSettings	ApiGatewayUsagePlanQuotaSettingsOutputReference	No description.
throttleSettings	ApiGatewayUsagePlanThrottleSettingsOutputReference	No description.
apiStagesInput	cdktf.IResolvable | ApiGatewayUsagePlanApiStages[]	No description.
descriptionInput	string	No description.
idInput	string	No description.
nameInput	string	No description.
productCodeInput	string	No description.
quotaSettingsInput	ApiGatewayUsagePlanQuotaSettings	No description.
tagsAllInput	{[ key: string ]: string}	No description.
tagsInput	{[ key: string ]: string}	No description.
throttleSettingsInput	ApiGatewayUsagePlanThrottleSettings	No description.
description	string	No description.
id	string	No description.
name	string	No description.
productCode	string	No description.
tags	{[ key: string ]: string}	No description.
tagsAll	{[ key: string ]: string}	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

cdktfStack^Required

public readonly cdktfStack: TerraformStack;

• Type: cdktf.TerraformStack

---

fqn^Required

public readonly fqn: string;

• Type: string

---

friendlyUniqueId^Required

public readonly friendlyUniqueId: string;

• Type: string

---

terraformMetaArguments^Required

public readonly terraformMetaArguments: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

terraformResourceType^Required

public readonly terraformResourceType: string;

• Type: string

---

terraformGeneratorMetadata^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

• Type: cdktf.TerraformProviderGeneratorMetadata

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: string[];

• Type: string[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

apiStages^Required

public readonly apiStages: ApiGatewayUsagePlanApiStagesList;

• Type: ApiGatewayUsagePlanApiStagesList

---

arn^Required

public readonly arn: string;

• Type: string

---

quotaSettings^Required

public readonly quotaSettings: ApiGatewayUsagePlanQuotaSettingsOutputReference;

• Type: ApiGatewayUsagePlanQuotaSettingsOutputReference

---

throttleSettings^Required

public readonly throttleSettings: ApiGatewayUsagePlanThrottleSettingsOutputReference;

• Type: ApiGatewayUsagePlanThrottleSettingsOutputReference

---

apiStagesInput^Optional

public readonly apiStagesInput: IResolvable | ApiGatewayUsagePlanApiStages[];

• Type: cdktf.IResolvable | ApiGatewayUsagePlanApiStages[]

---

descriptionInput^Optional

public readonly descriptionInput: string;

• Type: string

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

nameInput^Optional

public readonly nameInput: string;

• Type: string

---

productCodeInput^Optional

public readonly productCodeInput: string;

• Type: string

---

quotaSettingsInput^Optional

public readonly quotaSettingsInput: ApiGatewayUsagePlanQuotaSettings;

• Type: ApiGatewayUsagePlanQuotaSettings

---

tagsAllInput^Optional

public readonly tagsAllInput: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

tagsInput^Optional

public readonly tagsInput: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

throttleSettingsInput^Optional

public readonly throttleSettingsInput: ApiGatewayUsagePlanThrottleSettings;

• Type: ApiGatewayUsagePlanThrottleSettings

---

description^Required

public readonly description: string;

• Type: string

---

id^Required

public readonly id: string;

• Type: string

---

name^Required

public readonly name: string;

• Type: string

---

productCode^Required

public readonly productCode: string;

• Type: string

---

tags^Required

public readonly tags: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

tagsAll^Required

public readonly tagsAll: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

ApiGatewayUsagePlanApiStages

Initializer

import { apiGatewayUsagePlan } from '@cdktf/aws-cdk'

const apiGatewayUsagePlanApiStages: apiGatewayUsagePlan.ApiGatewayUsagePlanApiStages = { ... }

Properties

Name	Type	Description
apiId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_usage_plan#api_id ApiGatewayUsagePlan#api_id}.
stage	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_usage_plan#stage ApiGatewayUsagePlan#stage}.
throttle	cdktf.IResolvable | ApiGatewayUsagePlanApiStagesThrottle[]	throttle block.

---

apiId^Required

public readonly apiId: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_usage_plan#api_id ApiGatewayUsagePlan#api_id}.

---

stage^Required

public readonly stage: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_usage_plan#stage ApiGatewayUsagePlan#stage}.

---

throttle^Optional

public readonly throttle: IResolvable | ApiGatewayUsagePlanApiStagesThrottle[];

• Type: cdktf.IResolvable | ApiGatewayUsagePlanApiStagesThrottle[]

throttle block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_usage_plan#throttle ApiGatewayUsagePlan#throttle}

---

ApiGatewayUsagePlanApiStagesThrottle

Initializer

import { apiGatewayUsagePlan } from '@cdktf/aws-cdk'

const apiGatewayUsagePlanApiStagesThrottle: apiGatewayUsagePlan.ApiGatewayUsagePlanApiStagesThrottle = { ... }

Properties

Name	Type	Description
path	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_usage_plan#path ApiGatewayUsagePlan#path}.
burstLimit	number	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_usage_plan#burst_limit ApiGatewayUsagePlan#burst_limit}.
rateLimit	number	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_usage_plan#rate_limit ApiGatewayUsagePlan#rate_limit}.

---

path^Required

public readonly path: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_usage_plan#path ApiGatewayUsagePlan#path}.

---

burstLimit^Optional

public readonly burstLimit: number;

• Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_usage_plan#burst_limit ApiGatewayUsagePlan#burst_limit}.

---

rateLimit^Optional

public readonly rateLimit: number;

• Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_usage_plan#rate_limit ApiGatewayUsagePlan#rate_limit}.

---

ApiGatewayUsagePlanConfig

Initializer

import { apiGatewayUsagePlan } from '@cdktf/aws-cdk'

const apiGatewayUsagePlanConfig: apiGatewayUsagePlan.ApiGatewayUsagePlanConfig = { ... }

Properties

Name	Type	Description
connection	cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection	No description.
count	number | cdktf.TerraformCount	No description.
dependsOn	cdktf.ITerraformDependable[]	No description.
forEach	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
provisioners	cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]	No description.
name	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_usage_plan#name ApiGatewayUsagePlan#name}.
apiStages	cdktf.IResolvable | ApiGatewayUsagePlanApiStages[]	api_stages block.
description	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_usage_plan#description ApiGatewayUsagePlan#description}.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_usage_plan#id ApiGatewayUsagePlan#id}.
productCode	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_usage_plan#product_code ApiGatewayUsagePlan#product_code}.
quotaSettings	ApiGatewayUsagePlanQuotaSettings	quota_settings block.
tags	{[ key: string ]: string}	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_usage_plan#tags ApiGatewayUsagePlan#tags}.
tagsAll	{[ key: string ]: string}	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_usage_plan#tags_all ApiGatewayUsagePlan#tags_all}.
throttleSettings	ApiGatewayUsagePlanThrottleSettings	throttle_settings block.

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: ITerraformDependable[];

• Type: cdktf.ITerraformDependable[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

name^Required

public readonly name: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_usage_plan#name ApiGatewayUsagePlan#name}.

---

apiStages^Optional

public readonly apiStages: IResolvable | ApiGatewayUsagePlanApiStages[];

• Type: cdktf.IResolvable | ApiGatewayUsagePlanApiStages[]

api_stages block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_usage_plan#api_stages ApiGatewayUsagePlan#api_stages}

---

description^Optional

public readonly description: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_usage_plan#description ApiGatewayUsagePlan#description}.

---

id^Optional

public readonly id: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_usage_plan#id ApiGatewayUsagePlan#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

---

productCode^Optional

public readonly productCode: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_usage_plan#product_code ApiGatewayUsagePlan#product_code}.

---

quotaSettings^Optional

public readonly quotaSettings: ApiGatewayUsagePlanQuotaSettings;

• Type: ApiGatewayUsagePlanQuotaSettings

quota_settings block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_usage_plan#quota_settings ApiGatewayUsagePlan#quota_settings}

---

tags^Optional

public readonly tags: {[ key: string ]: string};

• Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_usage_plan#tags ApiGatewayUsagePlan#tags}.

---

tagsAll^Optional

public readonly tagsAll: {[ key: string ]: string};

• Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_usage_plan#tags_all ApiGatewayUsagePlan#tags_all}.

---

throttleSettings^Optional

public readonly throttleSettings: ApiGatewayUsagePlanThrottleSettings;

• Type: ApiGatewayUsagePlanThrottleSettings

throttle_settings block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_usage_plan#throttle_settings ApiGatewayUsagePlan#throttle_settings}

---

ApiGatewayUsagePlanQuotaSettings

Initializer

import { apiGatewayUsagePlan } from '@cdktf/aws-cdk'

const apiGatewayUsagePlanQuotaSettings: apiGatewayUsagePlan.ApiGatewayUsagePlanQuotaSettings = { ... }

Properties

Name	Type	Description
limit	number	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_usage_plan#limit ApiGatewayUsagePlan#limit}.
period	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_usage_plan#period ApiGatewayUsagePlan#period}.
offset	number	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_usage_plan#offset ApiGatewayUsagePlan#offset}.

---

limit^Required

public readonly limit: number;

• Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_usage_plan#limit ApiGatewayUsagePlan#limit}.

---

period^Required

public readonly period: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_usage_plan#period ApiGatewayUsagePlan#period}.

---

offset^Optional

public readonly offset: number;

• Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_usage_plan#offset ApiGatewayUsagePlan#offset}.

---

ApiGatewayUsagePlanThrottleSettings

Initializer

import { apiGatewayUsagePlan } from '@cdktf/aws-cdk'

const apiGatewayUsagePlanThrottleSettings: apiGatewayUsagePlan.ApiGatewayUsagePlanThrottleSettings = { ... }

Properties

Name	Type	Description
burstLimit	number	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_usage_plan#burst_limit ApiGatewayUsagePlan#burst_limit}.
rateLimit	number	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_usage_plan#rate_limit ApiGatewayUsagePlan#rate_limit}.

---

burstLimit^Optional

public readonly burstLimit: number;

• Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_usage_plan#burst_limit ApiGatewayUsagePlan#burst_limit}.

---

rateLimit^Optional

public readonly rateLimit: number;

• Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_usage_plan#rate_limit ApiGatewayUsagePlan#rate_limit}.

---

Classes

ApiGatewayUsagePlanApiStagesList

Initializers

import { apiGatewayUsagePlan } from '@cdktf/aws-cdk'

new apiGatewayUsagePlan.ApiGatewayUsagePlanApiStagesList(terraformResource: IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean)

Name	Type	Description
terraformResource	cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.
wrapsSet	boolean	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

wrapsSet^Required

• Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

Methods

Name	Description
allWithMapKey	Creating an iterator for this complex list.
computeFqn	No description.
resolve	Produce the Token's value at resolution time.
toString	Return a string representation of this resolvable object.
get	No description.

---

allWithMapKey

public allWithMapKey(mapKeyAttributeName: string): DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

mapKeyAttributeName^Required

• Type: string

---

computeFqn

public computeFqn(): string

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

get

public get(index: number): ApiGatewayUsagePlanApiStagesOutputReference

index^Required

• Type: number

the index of the item to return.

---

Properties

Name	Type	Description
creationStack	string[]	The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn	string	No description.
internalValue	cdktf.IResolvable | ApiGatewayUsagePlanApiStages[]	No description.

---

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

---

fqn^Required

public readonly fqn: string;

• Type: string

---

internalValue^Optional

public readonly internalValue: IResolvable | ApiGatewayUsagePlanApiStages[];

• Type: cdktf.IResolvable | ApiGatewayUsagePlanApiStages[]

---

ApiGatewayUsagePlanApiStagesOutputReference

Initializers

import { apiGatewayUsagePlan } from '@cdktf/aws-cdk'

new apiGatewayUsagePlan.ApiGatewayUsagePlanApiStagesOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean)

Name	Type	Description
terraformResource	cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.
complexObjectIndex	number	the index of this item in the list.
complexObjectIsFromSet	boolean	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

complexObjectIndex^Required

• Type: number

the index of this item in the list.

---

complexObjectIsFromSet^Required

• Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

Methods

Name	Description
computeFqn	No description.
getAnyMapAttribute	No description.
getBooleanAttribute	No description.
getBooleanMapAttribute	No description.
getListAttribute	No description.
getNumberAttribute	No description.
getNumberListAttribute	No description.
getNumberMapAttribute	No description.
getStringAttribute	No description.
getStringMapAttribute	No description.
interpolationForAttribute	No description.
resolve	Produce the Token's value at resolution time.
toString	Return a string representation of this resolvable object.
putThrottle	No description.
resetThrottle	No description.

---

computeFqn

public computeFqn(): string

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(property: string): IResolvable

property^Required

• Type: string

---

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

putThrottle

public putThrottle(value: IResolvable | ApiGatewayUsagePlanApiStagesThrottle[]): void

value^Required

• Type: cdktf.IResolvable | ApiGatewayUsagePlanApiStagesThrottle[]

---

resetThrottle

public resetThrottle(): void

Properties

Name	Type	Description
creationStack	string[]	The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn	string	No description.
throttle	ApiGatewayUsagePlanApiStagesThrottleList	No description.
apiIdInput	string	No description.
stageInput	string	No description.
throttleInput	cdktf.IResolvable | ApiGatewayUsagePlanApiStagesThrottle[]	No description.
apiId	string	No description.
stage	string	No description.
internalValue	cdktf.IResolvable | ApiGatewayUsagePlanApiStages	No description.

---

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

---

fqn^Required

public readonly fqn: string;

• Type: string

---

throttle^Required

public readonly throttle: ApiGatewayUsagePlanApiStagesThrottleList;

• Type: ApiGatewayUsagePlanApiStagesThrottleList

---

apiIdInput^Optional

public readonly apiIdInput: string;

• Type: string

---

stageInput^Optional

public readonly stageInput: string;

• Type: string

---

throttleInput^Optional

public readonly throttleInput: IResolvable | ApiGatewayUsagePlanApiStagesThrottle[];

• Type: cdktf.IResolvable | ApiGatewayUsagePlanApiStagesThrottle[]

---

apiId^Required

public readonly apiId: string;

• Type: string

---

stage^Required

public readonly stage: string;

• Type: string

---

internalValue^Optional

public readonly internalValue: IResolvable | ApiGatewayUsagePlanApiStages;

• Type: cdktf.IResolvable | ApiGatewayUsagePlanApiStages

---

ApiGatewayUsagePlanApiStagesThrottleList

Initializers

import { apiGatewayUsagePlan } from '@cdktf/aws-cdk'

new apiGatewayUsagePlan.ApiGatewayUsagePlanApiStagesThrottleList(terraformResource: IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean)

Name	Type	Description
terraformResource	cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.
wrapsSet	boolean	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

wrapsSet^Required

• Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

Methods

Name	Description
allWithMapKey	Creating an iterator for this complex list.
computeFqn	No description.
resolve	Produce the Token's value at resolution time.
toString	Return a string representation of this resolvable object.
get	No description.

---

allWithMapKey

public allWithMapKey(mapKeyAttributeName: string): DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

mapKeyAttributeName^Required

• Type: string

---

computeFqn

public computeFqn(): string

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

get

public get(index: number): ApiGatewayUsagePlanApiStagesThrottleOutputReference

index^Required

• Type: number

the index of the item to return.

---

Properties

Name	Type	Description
creationStack	string[]	The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn	string	No description.
internalValue	cdktf.IResolvable | ApiGatewayUsagePlanApiStagesThrottle[]	No description.

---

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

---

fqn^Required

public readonly fqn: string;

• Type: string

---

internalValue^Optional

public readonly internalValue: IResolvable | ApiGatewayUsagePlanApiStagesThrottle[];

• Type: cdktf.IResolvable | ApiGatewayUsagePlanApiStagesThrottle[]

---

ApiGatewayUsagePlanApiStagesThrottleOutputReference

Initializers

import { apiGatewayUsagePlan } from '@cdktf/aws-cdk'

new apiGatewayUsagePlan.ApiGatewayUsagePlanApiStagesThrottleOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean)

Name	Type	Description
terraformResource	cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.
complexObjectIndex	number	the index of this item in the list.
complexObjectIsFromSet	boolean	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

complexObjectIndex^Required

• Type: number

the index of this item in the list.

---

complexObjectIsFromSet^Required

• Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

Methods

Name	Description
computeFqn	No description.
getAnyMapAttribute	No description.
getBooleanAttribute	No description.
getBooleanMapAttribute	No description.
getListAttribute	No description.
getNumberAttribute	No description.
getNumberListAttribute	No description.
getNumberMapAttribute	No description.
getStringAttribute	No description.
getStringMapAttribute	No description.
interpolationForAttribute	No description.
resolve	Produce the Token's value at resolution time.
toString	Return a string representation of this resolvable object.
resetBurstLimit	No description.
resetRateLimit	No description.

---

computeFqn

public computeFqn(): string

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(property: string): IResolvable

property^Required

• Type: string

---

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetBurstLimit

public resetBurstLimit(): void

resetRateLimit

public resetRateLimit(): void

Properties

Name	Type	Description
creationStack	string[]	The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn	string	No description.
burstLimitInput	number	No description.
pathInput	string	No description.
rateLimitInput	number	No description.
burstLimit	number	No description.
path	string	No description.
rateLimit	number	No description.
internalValue	cdktf.IResolvable | ApiGatewayUsagePlanApiStagesThrottle	No description.

---

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

---

fqn^Required

public readonly fqn: string;

• Type: string

---

burstLimitInput^Optional

public readonly burstLimitInput: number;

• Type: number

---

pathInput^Optional

public readonly pathInput: string;

• Type: string

---

rateLimitInput^Optional

public readonly rateLimitInput: number;

• Type: number

---

burstLimit^Required

public readonly burstLimit: number;

• Type: number

---

path^Required

public readonly path: string;

• Type: string

---

rateLimit^Required

public readonly rateLimit: number;

• Type: number

---

internalValue^Optional

public readonly internalValue: IResolvable | ApiGatewayUsagePlanApiStagesThrottle;

• Type: cdktf.IResolvable | ApiGatewayUsagePlanApiStagesThrottle

---

ApiGatewayUsagePlanQuotaSettingsOutputReference

Initializers

import { apiGatewayUsagePlan } from '@cdktf/aws-cdk'

new apiGatewayUsagePlan.ApiGatewayUsagePlanQuotaSettingsOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
terraformResource	cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

Methods

Name	Description
computeFqn	No description.
getAnyMapAttribute	No description.
getBooleanAttribute	No description.
getBooleanMapAttribute	No description.
getListAttribute	No description.
getNumberAttribute	No description.
getNumberListAttribute	No description.
getNumberMapAttribute	No description.
getStringAttribute	No description.
getStringMapAttribute	No description.
interpolationForAttribute	No description.
resolve	Produce the Token's value at resolution time.
toString	Return a string representation of this resolvable object.
resetOffset	No description.

---

computeFqn

public computeFqn(): string

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(property: string): IResolvable

property^Required

• Type: string

---

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetOffset

public resetOffset(): void

Properties

Name	Type	Description
creationStack	string[]	The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn	string	No description.
limitInput	number	No description.
offsetInput	number	No description.
periodInput	string	No description.
limit	number	No description.
offset	number	No description.
period	string	No description.
internalValue	ApiGatewayUsagePlanQuotaSettings	No description.

---

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

---

fqn^Required

public readonly fqn: string;

• Type: string

---

limitInput^Optional

public readonly limitInput: number;

• Type: number

---

offsetInput^Optional

public readonly offsetInput: number;

• Type: number

---

periodInput^Optional

public readonly periodInput: string;

• Type: string

---

limit^Required

public readonly limit: number;

• Type: number

---

offset^Required

public readonly offset: number;

• Type: number

---

period^Required

public readonly period: string;

• Type: string

---

internalValue^Optional

public readonly internalValue: ApiGatewayUsagePlanQuotaSettings;

• Type: ApiGatewayUsagePlanQuotaSettings

---

ApiGatewayUsagePlanThrottleSettingsOutputReference

Initializers

import { apiGatewayUsagePlan } from '@cdktf/aws-cdk'

new apiGatewayUsagePlan.ApiGatewayUsagePlanThrottleSettingsOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
terraformResource	cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

Methods

Name	Description
computeFqn	No description.
getAnyMapAttribute	No description.
getBooleanAttribute	No description.
getBooleanMapAttribute	No description.
getListAttribute	No description.
getNumberAttribute	No description.
getNumberListAttribute	No description.
getNumberMapAttribute	No description.
getStringAttribute	No description.
getStringMapAttribute	No description.
interpolationForAttribute	No description.
resolve	Produce the Token's value at resolution time.
toString	Return a string representation of this resolvable object.
resetBurstLimit	No description.
resetRateLimit	No description.

---

computeFqn

public computeFqn(): string

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(property: string): IResolvable

property^Required

• Type: string

---

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetBurstLimit

public resetBurstLimit(): void

resetRateLimit

public resetRateLimit(): void

Properties

Name	Type	Description
creationStack	string[]	The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn	string	No description.
burstLimitInput	number	No description.
rateLimitInput	number	No description.
burstLimit	number	No description.
rateLimit	number	No description.
internalValue	ApiGatewayUsagePlanThrottleSettings	No description.

---

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

---

fqn^Required

public readonly fqn: string;

• Type: string

---

burstLimitInput^Optional

public readonly burstLimitInput: number;

• Type: number

---

rateLimitInput^Optional

public readonly rateLimitInput: number;

• Type: number

---

burstLimit^Required

public readonly burstLimit: number;

• Type: number

---

rateLimit^Required

public readonly rateLimit: number;

• Type: number

---

internalValue^Optional

public readonly internalValue: ApiGatewayUsagePlanThrottleSettings;

• Type: ApiGatewayUsagePlanThrottleSettings

---