RetroSearch Browse

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://docs.aws.amazon.com/sdkforruby/api/Aws/WAFV2/Client.html below:

Client — AWS SDK for Ruby V2

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::WAFV2::Client Overview

An API client for AWS WAFV2. To construct a client, you need to configure a :region and :credentials.

wafv2 = Aws::WAFV2::Client.new(
  region: region_name,
  credentials: credentials,
  )

See #initialize for a full list of supported configuration options.

Region

You can configure a default region in the following locations:

ENV['AWS_REGION']
Aws.config[:region]

Go here for a list of supported regions.

Credentials

Default credentials are loaded automatically from the following locations:

ENV['AWS_ACCESS_KEY_ID'] and ENV['AWS_SECRET_ACCESS_KEY']
Aws.config[:credentials]
The shared credentials ini file at ~/.aws/credentials (more information)
From an instance profile when running on EC2

You can also construct a credentials object from one of the following classes:

Alternatively, you configure credentials with :access_key_id and :secret_access_key:

creds = YAML.load(File.read('/path/to/secrets'))

Aws::WAFV2::Client.new(
  access_key_id: creds['access_key_id'],
  secret_access_key: creds['secret_access_key']
)

Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.

Attribute Summary collapse

Instance Attribute Summary Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse

#initialize(options = {}) ⇒ Aws::WAFV2::Client constructor Constructs an API client.

API Operations collapse

#associate_web_acl(options = {}) ⇒ Struct This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019.
#check_capacity(options = {}) ⇒ Types::CheckCapacityResponse This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019.
#create_ip_set(options = {}) ⇒ Types::CreateIPSetResponse This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019.
#create_regex_pattern_set(options = {}) ⇒ Types::CreateRegexPatternSetResponse This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019.
#create_rule_group(options = {}) ⇒ Types::CreateRuleGroupResponse This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019.
#create_web_acl(options = {}) ⇒ Types::CreateWebACLResponse This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019.
#delete_firewall_manager_rule_groups(options = {}) ⇒ Types::DeleteFirewallManagerRuleGroupsResponse Deletes all rule groups that are managed by AWS Firewall Manager for the specified web ACL.
#delete_ip_set(options = {}) ⇒ Struct This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019.
#delete_logging_configuration(options = {}) ⇒ Struct This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019.
#delete_permission_policy(options = {}) ⇒ Struct Permanently deletes an IAM policy from the specified rule group. You must be the owner of the rule group to perform this operation. .
#delete_regex_pattern_set(options = {}) ⇒ Struct This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019.
#delete_rule_group(options = {}) ⇒ Struct This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019.
#delete_web_acl(options = {}) ⇒ Struct This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019.
#describe_managed_rule_group(options = {}) ⇒ Types::DescribeManagedRuleGroupResponse This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019.
#disassociate_web_acl(options = {}) ⇒ Struct This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019.
#get_ip_set(options = {}) ⇒ Types::GetIPSetResponse This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019.
#get_logging_configuration(options = {}) ⇒ Types::GetLoggingConfigurationResponse This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019.
#get_permission_policy(options = {}) ⇒ Types::GetPermissionPolicyResponse Returns the IAM policy that is attached to the specified rule group. You must be the owner of the rule group to perform this operation. .
#get_rate_based_statement_managed_keys(options = {}) ⇒ Types::GetRateBasedStatementManagedKeysResponse This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019.
#get_regex_pattern_set(options = {}) ⇒ Types::GetRegexPatternSetResponse This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019.
#get_rule_group(options = {}) ⇒ Types::GetRuleGroupResponse This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019.
#get_sampled_requests(options = {}) ⇒ Types::GetSampledRequestsResponse This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019.
#get_web_acl(options = {}) ⇒ Types::GetWebACLResponse This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019.
#get_web_acl_for_resource(options = {}) ⇒ Types::GetWebACLForResourceResponse This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019.
#list_available_managed_rule_groups(options = {}) ⇒ Types::ListAvailableManagedRuleGroupsResponse This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019.
#list_ip_sets(options = {}) ⇒ Types::ListIPSetsResponse This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019.
#list_logging_configurations(options = {}) ⇒ Types::ListLoggingConfigurationsResponse This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019.
#list_regex_pattern_sets(options = {}) ⇒ Types::ListRegexPatternSetsResponse This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019.
#list_resources_for_web_acl(options = {}) ⇒ Types::ListResourcesForWebACLResponse This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019.
#list_rule_groups(options = {}) ⇒ Types::ListRuleGroupsResponse This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019.
#list_tags_for_resource(options = {}) ⇒ Types::ListTagsForResourceResponse This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019.
#list_web_acls(options = {}) ⇒ Types::ListWebACLsResponse This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019.
#put_logging_configuration(options = {}) ⇒ Types::PutLoggingConfigurationResponse This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019.
#put_permission_policy(options = {}) ⇒ Struct Attaches an IAM policy to the specified resource.
#tag_resource(options = {}) ⇒ Struct This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019.
#untag_resource(options = {}) ⇒ Struct This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019.
#update_ip_set(options = {}) ⇒ Types::UpdateIPSetResponse This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019.
#update_regex_pattern_set(options = {}) ⇒ Types::UpdateRegexPatternSetResponse This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019.
#update_rule_group(options = {}) ⇒ Types::UpdateRuleGroupResponse This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019.
#update_web_acl(options = {}) ⇒ Types::UpdateWebACLResponse This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019.

