`rateLimit` Submodule

Constructs

RateLimit

Represents a {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/rate_limit cloudflare_rate_limit}.

Initializers

import { rateLimit } from '@cdktf/provider-cloudflare'

new rateLimit.RateLimit(scope: Construct, id: string, config: RateLimitConfig)

Name	Type	Description
`scope`	`constructs.Construct`	The scope in which to define this construct.
`id`	`string`	The scoped construct ID.
`config`	`RateLimitConfig`	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: RateLimitConfig

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".
`putAction`	No description.
`putCorrelate`	No description.
`putMatch`	No description.
`resetBypassUrlPatterns`	No description.
`resetCorrelate`	No description.
`resetDescription`	No description.
`resetDisabled`	No description.
`resetId`	No description.
`resetMatch`	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".

`putAction`

public putAction(value: RateLimitAction): void

`value`^Required

Type: RateLimitAction

`putCorrelate`

public putCorrelate(value: RateLimitCorrelate): void

`value`^Required

Type: RateLimitCorrelate

`putMatch`

public putMatch(value: RateLimitMatch): void

`value`^Required

Type: RateLimitMatch

`resetBypassUrlPatterns`

public resetBypassUrlPatterns(): void

`resetCorrelate`

public resetCorrelate(): void

`resetDescription`

public resetDescription(): void

`resetDisabled`

public resetDisabled(): void

`resetId`

public resetId(): void

`resetMatch`

public resetMatch(): 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 RateLimit resource upon running "cdktf plan ".

`isConstruct`

import { rateLimit } from '@cdktf/provider-cloudflare'

rateLimit.RateLimit.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

`x`^Required

Type: any

Any object.

`isTerraformElement`

import { rateLimit } from '@cdktf/provider-cloudflare'

rateLimit.RateLimit.isTerraformElement(x: any)

`x`^Required

Type: any

`isTerraformResource`

import { rateLimit } from '@cdktf/provider-cloudflare'

rateLimit.RateLimit.isTerraformResource(x: any)

`x`^Required

Type: any

`generateConfigForImport`

import { rateLimit } from '@cdktf/provider-cloudflare'

rateLimit.RateLimit.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a RateLimit 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 RateLimit to import.

`importFromId`^Required

Type: string

The id of the existing RateLimit that should be imported.

