`wafRateBasedRule` Submodule

Constructs

WafRateBasedRule

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/waf_rate_based_rule aws_waf_rate_based_rule}.

Initializers

from cdktn_provider_aws import waf_rate_based_rule

wafRateBasedRule.WafRateBasedRule(
  scope: Construct,
  id: str,
  connection: SSHProvisionerConnection | WinrmProvisionerConnection = None,
  count: typing.Union[int, float] | TerraformCount = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner] = None,
  metric_name: str,
  name: str,
  rate_key: str,
  rate_limit: typing.Union[int, float],
  id: str = None,
  predicates: IResolvable | typing.List[WafRateBasedRulePredicates] = None,
  tags: typing.Mapping[str] = None,
  tags_all: typing.Mapping[str] = None
)

Name	Type	Description
`scope`	`constructs.Construct`	The scope in which to define this construct.
`id`	`str`	The scoped construct ID.
`connection`	`cdktn.SSHProvisionerConnection \| cdktn.WinrmProvisionerConnection`	No description.
`count`	`typing.Union[int, float] \| cdktn.TerraformCount`	No description.
`depends_on`	`typing.List[cdktn.ITerraformDependable]`	No description.
`for_each`	`cdktn.ITerraformIterator`	No description.
`lifecycle`	`cdktn.TerraformResourceLifecycle`	No description.
`provider`	`cdktn.TerraformProvider`	No description.
`provisioners`	`typing.List[cdktn.FileProvisioner \| cdktn.LocalExecProvisioner \| cdktn.RemoteExecProvisioner]`	No description.
`metric_name`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/waf_rate_based_rule#metric_name WafRateBasedRule#metric_name}.
`name`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/waf_rate_based_rule#name WafRateBasedRule#name}.
`rate_key`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/waf_rate_based_rule#rate_key WafRateBasedRule#rate_key}.
`rate_limit`	`typing.Union[int, float]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/waf_rate_based_rule#rate_limit WafRateBasedRule#rate_limit}.
`id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/waf_rate_based_rule#id WafRateBasedRule#id}.
`predicates`	`cdktn.IResolvable \| typing.List[WafRateBasedRulePredicates]`	predicates block.
`tags`	`typing.Mapping[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/waf_rate_based_rule#tags WafRateBasedRule#tags}.
`tags_all`	`typing.Mapping[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/waf_rate_based_rule#tags_all WafRateBasedRule#tags_all}.

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`id`^Required

Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

`connection`^Optional

Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection

`count`^Optional

Type: typing.Union[int, float] | cdktn.TerraformCount

`depends_on`^Optional

Type: typing.List[cdktn.ITerraformDependable]

`for_each`^Optional

Type: cdktn.ITerraformIterator

`lifecycle`^Optional

Type: cdktn.TerraformResourceLifecycle

`provider`^Optional

Type: cdktn.TerraformProvider

`provisioners`^Optional

Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]

`metric_name`^Required

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/waf_rate_based_rule#metric_name WafRateBasedRule#metric_name}.

`name`^Required

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/waf_rate_based_rule#name WafRateBasedRule#name}.

`rate_key`^Required

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/waf_rate_based_rule#rate_key WafRateBasedRule#rate_key}.

`rate_limit`^Required

Type: typing.Union[int, float]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/waf_rate_based_rule#rate_limit WafRateBasedRule#rate_limit}.

`id`^Optional

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/waf_rate_based_rule#id WafRateBasedRule#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.

`predicates`^Optional

Type: cdktn.IResolvable | typing.List[WafRateBasedRulePredicates]

predicates block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/waf_rate_based_rule#predicates WafRateBasedRule#predicates}

`tags`^Optional

