yandex_smartcaptcha_captcha (Data Source)

A Captcha resource.

Example UsageExample Usage

//
// Get SmartCaptcha details by Id.
//
data "yandex_smartcaptcha_captcha" "by-id" {
  captcha_id = yandex_smartcaptcha_captcha.my-captcha.id
}

//
// Get SmartCaptcha details by Name.
//
data "yandex_smartcaptcha_captcha" "by-name" {
  name = yandex_smartcaptcha_captcha.my-captcha.name
}

SchemaSchema

OptionalOptional

• captcha_id (String) ID of the Captcha resource to return.
• cloud_id (String) ID of the cloud that the captcha belongs to.
• folder_id (String) ID of the folder that the captcha belongs to.
• id (String) ID of the Captcha resource to return.
• name (String) Name of the captcha. The name is unique within the folder. 3-63 characters long.
• timeouts (Attributes) (see below for nested schema)

Read-OnlyRead-Only

• allowed_sites (List of String) List of allowed host names, see Domain validation.
• challenge_type (String) Additional task type of the captcha.
• client_key (String) Client key of the captcha, see CAPTCHA keys.
• complexity (String) Complexity of the captcha.
• created_at (String) Creation timestamp in RFC3339 text format.
• deletion_protection (Boolean) Determines whether captcha is protected from being deleted.
• description (String) package: yandex.cloud.smartcaptcha.v1
  filename: yandex/cloud/smartcaptcha/v1/captcha.proto
• disallow_data_processing (Boolean) package: yandex.cloud.smartcaptcha.v1
  filename: yandex/cloud/smartcaptcha/v1/captcha.proto
• labels (Map of String) package: yandex.cloud.smartcaptcha.v1
  filename: yandex/cloud/smartcaptcha/v1/captcha.proto
• override_variant (Attributes List) List of variants to use in security_rules (see below for nested schema)
• pre_check_type (String) Basic check type of the captcha.
• security_rule (Attributes List) List of security rules. (see below for nested schema)
• style_json (String) JSON with variables to define the captcha appearance. For more details see generated JSON in cloud console.
• suspend (Boolean) Determines that the captcha is currently in restricted mode, see SmartCaptcha restricted mode.
• turn_off_hostname_check (Boolean) Turn off host name check, see Domain validation.

Nested Schema for Nested Schema for timeouts

Optional:

• create (String) A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
• delete (String) A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
• read (String) A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.
• update (String) A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

Nested Schema for Nested Schema for override_variant

Read-Only:

• challenge_type (String) Additional task type of the captcha. Additional task type of the captcha.

• complexity (String) Complexity of the captcha. Complexity of the captcha.

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

• pre_check_type (String) Basic check type of the captcha. Basic check type of the captcha.

• uuid (String) Unique identifier of the variant. Unique identifier of the variant.

Nested Schema for Nested Schema for security_rule

Required:

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

Read-Only:

• condition (Attributes List) The condition for matching the rule. (see below for nested schema) (see below for nested schema)

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

• override_variant_uuid (String) Variant UUID to show in case of match the rule. Keep empty to use defaults. Variant UUID to show in case of match the rule. Keep empty to use defaults.

• priority (Number) Priority of the rule. Lower value means higher priority. Priority of the rule. Lower value means higher priority.

Nested Schema for Nested Schema for security_rule.condition

Read-Only:

• headers (Attributes List) Captcha request headers. (see below for nested schema) (see below for nested schema)

• host (Attributes List) Host where captcha placed. (see below for nested schema) (see below for nested schema)

• source_ip (Attributes List) The IP address of the requester. (see below for nested schema) (see below for nested schema)

• uri (Attributes List) URI where captcha placed. (see below for nested schema) (see below for nested schema)

Nested Schema for Nested Schema for security_rule.condition.headers

Required:

• name (String) Name of header (case insensitive). Name of header (case insensitive).

Read-Only:

• value (Attributes List) Value of the header. (see below for nested schema) (see below for nested schema)