Refer to the {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/rate_limit#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 RateLimit 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.
`action`	`RateLimitActionOutputReference`	No description.
`correlate`	`RateLimitCorrelateOutputReference`	No description.
`match`	`RateLimitMatchOutputReference`	No description.
`actionInput`	`RateLimitAction`	No description.
`bypassUrlPatternsInput`	`string[]`	No description.
`correlateInput`	`RateLimitCorrelate`	No description.
`descriptionInput`	`string`	No description.
`disabledInput`	`boolean \| cdktf.IResolvable`	No description.
`idInput`	`string`	No description.
`matchInput`	`RateLimitMatch`	No description.
`periodInput`	`number`	No description.
`thresholdInput`	`number`	No description.
`zoneIdInput`	`string`	No description.
`bypassUrlPatterns`	`string[]`	No description.
`description`	`string`	No description.
`disabled`	`boolean \| cdktf.IResolvable`	No description.
`id`	`string`	No description.
`period`	`number`	No description.
`threshold`	`number`	No description.
`zoneId`	`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[]

`action`^Required

public readonly action: RateLimitActionOutputReference;

Type: RateLimitActionOutputReference

`correlate`^Required

public readonly correlate: RateLimitCorrelateOutputReference;

Type: RateLimitCorrelateOutputReference

`match`^Required

public readonly match: RateLimitMatchOutputReference;

Type: RateLimitMatchOutputReference

`actionInput`^Optional

public readonly actionInput: RateLimitAction;

Type: RateLimitAction

`bypassUrlPatternsInput`^Optional

public readonly bypassUrlPatternsInput: string[];

Type: string[]

`correlateInput`^Optional

public readonly correlateInput: RateLimitCorrelate;

Type: RateLimitCorrelate

`descriptionInput`^Optional

public readonly descriptionInput: string;

Type: string

`disabledInput`^Optional

public readonly disabledInput: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`idInput`^Optional

public readonly idInput: string;

Type: string

`matchInput`^Optional

public readonly matchInput: RateLimitMatch;

Type: RateLimitMatch

`periodInput`^Optional

public readonly periodInput: number;

Type: number

`thresholdInput`^Optional

public readonly thresholdInput: number;

Type: number

`zoneIdInput`^Optional

public readonly zoneIdInput: string;

Type: string

`bypassUrlPatterns`^Required

public readonly bypassUrlPatterns: string[];

Type: string[]

`description`^Required

public readonly description: string;

Type: string

`disabled`^Required

public readonly disabled: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`id`^Required

public readonly id: string;

Type: string

`period`^Required

public readonly period: number;

Type: number

`threshold`^Required

public readonly threshold: number;

Type: number

`zoneId`^Required

public readonly zoneId: string;

Type: string

Constants

Name	Type	Description
`tfResourceType`	`string`	No description.

`tfResourceType`^Required

public readonly tfResourceType: string;

Type: string

Structs

RateLimitAction

Initializer

import { rateLimit } from '@cdktf/provider-cloudflare'

const rateLimitAction: rateLimit.RateLimitAction = { ... }

Properties

Name	Type	Description
`mode`	`string`	The type of action to perform. Available values: `simulate`, `ban`, `challenge`, `js_challenge`, `managed_challenge`.
`response`	`RateLimitActionResponse`	response block.
`timeout`	`number`	The time in seconds as an integer to perform the mitigation action.

`mode`^Required

public readonly mode: string;

Type: string

The type of action to perform. Available values: simulate, ban, challenge, js_challenge, managed_challenge.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/rate_limit#mode RateLimit#mode}

`response`^Optional

public readonly response: RateLimitActionResponse;

Type: RateLimitActionResponse

response block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/rate_limit#response RateLimit#response}

`timeout`^Optional

public readonly timeout: number;

Type: number

The time in seconds as an integer to perform the mitigation action.

This field is required if the mode is either simulate or ban. Must be the same or greater than the period.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/rate_limit#timeout RateLimit#timeout}

RateLimitActionResponse

Initializer

import { rateLimit } from '@cdktf/provider-cloudflare'

const rateLimitActionResponse: rateLimit.RateLimitActionResponse = { ... }

Properties

Name	Type	Description
`body`	`string`	The body to return, the content here should conform to the `content_type`.
`contentType`	`string`	The content-type of the body. Available values: `text/plain`, `text/xml`, `application/json`.

`body`^Required

public readonly body: string;

Type: string

The body to return, the content here should conform to the content_type.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/rate_limit#body RateLimit#body}

`contentType`^Required

public readonly contentType: string;

Type: string

The content-type of the body. Available values: text/plain, text/xml, application/json.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/rate_limit#content_type RateLimit#content_type}

RateLimitConfig

Initializer

import { rateLimit } from '@cdktf/provider-cloudflare'

const rateLimitConfig: rateLimit.RateLimitConfig = { ... }

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.
`action`	`RateLimitAction`	action block.
`period`	`number`	The time in seconds to count matching traffic.
`threshold`	`number`	The threshold that triggers the rate limit mitigations, combine with period.
`zoneId`	`string`	The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource..
`bypassUrlPatterns`	`string[]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/rate_limit#bypass_url_patterns RateLimit#bypass_url_patterns}.
`correlate`	`RateLimitCorrelate`	correlate block.
`description`	`string`	A note that you can use to describe the reason for a rate limit.
`disabled`	`boolean \| cdktf.IResolvable`	Whether this ratelimit is currently disabled. Defaults to `false`.
`id`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/rate_limit#id RateLimit#id}.
`match`	`RateLimitMatch`	match 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[]

`action`^Required

public readonly action: RateLimitAction;

Type: RateLimitAction

action block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/rate_limit#action RateLimit#action}

`period`^Required

public readonly period: number;

Type: number

The time in seconds to count matching traffic.

If the count exceeds threshold within this period the action will be performed.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/rate_limit#period RateLimit#period}

`threshold`^Required

public readonly threshold: number;

Type: number

The threshold that triggers the rate limit mitigations, combine with period.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/rate_limit#threshold RateLimit#threshold}

`zoneId`^Required

public readonly zoneId: string;

Type: string

The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource..

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/rate_limit#zone_id RateLimit#zone_id}

`bypassUrlPatterns`^Optional

public readonly bypassUrlPatterns: string[];

Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/rate_limit#bypass_url_patterns RateLimit#bypass_url_patterns}.

`correlate`^Optional

public readonly correlate: RateLimitCorrelate;

Type: RateLimitCorrelate

correlate block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/rate_limit#correlate RateLimit#correlate}

`description`^Optional

public readonly description: string;

Type: string

A note that you can use to describe the reason for a rate limit.

This value is sanitized and all tags are removed.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/rate_limit#description RateLimit#description}

`disabled`^Optional

public readonly disabled: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

Whether this ratelimit is currently disabled. Defaults to false.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/rate_limit#disabled RateLimit#disabled}

`id`^Optional

public readonly id: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/rate_limit#id RateLimit#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.

`match`^Optional

public readonly match: RateLimitMatch;

Type: RateLimitMatch

match block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/rate_limit#match RateLimit#match}

RateLimitCorrelate

Initializer

import { rateLimit } from '@cdktf/provider-cloudflare'

const rateLimitCorrelate: rateLimit.RateLimitCorrelate = { ... }

Properties

Name	Type	Description
`by`	`string`	If set to 'nat', NAT support will be enabled for rate limiting. Available values: `nat`.

`by`^Optional

public readonly by: string;

Type: string

If set to 'nat', NAT support will be enabled for rate limiting. Available values: nat.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/rate_limit#by RateLimit#by}

RateLimitMatch

Initializer

import { rateLimit } from '@cdktf/provider-cloudflare'

const rateLimitMatch: rateLimit.RateLimitMatch = { ... }

Properties

Name	Type	Description
`request`	`RateLimitMatchRequest`	request block.
`response`	`RateLimitMatchResponse`	response block.

`request`^Optional

public readonly request: RateLimitMatchRequest;

Type: RateLimitMatchRequest

request block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/rate_limit#request RateLimit#request}

`response`^Optional

public readonly response: RateLimitMatchResponse;

Type: RateLimitMatchResponse

response block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/rate_limit#response RateLimit#response}

RateLimitMatchRequest

Initializer

import { rateLimit } from '@cdktf/provider-cloudflare'

const rateLimitMatchRequest: rateLimit.RateLimitMatchRequest = { ... }

Properties

Name	Type	Description
`methods`	`string[]`	HTTP Methods to match traffic on. Available values: `GET`, `POST`, `PUT`, `DELETE`, `PATCH`, `HEAD`, `_ALL_`.
`schemes`	`string[]`	HTTP schemes to match traffic on. Available values: `HTTP`, `HTTPS`, `_ALL_`.
`urlPattern`	`string`	The URL pattern to match comprised of the host and path, i.e. example.org/path. Wildcard are expanded to match applicable traffic, query strings are not matched. Use _ for all traffic to your zone.

`methods`^Optional

public readonly methods: string[];

Type: string[]

HTTP Methods to match traffic on. Available values: GET, POST, PUT, DELETE, PATCH, HEAD, _ALL_.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/rate_limit#methods RateLimit#methods}

`schemes`^Optional

public readonly schemes: string[];

Type: string[]

HTTP schemes to match traffic on. Available values: HTTP, HTTPS, _ALL_.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/rate_limit#schemes RateLimit#schemes}

`urlPattern`^Optional

public readonly urlPattern: string;

Type: string

The URL pattern to match comprised of the host and path, i.e. example.org/path. Wildcard are expanded to match applicable traffic, query strings are not matched. Use _ for all traffic to your zone.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/rate_limit#url_pattern RateLimit#url_pattern}

RateLimitMatchResponse

Initializer

import { rateLimit } from '@cdktf/provider-cloudflare'

const rateLimitMatchResponse: rateLimit.RateLimitMatchResponse = { ... }

Properties

Name	Type	Description
`headers`	`cdktf.IResolvable \| {[ key: string ]: string}[]`	List of HTTP headers maps to match the origin response on.
`originTraffic`	`boolean \| cdktf.IResolvable`	Only count traffic that has come from your origin servers.
`statuses`	`number[]`	HTTP Status codes, can be one, many or indicate all by not providing this value.

`headers`^Optional

public readonly headers: IResolvable | {[ key: string ]: string}[];

Type: cdktf.IResolvable | {[ key: string ]: string}[]

List of HTTP headers maps to match the origin response on.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/rate_limit#headers RateLimit#headers}

`originTraffic`^Optional

public readonly originTraffic: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

Only count traffic that has come from your origin servers.

If true, cached items that Cloudflare serve will not count towards rate limiting.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/rate_limit#origin_traffic RateLimit#origin_traffic}

`statuses`^Optional

public readonly statuses: number[];

Type: number[]

HTTP Status codes, can be one, many or indicate all by not providing this value.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cloudflare/cloudflare/4.34.0/docs/resources/rate_limit#statuses RateLimit#statuses}

Classes

RateLimitActionOutputReference

Initializers

import { rateLimit } from '@cdktf/provider-cloudflare'

new rateLimit.RateLimitActionOutputReference(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.
`putResponse`	No description.
`resetResponse`	No description.
`resetTimeout`	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.

`putResponse`

public putResponse(value: RateLimitActionResponse): void

`value`^Required

Type: RateLimitActionResponse

`resetResponse`

public resetResponse(): void

`resetTimeout`

public resetTimeout(): 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.
`response`	`RateLimitActionResponseOutputReference`	No description.
`modeInput`	`string`	No description.
`responseInput`	`RateLimitActionResponse`	No description.
`timeoutInput`	`number`	No description.
`mode`	`string`	No description.
`timeout`	`number`	No description.
`internalValue`	`RateLimitAction`	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

`response`^Required

public readonly response: RateLimitActionResponseOutputReference;

Type: RateLimitActionResponseOutputReference

`modeInput`^Optional

public readonly modeInput: string;

Type: string

`responseInput`^Optional

public readonly responseInput: RateLimitActionResponse;

Type: RateLimitActionResponse

`timeoutInput`^Optional

public readonly timeoutInput: number;

Type: number

`mode`^Required

public readonly mode: string;

Type: string

`timeout`^Required

public readonly timeout: number;

Type: number

`internalValue`^Optional

public readonly internalValue: RateLimitAction;

Type: RateLimitAction

RateLimitActionResponseOutputReference

Initializers

import { rateLimit } from '@cdktf/provider-cloudflare'

new rateLimit.RateLimitActionResponseOutputReference(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.

`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.

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.
`bodyInput`	`string`	No description.
`contentTypeInput`	`string`	No description.
`body`	`string`	No description.
`contentType`	`string`	No description.
`internalValue`	`RateLimitActionResponse`	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

`bodyInput`^Optional

public readonly bodyInput: string;

Type: string

`contentTypeInput`^Optional

public readonly contentTypeInput: string;

Type: string

`body`^Required

public readonly body: string;

Type: string

`contentType`^Required

public readonly contentType: string;

Type: string

`internalValue`^Optional

public readonly internalValue: RateLimitActionResponse;

Type: RateLimitActionResponse

RateLimitCorrelateOutputReference

Initializers

import { rateLimit } from '@cdktf/provider-cloudflare'

new rateLimit.RateLimitCorrelateOutputReference(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.
`resetBy`	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.

`resetBy`

public resetBy(): 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.
`byInput`	`string`	No description.
`by`	`string`	No description.
`internalValue`	`RateLimitCorrelate`	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

`byInput`^Optional

public readonly byInput: string;

Type: string

`by`^Required

public readonly by: string;

Type: string

`internalValue`^Optional

public readonly internalValue: RateLimitCorrelate;

Type: RateLimitCorrelate

RateLimitMatchOutputReference

Initializers

import { rateLimit } from '@cdktf/provider-cloudflare'

new rateLimit.RateLimitMatchOutputReference(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.
`putRequest`	No description.
`putResponse`	No description.
`resetRequest`	No description.
`resetResponse`	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.

`putRequest`

public putRequest(value: RateLimitMatchRequest): void

`value`^Required

Type: RateLimitMatchRequest

`putResponse`

public putResponse(value: RateLimitMatchResponse): void

`value`^Required

Type: RateLimitMatchResponse

`resetRequest`

public resetRequest(): void

`resetResponse`

public resetResponse(): 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.
`request`	`RateLimitMatchRequestOutputReference`	No description.
`response`	`RateLimitMatchResponseOutputReference`	No description.
`requestInput`	`RateLimitMatchRequest`	No description.
`responseInput`	`RateLimitMatchResponse`	No description.
`internalValue`	`RateLimitMatch`	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

`request`^Required

public readonly request: RateLimitMatchRequestOutputReference;

Type: RateLimitMatchRequestOutputReference

`response`^Required

public readonly response: RateLimitMatchResponseOutputReference;

Type: RateLimitMatchResponseOutputReference

`requestInput`^Optional

public readonly requestInput: RateLimitMatchRequest;

Type: RateLimitMatchRequest

`responseInput`^Optional

public readonly responseInput: RateLimitMatchResponse;

Type: RateLimitMatchResponse

`internalValue`^Optional

public readonly internalValue: RateLimitMatch;

Type: RateLimitMatch

RateLimitMatchRequestOutputReference

Initializers

import { rateLimit } from '@cdktf/provider-cloudflare'

new rateLimit.RateLimitMatchRequestOutputReference(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.
`resetMethods`	No description.
`resetSchemes`	No description.
`resetUrlPattern`	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.

`resetMethods`

public resetMethods(): void

`resetSchemes`

public resetSchemes(): void

`resetUrlPattern`

public resetUrlPattern(): 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.
`methodsInput`	`string[]`	No description.
`schemesInput`	`string[]`	No description.
`urlPatternInput`	`string`	No description.
`methods`	`string[]`	No description.
`schemes`	`string[]`	No description.
`urlPattern`	`string`	No description.
`internalValue`	`RateLimitMatchRequest`	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

`methodsInput`^Optional

public readonly methodsInput: string[];

Type: string[]

`schemesInput`^Optional

public readonly schemesInput: string[];

Type: string[]

`urlPatternInput`^Optional

public readonly urlPatternInput: string;

Type: string

`methods`^Required

public readonly methods: string[];

Type: string[]

`schemes`^Required

public readonly schemes: string[];

Type: string[]

`urlPattern`^Required

public readonly urlPattern: string;

Type: string

`internalValue`^Optional

public readonly internalValue: RateLimitMatchRequest;

Type: RateLimitMatchRequest

RateLimitMatchResponseOutputReference

Initializers

import { rateLimit } from '@cdktf/provider-cloudflare'

new rateLimit.RateLimitMatchResponseOutputReference(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.
`resetHeaders`	No description.
`resetOriginTraffic`	No description.
`resetStatuses`	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.

`resetHeaders`

public resetHeaders(): void

`resetOriginTraffic`

public resetOriginTraffic(): void

`resetStatuses`

public resetStatuses(): 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.
`headersInput`	`cdktf.IResolvable \| {[ key: string ]: string}[]`	No description.
`originTrafficInput`	`boolean \| cdktf.IResolvable`	No description.
`statusesInput`	`number[]`	No description.
`headers`	`cdktf.IResolvable \| {[ key: string ]: string}[]`	No description.
`originTraffic`	`boolean \| cdktf.IResolvable`	No description.
`statuses`	`number[]`	No description.
`internalValue`	`RateLimitMatchResponse`	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

`headersInput`^Optional

public readonly headersInput: IResolvable | {[ key: string ]: string}[];

Type: cdktf.IResolvable | {[ key: string ]: string}[]

`originTrafficInput`^Optional

public readonly originTrafficInput: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`statusesInput`^Optional

public readonly statusesInput: number[];

Type: number[]

`headers`^Required

public readonly headers: IResolvable | {[ key: string ]: string}[];

Type: cdktf.IResolvable | {[ key: string ]: string}[]

`originTraffic`^Required

public readonly originTraffic: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`statuses`^Required

public readonly statuses: number[];

Type: number[]

`internalValue`^Optional

public readonly internalValue: RateLimitMatchResponse;

Type: RateLimitMatchResponse

Files

rateLimit.typescript.md

Latest commit

History

rateLimit.typescript.md

File metadata and controls

rateLimit Submodule

Constructs

RateLimit

Initializers

scopeRequired

idRequired

configRequired

Methods

toString

addOverride

pathRequired

valueRequired

overrideLogicalId

newLogicalIdRequired

resetOverrideLogicalId

toHclTerraform

toMetadata

toTerraform

addMoveTarget

moveTargetRequired

getAnyMapAttribute

terraformAttributeRequired

getBooleanAttribute

terraformAttributeRequired

getBooleanMapAttribute

terraformAttributeRequired

getListAttribute

terraformAttributeRequired

getNumberAttribute

terraformAttributeRequired

getNumberListAttribute

terraformAttributeRequired

getNumberMapAttribute

terraformAttributeRequired

getStringAttribute

terraformAttributeRequired

getStringMapAttribute

terraformAttributeRequired

hasResourceMove

importFrom

idRequired

providerOptional

interpolationForAttribute

terraformAttributeRequired

moveFromId

idRequired

moveTo

moveTargetRequired

indexOptional

moveToId

idRequired

putAction

valueRequired

putCorrelate

valueRequired

putMatch

valueRequired

resetBypassUrlPatterns

resetCorrelate

resetDescription

resetDisabled

resetId

resetMatch

Static Functions

isConstruct

xRequired

isTerraformElement

xRequired

isTerraformResource

xRequired

generateConfigForImport

scopeRequired

importToIdRequired

importFromIdRequired

`rateLimit` Submodule

`scope`^Required

`id`^Required

`config`^Required

`toString`

`addOverride`

`path`^Required

`value`^Required

`overrideLogicalId`

`newLogicalId`^Required

`resetOverrideLogicalId`

`toHclTerraform`

`toMetadata`

`toTerraform`

`addMoveTarget`

`moveTarget`^Required

`getAnyMapAttribute`

`terraformAttribute`^Required

`getBooleanAttribute`

`terraformAttribute`^Required

`getBooleanMapAttribute`

`terraformAttribute`^Required

`getListAttribute`

`terraformAttribute`^Required

`getNumberAttribute`

`terraformAttribute`^Required

`getNumberListAttribute`

`terraformAttribute`^Required

`getNumberMapAttribute`

`terraformAttribute`^Required

`getStringAttribute`

`terraformAttribute`^Required

`getStringMapAttribute`

`terraformAttribute`^Required

`hasResourceMove`

`importFrom`

`id`^Required

`provider`^Optional

`interpolationForAttribute`

`terraformAttribute`^Required

`moveFromId`

`id`^Required

`moveTo`

`moveTarget`^Required

`index`^Optional

`moveToId`

`id`^Required

`putAction`

`value`^Required

`putCorrelate`

`value`^Required

`putMatch`

`value`^Required

`resetBypassUrlPatterns`

`resetCorrelate`

`resetDescription`

`resetDisabled`

`resetId`

`resetMatch`

`isConstruct`

`x`^Required

`isTerraformElement`

`x`^Required

`isTerraformResource`

`x`^Required

`generateConfigForImport`

`scope`^Required

`importToId`^Required

`importFromId`^Required

`provider`^Optional

`node`^Required

`cdktfStack`^Required

`fqn`^Required

`friendlyUniqueId`^Required

`terraformMetaArguments`^Required

`terraformResourceType`^Required

`terraformGeneratorMetadata`^Optional

`connection`^Optional

`count`^Optional

`dependsOn`^Optional