Type: typing.Mapping[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/waf_rate_based_rule#tags WafRateBasedRule#tags}.

`tags_all`^Optional

Type: typing.Mapping[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/waf_rate_based_rule#tags_all WafRateBasedRule#tags_all}.

Methods

Name	Description
`to_string`	Returns a string representation of this construct.
`with`	Applies one or more mixins to this construct.
`add_override`	No description.
`override_logical_id`	Overrides the auto-generated logical ID with a specific ID.
`reset_override_logical_id`	Resets a previously passed logical Id to use the auto-generated logical id again.
`to_hcl_terraform`	No description.
`to_metadata`	No description.
`to_terraform`	Adds this resource to the terraform JSON output.
`add_move_target`	Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
`get_any_map_attribute`	No description.
`get_boolean_attribute`	No description.
`get_boolean_map_attribute`	No description.
`get_list_attribute`	No description.
`get_number_attribute`	No description.
`get_number_list_attribute`	No description.
`get_number_map_attribute`	No description.
`get_string_attribute`	No description.
`get_string_map_attribute`	No description.
`has_resource_move`	No description.
`import_from`	No description.
`interpolation_for_attribute`	No description.
`move_from_id`	Move the resource corresponding to "id" to this resource.
`move_to`	Moves this resource to the target resource given by moveTarget.
`move_to_id`	Moves this resource to the resource corresponding to "id".
`put_predicates`	No description.
`reset_id`	No description.
`reset_predicates`	No description.
`reset_tags`	No description.
`reset_tags_all`	No description.

`to_string`

def to_string() -> str

Returns a string representation of this construct.

`with`

def with(
  mixins: *IMixin
) -> IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

`mixins`^Required

Type: *constructs.IMixin

The mixins to apply.

`add_override`

def add_override(
  path: str,
  value: typing.Any
) -> None

`path`^Required

Type: str

`value`^Required

Type: typing.Any

`override_logical_id`

def override_logical_id(
  new_logical_id: str
) -> None

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

`new_logical_id`^Required

Type: str

The new logical ID to use for this stack element.

`reset_override_logical_id`

def reset_override_logical_id() -> None

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

`to_hcl_terraform`

def to_hcl_terraform() -> typing.Any

`to_metadata`

def to_metadata() -> typing.Any

`to_terraform`

def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

`add_move_target`

def add_move_target(
  move_target: str
) -> None

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

`move_target`^Required

Type: str

The string move target that will correspond to this resource.

`get_any_map_attribute`

def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]

`terraform_attribute`^Required

Type: str

`get_boolean_attribute`

def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`get_boolean_map_attribute`

def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]

`terraform_attribute`^Required

Type: str

`get_list_attribute`

def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]

`terraform_attribute`^Required

Type: str

`get_number_attribute`

def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]

`terraform_attribute`^Required

Type: str

`get_number_list_attribute`

def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_number_map_attribute`

def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_string_attribute`

def get_string_attribute(
  terraform_attribute: str
) -> str

`terraform_attribute`^Required

Type: str

`get_string_map_attribute`

def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]

`terraform_attribute`^Required

Type: str

`has_resource_move`

def has_resource_move() -> TerraformResourceMoveByTarget | TerraformResourceMoveById

`import_from`

def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None

`id`^Required

Type: str

`provider`^Optional

Type: cdktn.TerraformProvider

`interpolation_for_attribute`

def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`move_from_id`

def move_from_id(
  id: str
) -> None

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: str

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

`move_to`

def move_to(
  move_target: str,
  index: str | typing.Union[int, float] = None
) -> None

Moves this resource to the target resource given by moveTarget.

`move_target`^Required

Type: str

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

`index`^Optional

Type: str | typing.Union[int, float]

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

`move_to_id`

def move_to_id(
  id: str
) -> None

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

`id`^Required

Type: str

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

`put_predicates`

def put_predicates(
  value: IResolvable | typing.List[WafRateBasedRulePredicates]
) -> None

`value`^Required

Type: cdktn.IResolvable | typing.List[WafRateBasedRulePredicates]

`reset_id`

def reset_id() -> None

`reset_predicates`

def reset_predicates() -> None

`reset_tags`

def reset_tags() -> None

`reset_tags_all`

def reset_tags_all() -> None

Static Functions

Name	Description
`is_construct`	Checks if `x` is a construct.
`is_terraform_element`	No description.
`is_terraform_resource`	No description.
`generate_config_for_import`	Generates CDKTN code for importing a WafRateBasedRule resource upon running "cdktn plan ".

`is_construct`

from cdktn_provider_aws import waf_rate_based_rule