Nested Schema for Nested Schema for security_rule.condition.headers.value

Read-Only:

• exact_match (String) package: yandex.cloud.smartcaptcha.v1 package: yandex.cloud.smartcaptcha.v1

filename: yandex/cloud/smartcaptcha/v1/captcha.proto

• exact_not_match (String) package: yandex.cloud.smartcaptcha.v1 package: yandex.cloud.smartcaptcha.v1

filename: yandex/cloud/smartcaptcha/v1/captcha.proto

• pire_regex_match (String) package: yandex.cloud.smartcaptcha.v1 package: yandex.cloud.smartcaptcha.v1

filename: yandex/cloud/smartcaptcha/v1/captcha.proto

• pire_regex_not_match (String) package: yandex.cloud.smartcaptcha.v1 package: yandex.cloud.smartcaptcha.v1

filename: yandex/cloud/smartcaptcha/v1/captcha.proto

• prefix_match (String) package: yandex.cloud.smartcaptcha.v1 package: yandex.cloud.smartcaptcha.v1

filename: yandex/cloud/smartcaptcha/v1/captcha.proto

• prefix_not_match (String) package: yandex.cloud.smartcaptcha.v1 package: yandex.cloud.smartcaptcha.v1

filename: yandex/cloud/smartcaptcha/v1/captcha.proto

Nested Schema for Nested Schema for security_rule.condition.host

Read-Only:

• hosts (Attributes List) List of hosts. OR semantics implied. (see below for nested schema) (see below for nested schema)

Nested Schema for Nested Schema for security_rule.condition.host.hosts

Read-Only:

• exact_match (String) package: yandex.cloud.smartcaptcha.v1 package: yandex.cloud.smartcaptcha.v1

filename: yandex/cloud/smartcaptcha/v1/captcha.proto

• exact_not_match (String) package: yandex.cloud.smartcaptcha.v1 package: yandex.cloud.smartcaptcha.v1

filename: yandex/cloud/smartcaptcha/v1/captcha.proto

• pire_regex_match (String) package: yandex.cloud.smartcaptcha.v1 package: yandex.cloud.smartcaptcha.v1

filename: yandex/cloud/smartcaptcha/v1/captcha.proto

• pire_regex_not_match (String) package: yandex.cloud.smartcaptcha.v1 package: yandex.cloud.smartcaptcha.v1

filename: yandex/cloud/smartcaptcha/v1/captcha.proto

• prefix_match (String) package: yandex.cloud.smartcaptcha.v1 package: yandex.cloud.smartcaptcha.v1

filename: yandex/cloud/smartcaptcha/v1/captcha.proto

• prefix_not_match (String) package: yandex.cloud.smartcaptcha.v1 package: yandex.cloud.smartcaptcha.v1

filename: yandex/cloud/smartcaptcha/v1/captcha.proto

Nested Schema for Nested Schema for security_rule.condition.source_ip

Read-Only:

• geo_ip_match (Attributes List) package: yandex.cloud.smartcaptcha.v1 package: yandex.cloud.smartcaptcha.v1

filename: yandex/cloud/smartcaptcha/v1/captcha.proto (see below for nested schema)

• geo_ip_not_match (Attributes List) package: yandex.cloud.smartcaptcha.v1 package: yandex.cloud.smartcaptcha.v1

filename: yandex/cloud/smartcaptcha/v1/captcha.proto (see below for nested schema)

• ip_ranges_match (Attributes List) package: yandex.cloud.smartcaptcha.v1 package: yandex.cloud.smartcaptcha.v1

filename: yandex/cloud/smartcaptcha/v1/captcha.proto (see below for nested schema)

• ip_ranges_not_match (Attributes List) package: yandex.cloud.smartcaptcha.v1 package: yandex.cloud.smartcaptcha.v1

filename: yandex/cloud/smartcaptcha/v1/captcha.proto (see below for nested schema)

Nested Schema for Nested Schema for security_rule.condition.source_ip.geo_ip_match

Read-Only:

• locations (List of String) ISO 3166-1 alpha 2. OR semantics implied. ISO 3166-1 alpha 2. OR semantics implied.

Nested Schema for Nested Schema for security_rule.condition.source_ip.geo_ip_not_match

Read-Only:

• locations (List of String) ISO 3166-1 alpha 2. OR semantics implied. ISO 3166-1 alpha 2. OR semantics implied.

Nested Schema for Nested Schema for security_rule.condition.source_ip.ip_ranges_match

Read-Only:

• ip_ranges (List of String) List of IP ranges. OR semantics implied. List of IP ranges. OR semantics implied.

Nested Schema for Nested Schema for security_rule.condition.source_ip.ip_ranges_not_match

Read-Only:

• ip_ranges (List of String) List of IP ranges. OR semantics implied. List of IP ranges. OR semantics implied.

Nested Schema for Nested Schema for security_rule.condition.uri

Read-Only:

• path (Attributes List) Path of the URI RFC3986. (see below for nested schema) (see below for nested schema)

• queries (Attributes List) List of query matchers. AND semantics implied. (see below for nested schema) (see below for nested schema)

Nested Schema for Nested Schema for security_rule.condition.uri.path

Read-Only:

• exact_match (String) package: yandex.cloud.smartcaptcha.v1 package: yandex.cloud.smartcaptcha.v1

filename: yandex/cloud/smartcaptcha/v1/captcha.proto

• exact_not_match (String) package: yandex.cloud.smartcaptcha.v1 package: yandex.cloud.smartcaptcha.v1

filename: yandex/cloud/smartcaptcha/v1/captcha.proto

• pire_regex_match (String) package: yandex.cloud.smartcaptcha.v1 package: yandex.cloud.smartcaptcha.v1

filename: yandex/cloud/smartcaptcha/v1/captcha.proto

• pire_regex_not_match (String) package: yandex.cloud.smartcaptcha.v1 package: yandex.cloud.smartcaptcha.v1

filename: yandex/cloud/smartcaptcha/v1/captcha.proto

• prefix_match (String) package: yandex.cloud.smartcaptcha.v1 package: yandex.cloud.smartcaptcha.v1

filename: yandex/cloud/smartcaptcha/v1/captcha.proto

• prefix_not_match (String) package: yandex.cloud.smartcaptcha.v1 package: yandex.cloud.smartcaptcha.v1

filename: yandex/cloud/smartcaptcha/v1/captcha.proto

Nested Schema for Nested Schema for security_rule.condition.uri.queries

Read-Only:

• key (String) Key of the query parameter. Key of the query parameter.

• value (Attributes List) Value of the query parameter. (see below for nested schema) (see below for nested schema)

Nested Schema for Nested Schema for security_rule.condition.uri.queries.value

Read-Only:

• exact_match (String) package: yandex.cloud.smartcaptcha.v1 package: yandex.cloud.smartcaptcha.v1

filename: yandex/cloud/smartcaptcha/v1/captcha.proto

• exact_not_match (String) package: yandex.cloud.smartcaptcha.v1 package: yandex.cloud.smartcaptcha.v1

filename: yandex/cloud/smartcaptcha/v1/captcha.proto

• pire_regex_match (String) package: yandex.cloud.smartcaptcha.v1 package: yandex.cloud.smartcaptcha.v1

filename: yandex/cloud/smartcaptcha/v1/captcha.proto

• pire_regex_not_match (String) package: yandex.cloud.smartcaptcha.v1 package: yandex.cloud.smartcaptcha.v1

filename: yandex/cloud/smartcaptcha/v1/captcha.proto

• prefix_match (String) package: yandex.cloud.smartcaptcha.v1 package: yandex.cloud.smartcaptcha.v1

filename: yandex/cloud/smartcaptcha/v1/captcha.proto

• prefix_not_match (String) package: yandex.cloud.smartcaptcha.v1 package: yandex.cloud.smartcaptcha.v1

filename: yandex/cloud/smartcaptcha/v1/captcha.proto