Client

waf	R Documentation

AWS WAF¶

Description¶

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

This is the AWS WAF Classic API Reference for using AWS WAF Classic with Amazon CloudFront. The AWS WAF Classic actions and data types listed in the reference are available for protecting Amazon CloudFront distributions. You can use these actions and data types via the endpoint waf.amazonaws.com. This guide is for developers who need detailed information about the AWS WAF Classic API actions, data types, and errors. For detailed information about AWS WAF Classic features and an overview of how to use the AWS WAF Classic API, see the AWS WAF Classic in the developer guide.

Usage¶

waf(config = list(), credentials = list(), endpoint = NULL, region = NULL)

Arguments¶

config

Optional configuration of credentials, endpoint, and/or region.

credentials:
- creds:
  - access_key_id: AWS access key ID
  - secret_access_key: AWS secret access key
  - session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

creds:
- access_key_id: AWS access key ID
- secret_access_key: AWS secret access key
- session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

Value¶

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax¶

svc <- waf(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

create_byte_match_set: This is AWS WAF Classic documentation
create_geo_match_set: This is AWS WAF Classic documentation
create_ip_set: This is AWS WAF Classic documentation
create_rate_based_rule: This is AWS WAF Classic documentation
create_regex_match_set: This is AWS WAF Classic documentation
create_regex_pattern_set: This is AWS WAF Classic documentation
create_rule: This is AWS WAF Classic documentation
create_rule_group: This is AWS WAF Classic documentation
create_size_constraint_set: This is AWS WAF Classic documentation
create_sql_injection_match_set: This is AWS WAF Classic documentation
create_web_acl: This is AWS WAF Classic documentation
create_web_acl_migration_stack: Creates an AWS CloudFormation WAFV2 template for the specified web ACL in the specified Amazon S3 bucket
create_xss_match_set: This is AWS WAF Classic documentation
delete_byte_match_set: This is AWS WAF Classic documentation
delete_geo_match_set: This is AWS WAF Classic documentation
delete_ip_set: This is AWS WAF Classic documentation
delete_logging_configuration: This is AWS WAF Classic documentation
delete_permission_policy: This is AWS WAF Classic documentation
delete_rate_based_rule: This is AWS WAF Classic documentation
delete_regex_match_set: This is AWS WAF Classic documentation
delete_regex_pattern_set: This is AWS WAF Classic documentation
delete_rule: This is AWS WAF Classic documentation
delete_rule_group: This is AWS WAF Classic documentation
delete_size_constraint_set: This is AWS WAF Classic documentation
delete_sql_injection_match_set: This is AWS WAF Classic documentation
delete_web_acl: This is AWS WAF Classic documentation
delete_xss_match_set: This is AWS WAF Classic documentation
get_byte_match_set: This is AWS WAF Classic documentation
get_change_token: This is AWS WAF Classic documentation
get_change_token_status: This is AWS WAF Classic documentation
get_geo_match_set: This is AWS WAF Classic documentation
get_ip_set: This is AWS WAF Classic documentation
get_logging_configuration: This is AWS WAF Classic documentation
get_permission_policy: This is AWS WAF Classic documentation
get_rate_based_rule: This is AWS WAF Classic documentation
get_rate_based_rule_managed_keys: This is AWS WAF Classic documentation
get_regex_match_set: This is AWS WAF Classic documentation
get_regex_pattern_set: This is AWS WAF Classic documentation
get_rule: This is AWS WAF Classic documentation
get_rule_group: This is AWS WAF Classic documentation
get_sampled_requests: This is AWS WAF Classic documentation
get_size_constraint_set: This is AWS WAF Classic documentation
get_sql_injection_match_set: This is AWS WAF Classic documentation
get_web_acl: This is AWS WAF Classic documentation
get_xss_match_set: This is AWS WAF Classic documentation
list_activated_rules_in_rule_group: This is AWS WAF Classic documentation
list_byte_match_sets: This is AWS WAF Classic documentation
list_geo_match_sets: This is AWS WAF Classic documentation
list_ip_sets: This is AWS WAF Classic documentation
list_logging_configurations: This is AWS WAF Classic documentation
list_rate_based_rules: This is AWS WAF Classic documentation
list_regex_match_sets: This is AWS WAF Classic documentation
list_regex_pattern_sets: This is AWS WAF Classic documentation
list_rule_groups: This is AWS WAF Classic documentation
list_rules: This is AWS WAF Classic documentation
list_size_constraint_sets: This is AWS WAF Classic documentation
list_sql_injection_match_sets: This is AWS WAF Classic documentation
list_subscribed_rule_groups: This is AWS WAF Classic documentation
list_tags_for_resource: This is AWS WAF Classic documentation
list_web_ac_ls: This is AWS WAF Classic documentation
list_xss_match_sets: This is AWS WAF Classic documentation
put_logging_configuration: This is AWS WAF Classic documentation
put_permission_policy: This is AWS WAF Classic documentation
tag_resource: This is AWS WAF Classic documentation
untag_resource: This is AWS WAF Classic documentation
update_byte_match_set: This is AWS WAF Classic documentation
update_geo_match_set: This is AWS WAF Classic documentation
update_ip_set: This is AWS WAF Classic documentation
update_rate_based_rule: This is AWS WAF Classic documentation
update_regex_match_set: This is AWS WAF Classic documentation
update_regex_pattern_set: This is AWS WAF Classic documentation
update_rule: This is AWS WAF Classic documentation
update_rule_group: This is AWS WAF Classic documentation
update_size_constraint_set: This is AWS WAF Classic documentation
update_sql_injection_match_set: This is AWS WAF Classic documentation
update_web_acl: This is AWS WAF Classic documentation
update_xss_match_set: This is AWS WAF Classic documentation

Examples¶

## Not run: 
svc <- waf()
# The following example creates an IP match set named MyIPSetFriendlyName.
svc$create_ip_set(
  ChangeToken = "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
  Name = "MyIPSetFriendlyName"
)

## End(Not run)