wafRateBasedRule.WafRateBasedRule.is_construct(
  x: typing.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: typing.Any

Any object.

`is_terraform_element`

from cdktn_provider_aws import waf_rate_based_rule

wafRateBasedRule.WafRateBasedRule.is_terraform_element(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`is_terraform_resource`

from cdktn_provider_aws import waf_rate_based_rule

wafRateBasedRule.WafRateBasedRule.is_terraform_resource(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`generate_config_for_import`

from cdktn_provider_aws import waf_rate_based_rule

wafRateBasedRule.WafRateBasedRule.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

Generates CDKTN code for importing a WafRateBasedRule resource upon running "cdktn plan ".

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`import_to_id`^Required

Type: str

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

`import_from_id`^Required

Type: str

The id of the existing WafRateBasedRule that should be imported.

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

`provider`^Optional

Type: cdktn.TerraformProvider

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

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`cdktf_stack`	`cdktn.TerraformStack`	No description.
`fqn`	`str`	No description.
`friendly_unique_id`	`str`	No description.
`terraform_meta_arguments`	`typing.Mapping[typing.Any]`	No description.
`terraform_resource_type`	`str`	No description.
`terraform_generator_metadata`	`cdktn.TerraformProviderGeneratorMetadata`	No description.
`connection`	`cdktn.SSHProvisionerConnection \| cdktn.WinrmProvisionerConnection`	No description.
`count`	`typing.Union[int, float] \| cdktn.TerraformCount`	No description.
`depends_on`	`typing.List[str]`	No description.
`for_each`	`cdktn.ITerraformIterator`	No description.
`lifecycle`	`cdktn.TerraformResourceLifecycle`	No description.
`provider`	`cdktn.TerraformProvider`	No description.
`provisioners`	`typing.List[cdktn.FileProvisioner \| cdktn.LocalExecProvisioner \| cdktn.RemoteExecProvisioner]`	No description.
`arn`	`str`	No description.
`predicates`	`WafRateBasedRulePredicatesList`	No description.
`id_input`	`str`	No description.
`metric_name_input`	`str`	No description.
`name_input`	`str`	No description.
`predicates_input`	`cdktn.IResolvable \| typing.List[WafRateBasedRulePredicates]`	No description.
`rate_key_input`	`str`	No description.
`rate_limit_input`	`typing.Union[int, float]`	No description.
`tags_all_input`	`typing.Mapping[str]`	No description.
`tags_input`	`typing.Mapping[str]`	No description.
`id`	`str`	No description.
`metric_name`	`str`	No description.
`name`	`str`	No description.
`rate_key`	`str`	No description.
`rate_limit`	`typing.Union[int, float]`	No description.
`tags`	`typing.Mapping[str]`	No description.
`tags_all`	`typing.Mapping[str]`	No description.

`node`^Required

node: Node

Type: constructs.Node

The tree node.

`cdktf_stack`^Required

cdktf_stack: TerraformStack

Type: cdktn.TerraformStack

`fqn`^Required

fqn: str

Type: str

`friendly_unique_id`^Required

friendly_unique_id: str

Type: str

`terraform_meta_arguments`^Required

terraform_meta_arguments: typing.Mapping[typing.Any]

Type: typing.Mapping[typing.Any]

`terraform_resource_type`^Required

terraform_resource_type: str

Type: str

`terraform_generator_metadata`^Optional

terraform_generator_metadata: TerraformProviderGeneratorMetadata

Type: cdktn.TerraformProviderGeneratorMetadata

`connection`^Optional

connection: SSHProvisionerConnection | WinrmProvisionerConnection

Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection

`count`^Optional

count: typing.Union[int, float] | TerraformCount

Type: typing.Union[int, float] | cdktn.TerraformCount

`depends_on`^Optional

depends_on: typing.List[str]

Type: typing.List[str]

`for_each`^Optional

for_each: ITerraformIterator

Type: cdktn.ITerraformIterator

`lifecycle`^Optional

lifecycle: TerraformResourceLifecycle

Type: cdktn.TerraformResourceLifecycle

`provider`^Optional

provider: TerraformProvider

Type: cdktn.TerraformProvider

`provisioners`^Optional

provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner]

Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]

`arn`^Required

arn: str

Type: str

`predicates`^Required

predicates: WafRateBasedRulePredicatesList

Type: WafRateBasedRulePredicatesList

`id_input`^Optional

id_input: str

Type: str

`metric_name_input`^Optional

metric_name_input: str

Type: str

`name_input`^Optional

name_input: str

Type: str

`predicates_input`^Optional

predicates_input: IResolvable | typing.List[WafRateBasedRulePredicates]

Type: cdktn.IResolvable | typing.List[WafRateBasedRulePredicates]

`rate_key_input`^Optional

rate_key_input: str

Type: str

`rate_limit_input`^Optional

rate_limit_input: typing.Union[int, float]

Type: typing.Union[int, float]

`tags_all_input`^Optional

tags_all_input: typing.Mapping[str]

Type: typing.Mapping[str]

`tags_input`^Optional

tags_input: typing.Mapping[str]

Type: typing.Mapping[str]

`id`^Required

id: str

Type: str

`metric_name`^Required

metric_name: str

Type: str

`name`^Required

name: str

Type: str

`rate_key`^Required

rate_key: str

Type: str

`rate_limit`^Required

rate_limit: typing.Union[int, float]

Type: typing.Union[int, float]

`tags`^Required

tags: typing.Mapping[str]

Type: typing.Mapping[str]

`tags_all`^Required

tags_all: typing.Mapping[str]

Type: typing.Mapping[str]

Constants

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

`tfResourceType`^Required

tfResourceType: str

Type: str

Structs

WafRateBasedRuleConfig

Initializer

from cdktn_provider_aws import waf_rate_based_rule

wafRateBasedRule.WafRateBasedRuleConfig(
  connection: SSHProvisionerConnection | WinrmProvisionerConnection = None,
  count: typing.Union[int, float] | TerraformCount = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner] = None,
  metric_name: str,
  name: str,
  rate_key: str,
  rate_limit: typing.Union[int, float],
  id: str = None,
  predicates: IResolvable | typing.List[WafRateBasedRulePredicates] = None,
  tags: typing.Mapping[str] = None,
  tags_all: typing.Mapping[str] = None
)

