wafregional

class pulumi_aws.wafregional.ByteMatchSet(resource_name, opts=None, byte_match_tuple=None, byte_match_tuples=None, name=None, __name__=None, __opts__=None)

Provides a WAF Regional Byte Match Set Resource for use with Application Load Balancer.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • byte_match_tuple (pulumi.Input[list]) – Deprecated, use byte_match_tuples instead.
  • byte_match_tuples (pulumi.Input[list]) – Settings for the ByteMatchSet, such as the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests. ByteMatchTuple documented below.
  • name (pulumi.Input[str]) – The name or description of the ByteMatchSet.
byte_match_tuple = None

Deprecated, use byte_match_tuples instead.

byte_match_tuples = None

Settings for the ByteMatchSet, such as the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests. ByteMatchTuple documented below.

name = None

The name or description of the ByteMatchSet.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.wafregional.GeoMatchSet(resource_name, opts=None, geo_match_constraints=None, name=None, __name__=None, __opts__=None)

Provides a WAF Regional Geo Match Set Resource

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • geo_match_constraints (pulumi.Input[list]) – The Geo Match Constraint objects which contain the country that you want AWS WAF to search for.
  • name (pulumi.Input[str]) – The name or description of the Geo Match Set.
geo_match_constraints = None

The Geo Match Constraint objects which contain the country that you want AWS WAF to search for.

name = None

The name or description of the Geo Match Set.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.wafregional.IpSet(resource_name, opts=None, ip_set_descriptors=None, name=None, __name__=None, __opts__=None)

Provides a WAF Regional IPSet Resource for use with Application Load Balancer.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • ip_set_descriptors (pulumi.Input[list]) – One or more pairs specifying the IP address type (IPV4 or IPV6) and the IP address range (in CIDR notation) from which web requests originate.
  • name (pulumi.Input[str]) – The name or description of the IPSet.
arn = None

The ARN of the WAF IPSet.

ip_set_descriptors = None

One or more pairs specifying the IP address type (IPV4 or IPV6) and the IP address range (in CIDR notation) from which web requests originate.

name = None

The name or description of the IPSet.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.wafregional.RateBasedRule(resource_name, opts=None, metric_name=None, name=None, predicates=None, rate_key=None, rate_limit=None, __name__=None, __opts__=None)

Provides a WAF Rate Based Rule Resource

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • metric_name (pulumi.Input[str]) – The name or description for the Amazon CloudWatch metric of this rule.
  • name (pulumi.Input[str]) – The name or description of the rule.
  • predicates (pulumi.Input[list]) – One of ByteMatchSet, IPSet, SizeConstraintSet, SqlInjectionMatchSet, or XssMatchSet objects to include in a rule.
  • rate_key (pulumi.Input[str]) – Valid value is IP.
  • rate_limit (pulumi.Input[int]) – The maximum number of requests, which have an identical value in the field specified by the RateKey, allowed in a five-minute period. Minimum value is 2000.
metric_name = None

The name or description for the Amazon CloudWatch metric of this rule.

name = None

The name or description of the rule.

predicates = None

One of ByteMatchSet, IPSet, SizeConstraintSet, SqlInjectionMatchSet, or XssMatchSet objects to include in a rule.

rate_key = None

Valid value is IP.

rate_limit = None

The maximum number of requests, which have an identical value in the field specified by the RateKey, allowed in a five-minute period. Minimum value is 2000.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.wafregional.RegexMatchSet(resource_name, opts=None, name=None, regex_match_tuples=None, __name__=None, __opts__=None)

Provides a WAF Regional Regex Match Set Resource

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • name (pulumi.Input[str]) – The name or description of the Regex Match Set.
  • regex_match_tuples (pulumi.Input[list]) – The regular expression pattern that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings. See below.
name = None

The name or description of the Regex Match Set.

regex_match_tuples = None

The regular expression pattern that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings. See below.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.wafregional.RegexPatternSet(resource_name, opts=None, name=None, regex_pattern_strings=None, __name__=None, __opts__=None)

Provides a WAF Regional Regex Pattern Set Resource

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • name (pulumi.Input[str]) – The name or description of the Regex Pattern Set.
  • regex_pattern_strings (pulumi.Input[list]) – A list of regular expression (regex) patterns that you want AWS WAF to search for, such as B[a@]dB[o0]t.
name = None

The name or description of the Regex Pattern Set.

regex_pattern_strings = None

A list of regular expression (regex) patterns that you want AWS WAF to search for, such as B[a@]dB[o0]t.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.wafregional.Rule(resource_name, opts=None, metric_name=None, name=None, predicates=None, __name__=None, __opts__=None)

Provides an WAF Regional Rule Resource for use with Application Load Balancer.

See the WAF Documentation for more information.

  • type - (Required) The type of predicate in a rule. Valid values: ByteMatch, GeoMatch, IPMatch, RegexMatch, SizeConstraint, SqlInjectionMatch, or XssMatch
  • data_id - (Required) The unique identifier of a predicate, such as the ID of a ByteMatchSet or IPSet.
  • negated - (Required) Whether to use the settings or the negated settings that you specified in the objects.
Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • metric_name (pulumi.Input[str]) – The name or description for the Amazon CloudWatch metric of this rule.
  • name (pulumi.Input[str]) – The name or description of the rule.
  • predicates (pulumi.Input[list]) – The objects to include in a rule.
