yandex_sws_advanced_rate_limiter_profile (Data Source)

Get information about ARL Profile. For more information, see the official documentation.This data source is used to define ARL Profile that can be used by other resources.

Example usageExample usage

//
// Get information about existing SWS Advanced Rate Limiter Profile.
//
data "yandex_sws_advanced_rate_limiter_profile" "by-id" {
  advanced_rate_limiter_profile_id = yandex_sws_advanced_rate_limiter_profile.my-profile.id
}

data "yandex_sws_advanced_rate_limiter_profile" "by-name" {
  name = yandex_sws_advanced_rate_limiter_profile.my-profile.name
}

SchemaSchema

OptionalOptional

• advanced_rate_limiter_profile_id (String) ID of the ARL profile.
• cloud_id (String) The Cloud ID which resource belongs to. If it is not provided, the default provider cloud-id is used.
• folder_id (String) The folder identifier that resource belongs to. If it is not provided, the default provider folder-id is used.
• name (String) The resource name.

Read-OnlyRead-Only

• advanced_rate_limiter_rule (List of Object) (see below for nested schema)
• created_at (String) The creation timestamp of the resource.
• description (String) The resource description.
• id (String) The ID of this resource.
• labels (Map of String) A set of key/value label pairs which assigned to resource.

Nested Schema for Nested Schema for advanced_rate_limiter_rule

Read-Only:

• description (String) Description of the rule. 0-512 characters long.

• dry_run (Boolean) This allows you to evaluate backend capabilities and find the optimum limit values. Requests will not be blocked in this mode.

• dynamic_quota (Block List, Max: 1) Dynamic quota. Grouping requests by a certain attribute and limiting the number of groups. (see below for nested schema)

• name (String) Name of the rule. The name is unique within the ARL profile. 1-50 characters long.

• priority (Number) Determines the priority in case there are several matched rules. Enter an integer within the range of 1 and 999999. The rule priority must be unique within the entire ARL profile. A lower numeric value means a higher priority.

• static_quota (Block List, Max: 1) Static quota. Counting each request individually. (see below for nested schema)

Nested Schema for Nested Schema for advanced_rate_limiter_rule.dynamic_quota

Read-Only:

• action (String) Action in case of exceeding this quota. Possible values: DENY.

• characteristic (Block List) List of characteristics. (see below for nested schema)

• condition (Block List, Max: 1) The condition for matching the rule. You can find all possibilities of condition in gRPC specs. (see below for nested schema)

• limit (Number) Desired maximum number of requests per period.

• period (Number) Period of time in seconds.

Nested Schema for Nested Schema for advanced_rate_limiter_rule.dynamic_quota.characteristic

Read-Only:

• case_insensitive (Boolean) Determines case-sensitive or case-insensitive keys matching.

• key_characteristic (Block List, Max: 1) Characteristic based on key match in the Query params, HTTP header, and HTTP cookie attributes. See Rules for more details. (see below for nested schema)

• simple_characteristic (Block List, Max: 1) Characteristic automatically based on the Request path, HTTP method, IP address, Region, and Host attributes. See Rules for more details. (see below for nested schema)

Nested Schema for Nested Schema for advanced_rate_limiter_rule.dynamic_quota.characteristic.key_characteristic

Read-Only:

• type (String) Type of key characteristic. Possible values: COOKIE_KEY, HEADER_KEY, QUERY_KEY.

• value (String) String value of the key.

Nested Schema for Nested Schema for advanced_rate_limiter_rule.dynamic_quota.characteristic.simple_characteristic

Read-Only:

• type (String) Type of simple characteristic. Possible values: REQUEST_PATH, HTTP_METHOD, IP, GEO, HOST.

Nested Schema for Nested Schema for advanced_rate_limiter_rule.dynamic_quota.condition

Read-Only:

• authority (List of Object) (see below for nested schema)
• headers (List of Object) (see below for nested schema)
• http_method (List of Object) (see below for nested schema)
• request_uri (List of Object) (see below for nested schema)
• source_ip (List of Object) (see below for nested schema)