Properties

Name	Type	Description
`connection`	`cdktn.SSHProvisionerConnection \| cdktn.WinrmProvisionerConnection`	No description.
`count`	`typing.Union[int, float] \| cdktn.TerraformCount`	No description.
`depends_on`	`typing.List[cdktn.ITerraformDependable]`	No description.
`for_each`	`cdktn.ITerraformIterator`	No description.
`lifecycle`	`cdktn.TerraformResourceLifecycle`	No description.
`provider`	`cdktn.TerraformProvider`	No description.
`provisioners`	`typing.List[cdktn.FileProvisioner \| cdktn.LocalExecProvisioner \| cdktn.RemoteExecProvisioner]`	No description.
`metric_name`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/waf_rate_based_rule#metric_name WafRateBasedRule#metric_name}.
`name`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/waf_rate_based_rule#name WafRateBasedRule#name}.
`rate_key`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/waf_rate_based_rule#rate_key WafRateBasedRule#rate_key}.
`rate_limit`	`typing.Union[int, float]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/waf_rate_based_rule#rate_limit WafRateBasedRule#rate_limit}.
`id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/waf_rate_based_rule#id WafRateBasedRule#id}.
`predicates`	`cdktn.IResolvable \| typing.List[WafRateBasedRulePredicates]`	predicates block.
`tags`	`typing.Mapping[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/waf_rate_based_rule#tags WafRateBasedRule#tags}.
`tags_all`	`typing.Mapping[str]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/waf_rate_based_rule#tags_all WafRateBasedRule#tags_all}.

`connection`^Optional

connection: SSHProvisionerConnection | WinrmProvisionerConnection

Type: cdktn.SSHProvisionerConnection | cdktn.WinrmProvisionerConnection

`count`^Optional

count: typing.Union[int, float] | TerraformCount

Type: typing.Union[int, float] | cdktn.TerraformCount

`depends_on`^Optional