Instance Method Summary collapse

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean Waiters polls an API operation until a resource enters a desired state.
#waiter_names ⇒ Array<Symbol> Returns the list of supported waiters.

Methods inherited from Seahorse::Client::Base

add_plugin, api, #build_request, clear_plugins, define, new, #operation, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Instance Method Details #associate_web_acl(options = {}) ⇒ Struct

This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

Associates a Web ACL with a regional application resource, to protect the resource. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

For AWS CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To associate a Web ACL, in the CloudFront call UpdateDistribution, set the web ACL ID to the Amazon Resource Name (ARN) of the Web ACL. For information, see UpdateDistribution.

#check_capacity(options = {}) ⇒ Types::CheckCapacityResponse

Returns the web ACL capacity unit (WCU) requirements for a specified scope and set of rules. You can use this to check the capacity requirements for the rules you want to use in a RuleGroup or WebACL.

AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.

#create_ip_set(options = {}) ⇒ Types::CreateIPSetResponse

Creates an IPSet, which you use to identify web requests that originate from specific IP addresses or ranges of IP addresses. For example, if you're receiving a lot of requests from a ranges of IP addresses, you can configure AWS WAF to block them using an IPSet that lists those IP addresses.

#create_rule_group(options = {}) ⇒ Types::CreateRuleGroupResponse

Creates a RuleGroup per the specifications provided.

A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.

#create_web_acl(options = {}) ⇒ Types::CreateWebACLResponse

Creates a WebACL per the specifications provided.

A Web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the Web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a Web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a Web ACL with one or more AWS resources to protect. The resources can be Amazon CloudFront, an Amazon API Gateway REST API, an Application Load Balancer, or an AWS AppSync GraphQL API.

#delete_firewall_manager_rule_groups(options = {}) ⇒ Types::DeleteFirewallManagerRuleGroupsResponse

Deletes all rule groups that are managed by AWS Firewall Manager for the specified web ACL.

You can only use this if ManagedByFirewallManager is false in the specified WebACL.

#delete_ip_set(options = {}) ⇒ Struct

Deletes the specified IPSet.

#delete_logging_configuration(options = {}) ⇒ Struct

Deletes the LoggingConfiguration from the specified web ACL.

#delete_permission_policy(options = {}) ⇒ Struct

Permanently deletes an IAM policy from the specified rule group.

You must be the owner of the rule group to perform this operation.

#delete_regex_pattern_set(options = {}) ⇒ Struct

Deletes the specified RegexPatternSet.

#delete_rule_group(options = {}) ⇒ Struct

Deletes the specified RuleGroup.

#delete_web_acl(options = {}) ⇒ Struct

Deletes the specified WebACL.

You can only use this if ManagedByFirewallManager is false in the specified WebACL.

#describe_managed_rule_group(options = {}) ⇒ Types::DescribeManagedRuleGroupResponse

Provides high-level information for a managed rule group, including descriptions of the rules.

#disassociate_web_acl(options = {}) ⇒ Struct

Disassociates a Web ACL from a regional application resource. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

For AWS CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To disassociate a Web ACL, provide an empty web ACL ID in the CloudFront call UpdateDistribution. For information, see UpdateDistribution.

#get_ip_set(options = {}) ⇒ Types::GetIPSetResponse

Retrieves the specified IPSet.

#get_permission_policy(options = {}) ⇒ Types::GetPermissionPolicyResponse

Returns the IAM policy that is attached to the specified rule group.

You must be the owner of the rule group to perform this operation.

#get_rate_based_statement_managed_keys(options = {}) ⇒ Types::GetRateBasedStatementManagedKeysResponse

Retrieves the keys that are currently blocked by a rate-based rule. The maximum number of managed keys that can be blocked for a single rate-based rule is 10,000. If more than 10,000 addresses exceed the rate limit, those with the highest rates are blocked.

#get_rule_group(options = {}) ⇒ Types::GetRuleGroupResponse

Retrieves the specified RuleGroup.

#get_sampled_requests(options = {}) ⇒ Types::GetSampledRequestsResponse

Gets detailed information about a specified number of requests--a sample--that AWS WAF randomly selects from among the first 5,000 requests that your AWS resource received during a time range that you choose. You can specify a sample size of up to 500 requests, and you can specify any time range in the previous three hours.