metric_name = None

The name or description for the Amazon CloudWatch metric of this rule.

name = None

The name or description of the rule.

predicates = None

The objects to include in a rule.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.wafregional.RuleGroup(resource_name, opts=None, activated_rules=None, metric_name=None, name=None, __name__=None, __opts__=None)

Provides a WAF Regional Rule Group Resource

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • activated_rules (pulumi.Input[list]) – A list of activated rules, see below
  • metric_name (pulumi.Input[str]) – A friendly name for the metrics from the rule group
  • name (pulumi.Input[str]) – A friendly name of the rule group
activated_rules = None

A list of activated rules, see below

metric_name = None

A friendly name for the metrics from the rule group

name = None

A friendly name of the rule group

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.wafregional.SizeConstraintSet(resource_name, opts=None, name=None, size_constraints=None, __name__=None, __opts__=None)

Provides a WAF Regional Size Constraint Set Resource for use with Application Load Balancer.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • name (pulumi.Input[str]) – The name or description of the Size Constraint Set.
  • size_constraints (pulumi.Input[list]) – Specifies the parts of web requests that you want to inspect the size of.
name = None

The name or description of the Size Constraint Set.

size_constraints = None

Specifies the parts of web requests that you want to inspect the size of.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.wafregional.SqlInjectionMatchSet(resource_name, opts=None, name=None, sql_injection_match_tuples=None, __name__=None, __opts__=None)

Provides a WAF Regional SQL Injection Match Set Resource for use with Application Load Balancer.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • name (pulumi.Input[str]) – The name or description of the SizeConstraintSet.
  • sql_injection_match_tuples (pulumi.Input[list]) – The parts of web requests that you want AWS WAF to inspect for malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header.
name = None

The name or description of the SizeConstraintSet.

sql_injection_match_tuples = None

The parts of web requests that you want AWS WAF to inspect for malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.wafregional.WebAcl(resource_name, opts=None, default_action=None, metric_name=None, name=None, rules=None, __name__=None, __opts__=None)

Provides a WAF Regional Web ACL Resource for use with Application Load Balancer.

See docs for all details and supported values.

  • action - (Required) The action that CloudFront or AWS WAF takes when a web request matches the conditions in the rule. Not used if type is GROUP.
  • override_action - (Required) Override the action that a group requests CloudFront or AWS WAF takes when a web request matches the conditions in the rule. Only used if type is GROUP.
  • priority - (Required) Specifies the order in which the rules in a WebACL are evaluated. Rules with a lower value are evaluated before rules with a higher value.
  • rule_id - (Required) ID of the associated WAF (Regional) rule (e.g. ``aws_wafregional_rule` <https://www.terraform.io/docs/providers/aws/r/wafregional_rule.html>`_). WAF (Global) rules cannot be used.
  • type - (Optional) The rule type, either REGULAR, as defined by Rule, RATE_BASED, as defined by RateBasedRule, or GROUP, as defined by RuleGroup. The default is REGULAR. If you add a RATE_BASED rule, you need to set type as RATE_BASED. If you add a GROUP rule, you need to set type as GROUP.
  • type - (Required) Specifies how you want AWS WAF Regional to respond to requests that match the settings in a rule. e.g. ALLOW, BLOCK or COUNT
Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • default_action (pulumi.Input[dict]) – The action that you want AWS WAF Regional to take when a request doesn’t match the criteria in any of the rules that are associated with the web ACL.
  • metric_name (pulumi.Input[str]) – The name or description for the Amazon CloudWatch metric of this web ACL.
  • name (pulumi.Input[str]) – The name or description of the web ACL.
  • rules (pulumi.Input[list]) – The rules to associate with the web ACL and the settings for each rule.
default_action = None

The action that you want AWS WAF Regional to take when a request doesn’t match the criteria in any of the rules that are associated with the web ACL.

metric_name = None

The name or description for the Amazon CloudWatch metric of this web ACL.

name = None

The name or description of the web ACL.

rules = None

The rules to associate with the web ACL and the settings for each rule.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.wafregional.WebAclAssociation(resource_name, opts=None, resource_arn=None, web_acl_id=None, __name__=None, __opts__=None)

Provides a resource to create an association between a WAF Regional WebACL and Application Load Balancer.

Note: An Application Load Balancer can only be associated with one WAF Regional WebACL.
Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • resource_arn (pulumi.Input[str]) – Application Load Balancer ARN to associate with.
  • web_acl_id (pulumi.Input[str]) – The ID of the WAF Regional WebACL to create an association.
resource_arn = None

Application Load Balancer ARN to associate with.

web_acl_id = None

The ID of the WAF Regional WebACL to create an association.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.wafregional.XssMatchSet(resource_name, opts=None, name=None, xss_match_tuples=None, __name__=None, __opts__=None)

Provides a WAF Regional XSS Match Set Resource for use with Application Load Balancer.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • name (pulumi.Input[str]) – The name of the set
  • xss_match_tuples (pulumi.Input[list]) – The parts of web requests that you want to inspect for cross-site scripting attacks.
name = None

The name of the set

xss_match_tuples = None

The parts of web requests that you want to inspect for cross-site scripting attacks.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str