depends_on: typing.List[ITerraformDependable]

Type: typing.List[cdktn.ITerraformDependable]

`for_each`^Optional

for_each: ITerraformIterator

Type: cdktn.ITerraformIterator

`lifecycle`^Optional

lifecycle: TerraformResourceLifecycle

Type: cdktn.TerraformResourceLifecycle

`provider`^Optional

provider: TerraformProvider

Type: cdktn.TerraformProvider

`provisioners`^Optional

provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner]

Type: typing.List[cdktn.FileProvisioner | cdktn.LocalExecProvisioner | cdktn.RemoteExecProvisioner]

`metric_name`^Required

metric_name: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/waf_rate_based_rule#metric_name WafRateBasedRule#metric_name}.

`name`^Required

name: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/waf_rate_based_rule#name WafRateBasedRule#name}.

`rate_key`^Required

rate_key: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/waf_rate_based_rule#rate_key WafRateBasedRule#rate_key}.

`rate_limit`^Required

rate_limit: typing.Union[int, float]

Type: typing.Union[int, float]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/waf_rate_based_rule#rate_limit WafRateBasedRule#rate_limit}.

`id`^Optional

id: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/waf_rate_based_rule#id WafRateBasedRule#id}.

`predicates`^Optional

predicates: IResolvable | typing.List[WafRateBasedRulePredicates]

Type: cdktn.IResolvable | typing.List[WafRateBasedRulePredicates]

predicates block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/waf_rate_based_rule#predicates WafRateBasedRule#predicates}

`tags`^Optional

tags: typing.Mapping[str]

