AWS WAF classic

Get rule

Return the rule associated with the RuleId included in the GetRule request.

Inputs

Field

Type

Description

region [required]

enum

default: Global (Cloudfront)

ruleId [required]

string

The RuleId of the Rule that you want to get. RuleId is returned by CreateRule and by ListRules.

scope

enum

DEPRECATED: Specify whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AWS AppSync GraphQL API. Allowed enum values: GLOBAL,REGIONAL

Outputs

Expand All

Field

Type

Description

rule

object

Information about the rule specified in the request.

RuleId [required]

string

A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule). RuleId is returned by CreateRule and by ListRules.

Name

string

The friendly name or description for the Rule. You can't change the name of a Rule after you create it.

MetricName

string

A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change MetricName after you create the Rule.

Predicates [required]

[object]

The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a Rule.

Negated [required]

boolean

Set Negated to False if you want AWS WAF to allow, block, or count requests based on the settings in the specified ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow or block requests based on that IP address. Set Negated to True if you want AWS WAF to allow or block a request based on the negation of the settings in the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow, block, or count requests based on all IP addresses except 192.0.2.44.

Type [required]

string

The type of predicate in a Rule, such as ByteMatch or IPSet.

DataId [required]

string

A unique identifier for a predicate in a Rule, such as ByteMatchSetId or IPSetId. The ID is returned by the corresponding Create or List command.

amzRequestId [required]

string