Nested Schema for Nested Schema for advanced_rate_limiter_rule.dynamic_quota.condition.authority

Read-Only:

• authorities (List of Object) (see below for nested schema)

Nested Schema for Nested Schema for advanced_rate_limiter_rule.dynamic_quota.condition.source_ip.authorities

Read-Only:

• exact_match (String)
• exact_not_match (String)
• pire_regex_match (String)
• pire_regex_not_match (String)
• prefix_match (String)
• prefix_not_match (String)

Nested Schema for Nested Schema for advanced_rate_limiter_rule.dynamic_quota.condition.headers

Read-Only:

• name (String)
• value (List of Object) (see below for nested schema)

Nested Schema for Nested Schema for advanced_rate_limiter_rule.dynamic_quota.condition.source_ip.value

Read-Only:

• exact_match (String)
• exact_not_match (String)
• pire_regex_match (String)
• pire_regex_not_match (String)
• prefix_match (String)
• prefix_not_match (String)

Nested Schema for Nested Schema for advanced_rate_limiter_rule.dynamic_quota.condition.http_method

Read-Only:

• http_methods (List of Object) (see below for nested schema)

Nested Schema for Nested Schema for advanced_rate_limiter_rule.dynamic_quota.condition.source_ip.http_methods

Read-Only:

• exact_match (String)
• exact_not_match (String)
• pire_regex_match (String)
• pire_regex_not_match (String)
• prefix_match (String)
• prefix_not_match (String)

Nested Schema for Nested Schema for advanced_rate_limiter_rule.dynamic_quota.condition.request_uri

Read-Only:

• path (List of Object) (see below for nested schema)
• queries (List of Object) (see below for nested schema)

Nested Schema for Nested Schema for advanced_rate_limiter_rule.dynamic_quota.condition.source_ip.path

Read-Only:

• exact_match (String)
• exact_not_match (String)
• pire_regex_match (String)
• pire_regex_not_match (String)
• prefix_match (String)
• prefix_not_match (String)

Nested Schema for Nested Schema for advanced_rate_limiter_rule.dynamic_quota.condition.source_ip.queries

Read-Only:

• key (String)
• value (List of Object) (see below for nested schema)

Nested Schema for Nested Schema for advanced_rate_limiter_rule.dynamic_quota.condition.source_ip.queries.value

Read-Only:

• exact_match (String)
• exact_not_match (String)
• pire_regex_match (String)
• pire_regex_not_match (String)
• prefix_match (String)
• prefix_not_match (String)

Nested Schema for Nested Schema for advanced_rate_limiter_rule.dynamic_quota.condition.source_ip

Read-Only:

• geo_ip_match (List of Object) (see below for nested schema)
• geo_ip_not_match (List of Object) (see below for nested schema)
• ip_ranges_match (List of Object) (see below for nested schema)
• ip_ranges_not_match (List of Object) (see below for nested schema)

Nested Schema for Nested Schema for advanced_rate_limiter_rule.dynamic_quota.condition.source_ip.geo_ip_match

Read-Only:

• locations (List of String)

Nested Schema for Nested Schema for advanced_rate_limiter_rule.dynamic_quota.condition.source_ip.geo_ip_not_match

Read-Only:

• locations (List of String)

Nested Schema for Nested Schema for advanced_rate_limiter_rule.dynamic_quota.condition.source_ip.ip_ranges_match

Read-Only:

• ip_ranges (List of String)

Nested Schema for Nested Schema for advanced_rate_limiter_rule.dynamic_quota.condition.source_ip.ip_ranges_not_match

Read-Only:

• ip_ranges (List of String)

Nested Schema for Nested Schema for advanced_rate_limiter_rule.static_quota

Read-Only:

• action (String) Action in case of exceeding this quota. Possible values: DENY.

• condition (Block List, Max: 1) The condition for matching the rule. You can find all possibilities of condition in gRPC specs. (see below for nested schema)