Type: typing.Mapping[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/waf_rate_based_rule#tags WafRateBasedRule#tags}.

`tags_all`^Optional

tags_all: typing.Mapping[str]

Type: typing.Mapping[str]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/waf_rate_based_rule#tags_all WafRateBasedRule#tags_all}.

WafRateBasedRulePredicates

Initializer

from cdktn_provider_aws import waf_rate_based_rule

wafRateBasedRule.WafRateBasedRulePredicates(
  data_id: str,
  negated: bool | IResolvable,
  type: str
)

Properties

Name	Type	Description
`data_id`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/waf_rate_based_rule#data_id WafRateBasedRule#data_id}.
`negated`	`bool \| cdktn.IResolvable`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/waf_rate_based_rule#negated WafRateBasedRule#negated}.
`type`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/waf_rate_based_rule#type WafRateBasedRule#type}.

`data_id`^Required

data_id: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/waf_rate_based_rule#data_id WafRateBasedRule#data_id}.

`negated`^Required

negated: bool | IResolvable

Type: bool | cdktn.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/waf_rate_based_rule#negated WafRateBasedRule#negated}.

`type`^Required

type: str

Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.50.0/docs/resources/waf_rate_based_rule#type WafRateBasedRule#type}.

Classes

WafRateBasedRulePredicatesList

Initializers

from cdktn_provider_aws import waf_rate_based_rule

wafRateBasedRule.WafRateBasedRulePredicatesList(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  wraps_set: bool
)

Name	Type	Description
`terraform_resource`	`cdktn.IInterpolatingParent`	The parent resource.
`terraform_attribute`	`str`	The attribute on the parent resource this class is referencing.
`wraps_set`	`bool`	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

`terraform_resource`^Required

Type: cdktn.IInterpolatingParent

The parent resource.

`terraform_attribute`^Required

Type: str

The attribute on the parent resource this class is referencing.

`wraps_set`^Required

Type: bool

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

Methods

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

`all_with_map_key`

def all_with_map_key(
  map_key_attribute_name: str
) -> DynamicListTerraformIterator

Creating an iterator for this complex list.

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

`map_key_attribute_name`^Required

Type: str

`compute_fqn`

def compute_fqn() -> str

`resolve`

def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktn.IResolveContext

`to_string`

def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

`get`

def get(
  index: typing.Union[int, float]
) -> WafRateBasedRulePredicatesOutputReference

`index`^Required

Type: typing.Union[int, float]

the index of the item to return.

Properties

Name	Type	Description
`creation_stack`	`typing.List[str]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`str`	No description.
`internal_value`	`cdktn.IResolvable \| typing.List[WafRateBasedRulePredicates]`	No description.

`creation_stack`^Required

creation_stack: typing.List[str]

Type: typing.List[str]

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

fqn: str

Type: str

`internal_value`^Optional

internal_value: IResolvable | typing.List[WafRateBasedRulePredicates]

Type: cdktn.IResolvable | typing.List[WafRateBasedRulePredicates]

WafRateBasedRulePredicatesOutputReference

Initializers

from cdktn_provider_aws import waf_rate_based_rule

wafRateBasedRule.WafRateBasedRulePredicatesOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  complex_object_index: typing.Union[int, float],
  complex_object_is_from_set: bool
)

Name	Type	Description
`terraform_resource`	`cdktn.IInterpolatingParent`	The parent resource.
`terraform_attribute`	`str`	The attribute on the parent resource this class is referencing.
`complex_object_index`	`typing.Union[int, float]`	the index of this item in the list.
`complex_object_is_from_set`	`bool`	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

`terraform_resource`^Required

Type: cdktn.IInterpolatingParent

The parent resource.

`terraform_attribute`^Required

Type: str

The attribute on the parent resource this class is referencing.

`complex_object_index`^Required

Type: typing.Union[int, float]

the index of this item in the list.

`complex_object_is_from_set`^Required

Type: bool

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

Methods

Name	Description
`compute_fqn`	No description.
`get_any_map_attribute`	No description.
`get_boolean_attribute`	No description.
`get_boolean_map_attribute`	No description.
`get_list_attribute`	No description.
`get_number_attribute`	No description.
`get_number_list_attribute`	No description.
`get_number_map_attribute`	No description.
`get_string_attribute`	No description.
`get_string_map_attribute`	No description.
`interpolation_for_attribute`	No description.
`resolve`	Produce the Token's value at resolution time.
`to_string`	Return a string representation of this resolvable object.

`compute_fqn`

def compute_fqn() -> str

`get_any_map_attribute`

def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]

`terraform_attribute`^Required

Type: str

`get_boolean_attribute`

def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`get_boolean_map_attribute`

def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]

`terraform_attribute`^Required

Type: str

`get_list_attribute`

def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]

`terraform_attribute`^Required

Type: str

`get_number_attribute`

def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]

`terraform_attribute`^Required

Type: str

`get_number_list_attribute`

def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_number_map_attribute`

def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_string_attribute`

def get_string_attribute(
  terraform_attribute: str
) -> str

`terraform_attribute`^Required

Type: str

`get_string_map_attribute`

def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]

`terraform_attribute`^Required

Type: str

`interpolation_for_attribute`

def interpolation_for_attribute(
  property: str
) -> IResolvable

`property`^Required

Type: str

`resolve`

def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktn.IResolveContext

`to_string`

def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name	Type	Description
`creation_stack`	`typing.List[str]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`str`	No description.
`data_id_input`	`str`	No description.
`negated_input`	`bool \| cdktn.IResolvable`	No description.
`type_input`	`str`	No description.
`data_id`	`str`	No description.
`negated`	`bool \| cdktn.IResolvable`	No description.
`type`	`str`	No description.
`internal_value`	`cdktn.IResolvable \| WafRateBasedRulePredicates`	No description.

`creation_stack`^Required

creation_stack: typing.List[str]

Type: typing.List[str]

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

fqn: str

Type: str

`data_id_input`^Optional

data_id_input: str

Type: str

`negated_input`^Optional

negated_input: bool | IResolvable

Type: bool | cdktn.IResolvable

`type_input`^Optional

type_input: str

Type: str

`data_id`^Required

data_id: str

Type: str

`negated`^Required

negated: bool | IResolvable

Type: bool | cdktn.IResolvable

`type`^Required

type: str

Type: str

`internal_value`^Optional

internal_value: IResolvable | WafRateBasedRulePredicates

Type: cdktn.IResolvable | WafRateBasedRulePredicates

FilesExpand file tree

wafRateBasedRule.python.md

Latest commit

History

wafRateBasedRule.python.md

File metadata and controls

wafRateBasedRule Submodule

Constructs