GetSampledRequests returns a time range, which is usually the time range that you specified. However, if your resource (such as a CloudFront distribution) received 5,000 requests before the specified time range elapsed, GetSampledRequests returns an updated time range. This new time range indicates the actual period during which AWS WAF selected the requests in the sample.

#get_web_acl(options = {}) ⇒ Types::GetWebACLResponse

Retrieves the specified WebACL.

#get_web_acl_for_resource(options = {}) ⇒ Types::GetWebACLForResourceResponse

Retrieves the WebACL for the specified resource.

#list_available_managed_rule_groups(options = {}) ⇒ Types::ListAvailableManagedRuleGroupsResponse

Retrieves an array of managed rule groups that are available for you to use. This list includes all AWS Managed Rules rule groups and the AWS Marketplace managed rule groups that you're subscribed to.

#list_ip_sets(options = {}) ⇒ Types::ListIPSetsResponse

Retrieves an array of IPSetSummary objects for the IP sets that you manage.

#list_resources_for_web_acl(options = {}) ⇒ Types::ListResourcesForWebACLResponse

Retrieves an array of the Amazon Resource Names (ARNs) for the regional resources that are associated with the specified web ACL. If you want the list of AWS CloudFront resources, use the AWS CloudFront call ListDistributionsByWebACLId.

#list_rule_groups(options = {}) ⇒ Types::ListRuleGroupsResponse

Retrieves an array of RuleGroupSummary objects for the rule groups that you manage.

#list_tags_for_resource(options = {}) ⇒ Types::ListTagsForResourceResponse

Retrieves the TagInfoForResource for the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.

You can tag the AWS resources that you manage through AWS WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the AWS WAF console.

#list_web_acls(options = {}) ⇒ Types::ListWebACLsResponse

Retrieves an array of WebACLSummary objects for the web ACLs that you manage.

#put_logging_configuration(options = {}) ⇒ Types::PutLoggingConfigurationResponse

Enables the specified LoggingConfiguration, to start logging from a web ACL, according to the configuration provided.

You can access information about all traffic that AWS WAF inspects using the following steps:

Create an Amazon Kinesis Data Firehose.

Create the data firehose with a PUT source and in the Region that you are operating. If you are capturing logs for Amazon CloudFront, always create the firehose in US East (N. Virginia).

Give the data firehose a name that starts with the prefix aws-waf-logs-. For example, aws-waf-logs-us-east-2-analytics.

Do not create the data firehose using a Kinesis stream as your source.
Associate that firehose to your web ACL using a PutLoggingConfiguration request.

When you successfully enable logging using a PutLoggingConfiguration request, AWS WAF will create a service linked role with the necessary permissions to write logs to the Amazon Kinesis Data Firehose. For more information, see Logging Web ACL Traffic Information in the AWS WAF Developer Guide.

#put_permission_policy(options = {}) ⇒ Struct

Attaches an IAM policy to the specified resource. Use this to share a rule group across accounts.

You must be the owner of the rule group to perform this operation.

This action is subject to the following restrictions:

You can attach only one policy with each PutPermissionPolicy request.
The ARN in the request must be a valid WAF RuleGroup ARN and the rule group must exist in the same region.
The user making the request must be the owner of the rule group.

#tag_resource(options = {}) ⇒ Struct

Associates tags with the specified AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.

You can tag the AWS resources that you manage through AWS WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the AWS WAF console.

#untag_resource(options = {}) ⇒ Struct

Disassociates tags from an AWS resource. Tags are key:value pairs that you can associate with AWS resources. For example, the tag key might be "customer" and the tag value might be "companyA." You can specify one or more tags to add to each container. You can add up to 50 tags to each AWS resource.

#update_ip_set(options = {}) ⇒ Types::UpdateIPSetResponse

Updates the specified IPSet.

#update_rule_group(options = {}) ⇒ Types::UpdateRuleGroupResponse

Updates the specified RuleGroup.

#update_web_acl(options = {}) ⇒ Types::UpdateWebACLResponse

Updates the specified WebACL.

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean

Waiters polls an API operation until a resource enters a desired state.

Basic Usage

Waiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:

# poll for ~25 seconds
client.wait_until(...) do |w|
  w.max_attempts = 5
  w.delay = 5
end

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(...) do |w|

  # disable max attempts
  w.max_attempts = nil

  # poll for 1 hour, instead of a number of attempts
  w.before_wait do |attempts, response|
    throw :failure if Time.now - started_at > 3600
  end

end

Handling Errors

When a waiter is successful, it returns true. When a waiter fails, it raises an error. All errors raised extend from Aws::Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

#waiter_names ⇒ Array<Symbol>

Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:

Waiter Name Client Method Default Delay: Default Max Attempts:

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4