• limit (Number) Desired maximum number of requests per period.

• period (Number) Period of time in seconds.

Nested Schema for Nested Schema for advanced_rate_limiter_rule.static_quota.condition

Read-Only:

• authority (List of Object) (see below for nested schema)
• headers (List of Object) (see below for nested schema)
• http_method (List of Object) (see below for nested schema)
• request_uri (List of Object) (see below for nested schema)
• source_ip (List of Object) (see below for nested schema)

Nested Schema for Nested Schema for advanced_rate_limiter_rule.static_quota.condition.authority

Read-Only:

• authorities (List of Object) (see below for nested schema)

Nested Schema for Nested Schema for advanced_rate_limiter_rule.static_quota.condition.source_ip.authorities

Read-Only:

• exact_match (String)
• exact_not_match (String)
• pire_regex_match (String)
• pire_regex_not_match (String)
• prefix_match (String)
• prefix_not_match (String)

Nested Schema for Nested Schema for advanced_rate_limiter_rule.static_quota.condition.headers

Read-Only:

• name (String)
• value (List of Object) (see below for nested schema)

Nested Schema for Nested Schema for advanced_rate_limiter_rule.static_quota.condition.source_ip.value

Read-Only:

• exact_match (String)
• exact_not_match (String)
• pire_regex_match (String)
• pire_regex_not_match (String)
• prefix_match (String)
• prefix_not_match (String)

Nested Schema for Nested Schema for advanced_rate_limiter_rule.static_quota.condition.http_method

Read-Only:

• http_methods (List of Object) (see below for nested schema)

Nested Schema for Nested Schema for advanced_rate_limiter_rule.static_quota.condition.source_ip.http_methods

Read-Only:

• exact_match (String)
• exact_not_match (String)
• pire_regex_match (String)
• pire_regex_not_match (String)
• prefix_match (String)
• prefix_not_match (String)

Nested Schema for Nested Schema for advanced_rate_limiter_rule.static_quota.condition.request_uri

Read-Only:

• path (List of Object) (see below for nested schema)
• queries (List of Object) (see below for nested schema)

Nested Schema for Nested Schema for advanced_rate_limiter_rule.static_quota.condition.source_ip.path

Read-Only:

• exact_match (String)
• exact_not_match (String)
• pire_regex_match (String)
• pire_regex_not_match (String)
• prefix_match (String)
• prefix_not_match (String)

Nested Schema for Nested Schema for advanced_rate_limiter_rule.static_quota.condition.source_ip.queries

Read-Only:

• key (String)
• value (List of Object) (see below for nested schema)

Nested Schema for Nested Schema for advanced_rate_limiter_rule.static_quota.condition.source_ip.queries.value

Read-Only:

• exact_match (String)
• exact_not_match (String)
• pire_regex_match (String)
• pire_regex_not_match (String)
• prefix_match (String)
• prefix_not_match (String)

Nested Schema for Nested Schema for advanced_rate_limiter_rule.static_quota.condition.source_ip

Read-Only:

• geo_ip_match (List of Object) (see below for nested schema)
• geo_ip_not_match (List of Object) (see below for nested schema)
• ip_ranges_match (List of Object) (see below for nested schema)
• ip_ranges_not_match (List of Object) (see below for nested schema)

Nested Schema for Nested Schema for advanced_rate_limiter_rule.static_quota.condition.source_ip.geo_ip_match

Read-Only:

• locations (List of String)

Nested Schema for Nested Schema for advanced_rate_limiter_rule.static_quota.condition.source_ip.geo_ip_not_match

Read-Only:

• locations (List of String)

Nested Schema for Nested Schema for advanced_rate_limiter_rule.static_quota.condition.source_ip.ip_ranges_match

Read-Only:

• ip_ranges (List of String)

Nested Schema for Nested Schema for advanced_rate_limiter_rule.static_quota.condition.source_ip.ip_ranges_not_match

Read-Only:

• ip_ranges (List of String)