package wafv2
import "github.com/aws/aws-sdk-go-v2/service/wafv2"
Package wafv2 provides the API client, operations, and parameter types for AWS WAFV2.
WAF This is the latest version of the WAF API, released in November, 2019. The names of the entities that you use to access this API, like endpoints and namespaces, all have the versioning information added, like "V2" or "v2", to distinguish from the prior version. We recommend migrating your resources to this version, because it has a number of significant improvements. If you used WAF prior to this release, you can't use this WAFV2 API to access any WAF resources that you created before. You can access your old rules, web ACLs, and other WAF resources only through the WAF Classic APIs. The WAF Classic APIs have retained the prior names, endpoints, and namespaces. For information, including how to migrate your WAF resources to this version, see the WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to Amazon CloudFront, an Amazon API Gateway REST API, an Application Load Balancer, or an AppSync GraphQL API. WAF also lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, the Amazon API Gateway REST API, CloudFront distribution, the Application Load Balancer, or the AppSync GraphQL API responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You also can configure CloudFront to return a custom error page when a request is blocked. This API guide is for developers who need detailed information about WAF API actions, data types, and errors. For detailed information about WAF features and an overview of how to use WAF, see the WAF Developer Guide (https://docs.aws.amazon.com/waf/latest/developerguide/what-is-aws-waf.html). You can make calls using the endpoints listed in WAF endpoints and quotas (https://docs.aws.amazon.com/general/latest/gr/waf.html).
* For regional applications, you can use any of the endpoints in the list. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API.
* For Amazon CloudFront applications, you must use the API endpoint listed for US East (N. Virginia): us-east-1.
Alternatively, you can use one of the Amazon Web Services SDKs to access an API that's tailored to the programming language or platform that you're using. For more information, see Amazon Web Services SDKs (http://aws.amazon.com/tools/#SDKs). We currently provide two versions of the WAF API: this API and the prior versions, the classic WAF APIs. This new API provides the same functionality as the older versions, with the following major improvements:
* You use one API for both global and regional applications. Where you need to distinguish the scope, you specify a Scope parameter and set it to CLOUDFRONT or REGIONAL.
* You can define a web ACL or rule group with a single call, and update it with a single call. You define all rule specifications in JSON format, and pass them to your rule group or web ACL calls.
* The limits WAF places on the use of rules more closely reflects the cost of running each type of rule. Rule groups include capacity settings, so you know the maximum cost of a rule group when you use it.
Index ¶
- Constants
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
- func WithEndpointResolver(v EndpointResolver) func(*Options)
- type AssociateWebACLInput
- type AssociateWebACLOutput
- type CheckCapacityInput
- type CheckCapacityOutput
- type Client
- func New(options Options, optFns ...func(*Options)) *Client
- func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client
- func (c *Client) AssociateWebACL(ctx context.Context, params *AssociateWebACLInput, optFns ...func(*Options)) (*AssociateWebACLOutput, error)
- func (c *Client) CheckCapacity(ctx context.Context, params *CheckCapacityInput, optFns ...func(*Options)) (*CheckCapacityOutput, error)
- func (c *Client) CreateIPSet(ctx context.Context, params *CreateIPSetInput, optFns ...func(*Options)) (*CreateIPSetOutput, error)
- func (c *Client) CreateRegexPatternSet(ctx context.Context, params *CreateRegexPatternSetInput, optFns ...func(*Options)) (*CreateRegexPatternSetOutput, error)
- func (c *Client) CreateRuleGroup(ctx context.Context, params *CreateRuleGroupInput, optFns ...func(*Options)) (*CreateRuleGroupOutput, error)
- func (c *Client) CreateWebACL(ctx context.Context, params *CreateWebACLInput, optFns ...func(*Options)) (*CreateWebACLOutput, error)
- func (c *Client) DeleteFirewallManagerRuleGroups(ctx context.Context, params *DeleteFirewallManagerRuleGroupsInput, optFns ...func(*Options)) (*DeleteFirewallManagerRuleGroupsOutput, error)
- func (c *Client) DeleteIPSet(ctx context.Context, params *DeleteIPSetInput, optFns ...func(*Options)) (*DeleteIPSetOutput, error)
- func (c *Client) DeleteLoggingConfiguration(ctx context.Context, params *DeleteLoggingConfigurationInput, optFns ...func(*Options)) (*DeleteLoggingConfigurationOutput, error)
- func (c *Client) DeletePermissionPolicy(ctx context.Context, params *DeletePermissionPolicyInput, optFns ...func(*Options)) (*DeletePermissionPolicyOutput, error)
- func (c *Client) DeleteRegexPatternSet(ctx context.Context, params *DeleteRegexPatternSetInput, optFns ...func(*Options)) (*DeleteRegexPatternSetOutput, error)
- func (c *Client) DeleteRuleGroup(ctx context.Context, params *DeleteRuleGroupInput, optFns ...func(*Options)) (*DeleteRuleGroupOutput, error)
- func (c *Client) DeleteWebACL(ctx context.Context, params *DeleteWebACLInput, optFns ...func(*Options)) (*DeleteWebACLOutput, error)
- func (c *Client) DescribeManagedRuleGroup(ctx context.Context, params *DescribeManagedRuleGroupInput, optFns ...func(*Options)) (*DescribeManagedRuleGroupOutput, error)
- func (c *Client) DisassociateWebACL(ctx context.Context, params *DisassociateWebACLInput, optFns ...func(*Options)) (*DisassociateWebACLOutput, error)
- func (c *Client) GenerateMobileSdkReleaseUrl(ctx context.Context, params *GenerateMobileSdkReleaseUrlInput, optFns ...func(*Options)) (*GenerateMobileSdkReleaseUrlOutput, error)
- func (c *Client) GetIPSet(ctx context.Context, params *GetIPSetInput, optFns ...func(*Options)) (*GetIPSetOutput, error)
- func (c *Client) GetLoggingConfiguration(ctx context.Context, params *GetLoggingConfigurationInput, optFns ...func(*Options)) (*GetLoggingConfigurationOutput, error)
- func (c *Client) GetManagedRuleSet(ctx context.Context, params *GetManagedRuleSetInput, optFns ...func(*Options)) (*GetManagedRuleSetOutput, error)
- func (c *Client) GetMobileSdkRelease(ctx context.Context, params *GetMobileSdkReleaseInput, optFns ...func(*Options)) (*GetMobileSdkReleaseOutput, error)
- func (c *Client) GetPermissionPolicy(ctx context.Context, params *GetPermissionPolicyInput, optFns ...func(*Options)) (*GetPermissionPolicyOutput, error)
- func (c *Client) GetRateBasedStatementManagedKeys(ctx context.Context, params *GetRateBasedStatementManagedKeysInput, optFns ...func(*Options)) (*GetRateBasedStatementManagedKeysOutput, error)
- func (c *Client) GetRegexPatternSet(ctx context.Context, params *GetRegexPatternSetInput, optFns ...func(*Options)) (*GetRegexPatternSetOutput, error)
- func (c *Client) GetRuleGroup(ctx context.Context, params *GetRuleGroupInput, optFns ...func(*Options)) (*GetRuleGroupOutput, error)
- func (c *Client) GetSampledRequests(ctx context.Context, params *GetSampledRequestsInput, optFns ...func(*Options)) (*GetSampledRequestsOutput, error)
- func (c *Client) GetWebACL(ctx context.Context, params *GetWebACLInput, optFns ...func(*Options)) (*GetWebACLOutput, error)
- func (c *Client) GetWebACLForResource(ctx context.Context, params *GetWebACLForResourceInput, optFns ...func(*Options)) (*GetWebACLForResourceOutput, error)
- func (c *Client) ListAvailableManagedRuleGroupVersions(ctx context.Context, params *ListAvailableManagedRuleGroupVersionsInput, optFns ...func(*Options)) (*ListAvailableManagedRuleGroupVersionsOutput, error)
- func (c *Client) ListAvailableManagedRuleGroups(ctx context.Context, params *ListAvailableManagedRuleGroupsInput, optFns ...func(*Options)) (*ListAvailableManagedRuleGroupsOutput, error)
- func (c *Client) ListIPSets(ctx context.Context, params *ListIPSetsInput, optFns ...func(*Options)) (*ListIPSetsOutput, error)
- func (c *Client) ListLoggingConfigurations(ctx context.Context, params *ListLoggingConfigurationsInput, optFns ...func(*Options)) (*ListLoggingConfigurationsOutput, error)
- func (c *Client) ListManagedRuleSets(ctx context.Context, params *ListManagedRuleSetsInput, optFns ...func(*Options)) (*ListManagedRuleSetsOutput, error)
- func (c *Client) ListMobileSdkReleases(ctx context.Context, params *ListMobileSdkReleasesInput, optFns ...func(*Options)) (*ListMobileSdkReleasesOutput, error)
- func (c *Client) ListRegexPatternSets(ctx context.Context, params *ListRegexPatternSetsInput, optFns ...func(*Options)) (*ListRegexPatternSetsOutput, error)
- func (c *Client) ListResourcesForWebACL(ctx context.Context, params *ListResourcesForWebACLInput, optFns ...func(*Options)) (*ListResourcesForWebACLOutput, error)
- func (c *Client) ListRuleGroups(ctx context.Context, params *ListRuleGroupsInput, optFns ...func(*Options)) (*ListRuleGroupsOutput, error)
- func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)
- func (c *Client) ListWebACLs(ctx context.Context, params *ListWebACLsInput, optFns ...func(*Options)) (*ListWebACLsOutput, error)
- func (c *Client) PutLoggingConfiguration(ctx context.Context, params *PutLoggingConfigurationInput, optFns ...func(*Options)) (*PutLoggingConfigurationOutput, error)
- func (c *Client) PutManagedRuleSetVersions(ctx context.Context, params *PutManagedRuleSetVersionsInput, optFns ...func(*Options)) (*PutManagedRuleSetVersionsOutput, error)
- func (c *Client) PutPermissionPolicy(ctx context.Context, params *PutPermissionPolicyInput, optFns ...func(*Options)) (*PutPermissionPolicyOutput, error)
- func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
- func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
- func (c *Client) UpdateIPSet(ctx context.Context, params *UpdateIPSetInput, optFns ...func(*Options)) (*UpdateIPSetOutput, error)
- func (c *Client) UpdateManagedRuleSetVersionExpiryDate(ctx context.Context, params *UpdateManagedRuleSetVersionExpiryDateInput, optFns ...func(*Options)) (*UpdateManagedRuleSetVersionExpiryDateOutput, error)
- func (c *Client) UpdateRegexPatternSet(ctx context.Context, params *UpdateRegexPatternSetInput, optFns ...func(*Options)) (*UpdateRegexPatternSetOutput, error)
- func (c *Client) UpdateRuleGroup(ctx context.Context, params *UpdateRuleGroupInput, optFns ...func(*Options)) (*UpdateRuleGroupOutput, error)
- func (c *Client) UpdateWebACL(ctx context.Context, params *UpdateWebACLInput, optFns ...func(*Options)) (*UpdateWebACLOutput, error)
- type CreateIPSetInput
- type CreateIPSetOutput
- type CreateRegexPatternSetInput
- type CreateRegexPatternSetOutput
- type CreateRuleGroupInput
- type CreateRuleGroupOutput
- type CreateWebACLInput
- type CreateWebACLOutput
- type DeleteFirewallManagerRuleGroupsInput
- type DeleteFirewallManagerRuleGroupsOutput
- type DeleteIPSetInput
- type DeleteIPSetOutput
- type DeleteLoggingConfigurationInput
- type DeleteLoggingConfigurationOutput
- type DeletePermissionPolicyInput
- type DeletePermissionPolicyOutput
- type DeleteRegexPatternSetInput
- type DeleteRegexPatternSetOutput
- type DeleteRuleGroupInput
- type DeleteRuleGroupOutput
- type DeleteWebACLInput
- type DeleteWebACLOutput
- type DescribeManagedRuleGroupInput
- type DescribeManagedRuleGroupOutput
- type DisassociateWebACLInput
- type DisassociateWebACLOutput
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- type GenerateMobileSdkReleaseUrlInput
- type GenerateMobileSdkReleaseUrlOutput
- type GetIPSetInput
- type GetIPSetOutput
- type GetLoggingConfigurationInput
- type GetLoggingConfigurationOutput
- type GetManagedRuleSetInput
- type GetManagedRuleSetOutput
- type GetMobileSdkReleaseInput
- type GetMobileSdkReleaseOutput
- type GetPermissionPolicyInput
- type GetPermissionPolicyOutput
- type GetRateBasedStatementManagedKeysInput
- type GetRateBasedStatementManagedKeysOutput
- type GetRegexPatternSetInput
- type GetRegexPatternSetOutput
- type GetRuleGroupInput
- type GetRuleGroupOutput
- type GetSampledRequestsInput
- type GetSampledRequestsOutput
- type GetWebACLForResourceInput
- type GetWebACLForResourceOutput
- type GetWebACLInput
- type GetWebACLOutput
- type HTTPClient
- type HTTPSignerV4
- type ListAvailableManagedRuleGroupVersionsInput
- type ListAvailableManagedRuleGroupVersionsOutput
- type ListAvailableManagedRuleGroupsInput
- type ListAvailableManagedRuleGroupsOutput
- type ListIPSetsInput
- type ListIPSetsOutput
- type ListLoggingConfigurationsInput
- type ListLoggingConfigurationsOutput
- type ListManagedRuleSetsInput
- type ListManagedRuleSetsOutput
- type ListMobileSdkReleasesInput
- type ListMobileSdkReleasesOutput
- type ListRegexPatternSetsInput
- type ListRegexPatternSetsOutput
- type ListResourcesForWebACLInput
- type ListResourcesForWebACLOutput
- type ListRuleGroupsInput
- type ListRuleGroupsOutput
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type ListWebACLsInput
- type ListWebACLsOutput
- type Options
- type PutLoggingConfigurationInput
- type PutLoggingConfigurationOutput
- type PutManagedRuleSetVersionsInput
- type PutManagedRuleSetVersionsOutput
- type PutPermissionPolicyInput
- type PutPermissionPolicyOutput
- type ResolveEndpoint
- func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
- func (*ResolveEndpoint) ID() string
- type TagResourceInput
- type TagResourceOutput
- type UntagResourceInput
- type UntagResourceOutput
- type UpdateIPSetInput
- type UpdateIPSetOutput
- type UpdateManagedRuleSetVersionExpiryDateInput
- type UpdateManagedRuleSetVersionExpiryDateOutput
- type UpdateRegexPatternSetInput
- type UpdateRegexPatternSetOutput
- type UpdateRuleGroupInput
- type UpdateRuleGroupOutput
- type UpdateWebACLInput
- type UpdateWebACLOutput
Constants ¶
const ServiceAPIVersion = "2019-07-29"
const ServiceID = "WAFV2"
Functions ¶
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
func WithAPIOptions ¶
func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
WithAPIOptions returns a functional option for setting the Client's APIOptions option.
func WithEndpointResolver ¶
func WithEndpointResolver(v EndpointResolver) func(*Options)
WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.
Types ¶
type AssociateWebACLInput ¶
type AssociateWebACLInput struct { // The Amazon Resource Name (ARN) of the resource to associate with the web ACL. // The ARN must be in one of the following formats: // // * For an Application Load // Balancer: // arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id // // * // For an Amazon API Gateway REST API: // arn:aws:apigateway:region::/restapis/api-id/stages/stage-name // // * For an AppSync // GraphQL API: arn:aws:appsync:region:account-id:apis/GraphQLApiId // // This member is required. ResourceArn *string // The Amazon Resource Name (ARN) of the web ACL that you want to associate with // the resource. // // This member is required. WebACLArn *string // contains filtered or unexported fields }
type AssociateWebACLOutput ¶
type AssociateWebACLOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CheckCapacityInput ¶
type CheckCapacityInput struct { // An array of Rule that you're configuring to use in a rule group or web ACL. // // This member is required. Rules []types.Rule // Specifies 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 AppSync GraphQL API. To work with // CloudFront, you must also specify the Region US East (N. Virginia) as // follows: // // * CLI - Specify the Region when you use the CloudFront scope: // --scope=CLOUDFRONT --region=us-east-1. // // * API and SDKs - For all calls, use the // Region endpoint us-east-1. // // This member is required. Scope types.Scope // contains filtered or unexported fields }
type CheckCapacityOutput ¶
type CheckCapacityOutput struct { // The capacity required by the rules and scope. Capacity int64 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client provides the API client to make operations call for AWS WAFV2.
func New ¶
New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.
func NewFromConfig ¶
NewFromConfig returns a new client from the provided config.
func (*Client) AssociateWebACL ¶
func (c *Client) AssociateWebACL(ctx context.Context, params *AssociateWebACLInput, optFns ...func(*Options)) (*AssociateWebACLOutput, error)
Associates a web ACL with a regional application resource, to protect the resource. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API. For Amazon 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 (https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html).
func (*Client) CheckCapacity ¶
func (c *Client) CheckCapacity(ctx context.Context, params *CheckCapacityInput, optFns ...func(*Options)) (*CheckCapacityOutput, error)
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. WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. 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.
func (*Client) CreateIPSet ¶
func (c *Client) CreateIPSet(ctx context.Context, params *CreateIPSetInput, optFns ...func(*Options)) (*CreateIPSetOutput, error)
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 WAF to block them using an IPSet that lists those IP addresses.
func (*Client) CreateRegexPatternSet ¶
func (c *Client) CreateRegexPatternSet(ctx context.Context, params *CreateRegexPatternSetInput, optFns ...func(*Options)) (*CreateRegexPatternSetOutput, error)
Creates a RegexPatternSet, which you reference in a RegexPatternSetReferenceStatement, to have WAF inspect a web request component for the specified patterns.
func (*Client) CreateRuleGroup ¶
func (c *Client) CreateRuleGroup(ctx context.Context, params *CreateRuleGroupInput, optFns ...func(*Options)) (*CreateRuleGroupOutput, error)
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.
func (*Client) CreateWebACL ¶
func (c *Client) CreateWebACL(ctx context.Context, params *CreateWebACLInput, optFns ...func(*Options)) (*CreateWebACLOutput, error)
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 Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, or an AppSync GraphQL API.
func (*Client) DeleteFirewallManagerRuleGroups ¶
func (c *Client) DeleteFirewallManagerRuleGroups(ctx context.Context, params *DeleteFirewallManagerRuleGroupsInput, optFns ...func(*Options)) (*DeleteFirewallManagerRuleGroupsOutput, error)
Deletes all rule groups that are managed by Firewall Manager for the specified web ACL. You can only use this if ManagedByFirewallManager is false in the specified WebACL.
func (*Client) DeleteIPSet ¶
func (c *Client) DeleteIPSet(ctx context.Context, params *DeleteIPSetInput, optFns ...func(*Options)) (*DeleteIPSetOutput, error)
Deletes the specified IPSet.
func (*Client) DeleteLoggingConfiguration ¶
func (c *Client) DeleteLoggingConfiguration(ctx context.Context, params *DeleteLoggingConfigurationInput, optFns ...func(*Options)) (*DeleteLoggingConfigurationOutput, error)
Deletes the LoggingConfiguration from the specified web ACL.
func (*Client) DeletePermissionPolicy ¶
func (c *Client) DeletePermissionPolicy(ctx context.Context, params *DeletePermissionPolicyInput, optFns ...func(*Options)) (*DeletePermissionPolicyOutput, error)
Permanently deletes an IAM policy from the specified rule group. You must be the owner of the rule group to perform this operation.
func (*Client) DeleteRegexPatternSet ¶
func (c *Client) DeleteRegexPatternSet(ctx context.Context, params *DeleteRegexPatternSetInput, optFns ...func(*Options)) (*DeleteRegexPatternSetOutput, error)
Deletes the specified RegexPatternSet.
func (*Client) DeleteRuleGroup ¶
func (c *Client) DeleteRuleGroup(ctx context.Context, params *DeleteRuleGroupInput, optFns ...func(*Options)) (*DeleteRuleGroupOutput, error)
Deletes the specified RuleGroup.
func (*Client) DeleteWebACL ¶
func (c *Client) DeleteWebACL(ctx context.Context, params *DeleteWebACLInput, optFns ...func(*Options)) (*DeleteWebACLOutput, error)
Deletes the specified WebACL. You can only use this if ManagedByFirewallManager is false in the specified WebACL.
func (*Client) DescribeManagedRuleGroup ¶
func (c *Client) DescribeManagedRuleGroup(ctx context.Context, params *DescribeManagedRuleGroupInput, optFns ...func(*Options)) (*DescribeManagedRuleGroupOutput, error)
Provides high-level information for a managed rule group, including descriptions of the rules.
func (*Client) DisassociateWebACL ¶
func (c *Client) DisassociateWebACL(ctx context.Context, params *DisassociateWebACLInput, optFns ...func(*Options)) (*DisassociateWebACLOutput, error)
Disassociates a web ACL from a regional application resource. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, or an AppSync GraphQL API. For Amazon 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 (https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html).
func (*Client) GenerateMobileSdkReleaseUrl ¶
func (c *Client) GenerateMobileSdkReleaseUrl(ctx context.Context, params *GenerateMobileSdkReleaseUrlInput, optFns ...func(*Options)) (*GenerateMobileSdkReleaseUrlOutput, error)
Generates a presigned download URL for the specified release of the mobile SDK. The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage Security Token Service (STS) security tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see WAF client application integration (https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html) in the WAF Developer Guide.
func (*Client) GetIPSet ¶
func (c *Client) GetIPSet(ctx context.Context, params *GetIPSetInput, optFns ...func(*Options)) (*GetIPSetOutput, error)
Retrieves the specified IPSet.
func (*Client) GetLoggingConfiguration ¶
func (c *Client) GetLoggingConfiguration(ctx context.Context, params *GetLoggingConfigurationInput, optFns ...func(*Options)) (*GetLoggingConfigurationOutput, error)
Returns the LoggingConfiguration for the specified web ACL.
func (*Client) GetManagedRuleSet ¶
func (c *Client) GetManagedRuleSet(ctx context.Context, params *GetManagedRuleSetInput, optFns ...func(*Options)) (*GetManagedRuleSetOutput, error)
Retrieves the specified managed rule set. This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers. Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.
func (*Client) GetMobileSdkRelease ¶
func (c *Client) GetMobileSdkRelease(ctx context.Context, params *GetMobileSdkReleaseInput, optFns ...func(*Options)) (*GetMobileSdkReleaseOutput, error)
Retrieves information for the specified mobile SDK release, including release notes and tags. The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage Security Token Service (STS) security tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see WAF client application integration (https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html) in the WAF Developer Guide.
func (*Client) GetPermissionPolicy ¶
func (c *Client) GetPermissionPolicy(ctx context.Context, params *GetPermissionPolicyInput, optFns ...func(*Options)) (*GetPermissionPolicyOutput, error)
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.
func (*Client) GetRateBasedStatementManagedKeys ¶
func (c *Client) GetRateBasedStatementManagedKeys(ctx context.Context, params *GetRateBasedStatementManagedKeysInput, optFns ...func(*Options)) (*GetRateBasedStatementManagedKeysOutput, error)
Retrieves the keys that are currently blocked by a rate-based rule instance. The maximum number of managed keys that can be blocked for a single rate-based rule instance is 10,000. If more than 10,000 addresses exceed the rate limit, those with the highest rates are blocked. For a rate-based rule that you've defined inside a rule group, provide the name of the rule group reference statement in your request, in addition to the rate-based rule name and the web ACL name. WAF monitors web requests and manages keys independently for each unique combination of web ACL, optional rule group, and rate-based rule. For example, if you define a rate-based rule inside a rule group, and then use the rule group in a web ACL, WAF monitors web requests and manages keys for that web ACL, rule group reference statement, and rate-based rule instance. If you use the same rule group in a second web ACL, WAF monitors web requests and manages keys for this second usage completely independent of your first.
func (*Client) GetRegexPatternSet ¶
func (c *Client) GetRegexPatternSet(ctx context.Context, params *GetRegexPatternSetInput, optFns ...func(*Options)) (*GetRegexPatternSetOutput, error)
Retrieves the specified RegexPatternSet.
func (*Client) GetRuleGroup ¶
func (c *Client) GetRuleGroup(ctx context.Context, params *GetRuleGroupInput, optFns ...func(*Options)) (*GetRuleGroupOutput, error)
Retrieves the specified RuleGroup.
func (*Client) GetSampledRequests ¶
func (c *Client) GetSampledRequests(ctx context.Context, params *GetSampledRequestsInput, optFns ...func(*Options)) (*GetSampledRequestsOutput, error)
Gets detailed information about a specified number of requests--a sample--that WAF randomly selects from among the first 5,000 requests that your Amazon Web Services 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 WAF selected the requests in the sample.
func (*Client) GetWebACL ¶
func (c *Client) GetWebACL(ctx context.Context, params *GetWebACLInput, optFns ...func(*Options)) (*GetWebACLOutput, error)
Retrieves the specified WebACL.
func (*Client) GetWebACLForResource ¶
func (c *Client) GetWebACLForResource(ctx context.Context, params *GetWebACLForResourceInput, optFns ...func(*Options)) (*GetWebACLForResourceOutput, error)
Retrieves the WebACL for the specified resource.
func (*Client) ListAvailableManagedRuleGroupVersions ¶
func (c *Client) ListAvailableManagedRuleGroupVersions(ctx context.Context, params *ListAvailableManagedRuleGroupVersionsInput, optFns ...func(*Options)) (*ListAvailableManagedRuleGroupVersionsOutput, error)
Returns a list of the available versions for the specified managed rule group.
func (*Client) ListAvailableManagedRuleGroups ¶
func (c *Client) ListAvailableManagedRuleGroups(ctx context.Context, params *ListAvailableManagedRuleGroupsInput, optFns ...func(*Options)) (*ListAvailableManagedRuleGroupsOutput, error)
Retrieves an array of managed rule groups that are available for you to use. This list includes all Amazon Web Services Managed Rules rule groups and all of the Amazon Web Services Marketplace managed rule groups that you're subscribed to.
func (*Client) ListIPSets ¶
func (c *Client) ListIPSets(ctx context.Context, params *ListIPSetsInput, optFns ...func(*Options)) (*ListIPSetsOutput, error)
Retrieves an array of IPSetSummary objects for the IP sets that you manage.
func (*Client) ListLoggingConfigurations ¶
func (c *Client) ListLoggingConfigurations(ctx context.Context, params *ListLoggingConfigurationsInput, optFns ...func(*Options)) (*ListLoggingConfigurationsOutput, error)
Retrieves an array of your LoggingConfiguration objects.
func (*Client) ListManagedRuleSets ¶
func (c *Client) ListManagedRuleSets(ctx context.Context, params *ListManagedRuleSetsInput, optFns ...func(*Options)) (*ListManagedRuleSetsOutput, error)
Retrieves the managed rule sets that you own. This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers. Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.
func (*Client) ListMobileSdkReleases ¶
func (c *Client) ListMobileSdkReleases(ctx context.Context, params *ListMobileSdkReleasesInput, optFns ...func(*Options)) (*ListMobileSdkReleasesOutput, error)
Retrieves a list of the available releases for the mobile SDK and the specified device platform. The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage Security Token Service (STS) security tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see WAF client application integration (https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html) in the WAF Developer Guide.
func (*Client) ListRegexPatternSets ¶
func (c *Client) ListRegexPatternSets(ctx context.Context, params *ListRegexPatternSetsInput, optFns ...func(*Options)) (*ListRegexPatternSetsOutput, error)
Retrieves an array of RegexPatternSetSummary objects for the regex pattern sets that you manage.
func (*Client) ListResourcesForWebACL ¶
func (c *Client) ListResourcesForWebACL(ctx context.Context, params *ListResourcesForWebACLInput, optFns ...func(*Options)) (*ListResourcesForWebACLOutput, error)
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 Amazon CloudFront resources, use the CloudFront call ListDistributionsByWebACLId.
func (*Client) ListRuleGroups ¶
func (c *Client) ListRuleGroups(ctx context.Context, params *ListRuleGroupsInput, optFns ...func(*Options)) (*ListRuleGroupsOutput, error)
Retrieves an array of RuleGroupSummary objects for the rule groups that you manage.
func (*Client) ListTagsForResource ¶
func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)
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 Amazon Web Services resource, up to 50 tags for a resource. You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF console.
func (*Client) ListWebACLs ¶
func (c *Client) ListWebACLs(ctx context.Context, params *ListWebACLsInput, optFns ...func(*Options)) (*ListWebACLsOutput, error)
Retrieves an array of WebACLSummary objects for the web ACLs that you manage.
func (*Client) PutLoggingConfiguration ¶
func (c *Client) PutLoggingConfiguration(ctx context.Context, params *PutLoggingConfigurationInput, optFns ...func(*Options)) (*PutLoggingConfigurationOutput, error)
Enables the specified LoggingConfiguration, to start logging from a web ACL, according to the configuration provided. You can define one logging destination per web ACL. You can access information about the traffic that WAF inspects using the following steps:
* Create your logging destination. You can use an Amazon CloudWatch Logs log group, an Amazon Simple Storage Service (Amazon S3) bucket, or an Amazon Kinesis Data Firehose. For information about configuring logging destinations and the permissions that are required for each, see Logging web ACL traffic information (https://docs.aws.amazon.com/waf/latest/developerguide/logging.html) in the WAF Developer Guide.
* Associate your logging destination to your web ACL using a PutLoggingConfiguration request.
When you successfully enable logging using a PutLoggingConfiguration request, WAF creates an additional role or policy that is required to write logs to the logging destination. For an Amazon CloudWatch Logs log group, WAF creates a resource policy on the log group. For an Amazon S3 bucket, WAF creates a bucket policy. For an Amazon Kinesis Data Firehose, WAF creates a service-linked role. For additional information about web ACL logging, see Logging web ACL traffic information (https://docs.aws.amazon.com/waf/latest/developerguide/logging.html) in the WAF Developer Guide. This operation completely replaces the mutable specifications that you already have for the logging configuration with the ones that you provide to this call. To modify the logging configuration, retrieve it by calling GetLoggingConfiguration, update the settings as needed, and then provide the complete logging configuration specification to this call.
func (*Client) PutManagedRuleSetVersions ¶
func (c *Client) PutManagedRuleSetVersions(ctx context.Context, params *PutManagedRuleSetVersionsInput, optFns ...func(*Options)) (*PutManagedRuleSetVersionsOutput, error)
Defines the versions of your managed rule set that you are offering to the customers. Customers see your offerings as managed rule groups with versioning. This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers. Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate. Customers retrieve their managed rule group list by calling ListAvailableManagedRuleGroups. The name that you provide here for your managed rule set is the name the customer sees for the corresponding managed rule group. Customers can retrieve the available versions for a managed rule group by calling ListAvailableManagedRuleGroupVersions. You provide a rule group specification for each version. For each managed rule set, you must specify a version that you recommend using. To initiate the expiration of a managed rule group version, use UpdateManagedRuleSetVersionExpiryDate.
func (*Client) PutPermissionPolicy ¶
func (c *Client) PutPermissionPolicy(ctx context.Context, params *PutPermissionPolicyInput, optFns ...func(*Options)) (*PutPermissionPolicyOutput, error)
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.
func (*Client) TagResource ¶
func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
Associates tags with the specified Amazon Web Services 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 Amazon Web Services resource, up to 50 tags for a resource. You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF console.
func (*Client) UntagResource ¶
func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
Disassociates tags from an Amazon Web Services resource. Tags are key:value pairs that you can associate with Amazon Web Services 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 Amazon Web Services resource.
func (*Client) UpdateIPSet ¶
func (c *Client) UpdateIPSet(ctx context.Context, params *UpdateIPSetInput, optFns ...func(*Options)) (*UpdateIPSetOutput, error)
Updates the specified IPSet. This operation completely replaces the mutable specifications that you already have for the IP set with the ones that you provide to this call. To modify the IP set, retrieve it by calling GetIPSet, update the settings as needed, and then provide the complete IP set specification to this call.
func (*Client) UpdateManagedRuleSetVersionExpiryDate ¶
func (c *Client) UpdateManagedRuleSetVersionExpiryDate(ctx context.Context, params *UpdateManagedRuleSetVersionExpiryDateInput, optFns ...func(*Options)) (*UpdateManagedRuleSetVersionExpiryDateOutput, error)
Updates the expiration information for your managed rule set. Use this to initiate the expiration of a managed rule group version. After you initiate expiration for a version, WAF excludes it from the reponse to ListAvailableManagedRuleGroupVersions for the managed rule group. This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers. Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.
func (*Client) UpdateRegexPatternSet ¶
func (c *Client) UpdateRegexPatternSet(ctx context.Context, params *UpdateRegexPatternSetInput, optFns ...func(*Options)) (*UpdateRegexPatternSetOutput, error)
Updates the specified RegexPatternSet. This operation completely replaces the mutable specifications that you already have for the regex pattern set with the ones that you provide to this call. To modify the regex pattern set, retrieve it by calling GetRegexPatternSet, update the settings as needed, and then provide the complete regex pattern set specification to this call.
func (*Client) UpdateRuleGroup ¶
func (c *Client) UpdateRuleGroup(ctx context.Context, params *UpdateRuleGroupInput, optFns ...func(*Options)) (*UpdateRuleGroupOutput, error)
Updates the specified RuleGroup. This operation completely replaces the mutable specifications that you already have for the rule group with the ones that you provide to this call. To modify the rule group, retrieve it by calling GetRuleGroup, update the settings as needed, and then provide the complete rule group specification to this call. 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.
func (*Client) UpdateWebACL ¶
func (c *Client) UpdateWebACL(ctx context.Context, params *UpdateWebACLInput, optFns ...func(*Options)) (*UpdateWebACLOutput, error)
Updates the specified WebACL. This operation completely replaces the mutable specifications that you already have for the web ACL with the ones that you provide to this call. To modify the web ACL, retrieve it by calling GetWebACL, update the settings as needed, and then provide the complete web ACL specification to this call. 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 Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, or an AppSync GraphQL API.
type CreateIPSetInput ¶
type CreateIPSetInput struct { // Contains an array of strings that specifies zero or more IP addresses or blocks // of IP addresses in Classless Inter-Domain Routing (CIDR) notation. WAF supports // all IPv4 and IPv6 CIDR ranges except for /0. Example address strings: // // * To // configure WAF to allow, block, or count requests that originated from the IP // address 192.0.2.44, specify 192.0.2.44/32. // // * To configure WAF to allow, block, // or count requests that originated from IP addresses from 192.0.2.0 to // 192.0.2.255, specify 192.0.2.0/24. // // * To configure WAF to allow, block, or count // requests that originated from the IP address // 1111:0000:0000:0000:0000:0000:0000:0111, specify // 1111:0000:0000:0000:0000:0000:0000:0111/128. // // * To configure WAF to allow, // block, or count requests that originated from IP addresses // 1111:0000:0000:0000:0000:0000:0000:0000 to // 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify // 1111:0000:0000:0000:0000:0000:0000:0000/64. // // For more information about CIDR // notation, see the Wikipedia entry Classless Inter-Domain Routing // (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing). Example JSON // Addresses specifications: // // * Empty array: "Addresses": [] // // * Array with one // address: "Addresses": ["192.0.2.44/32"] // // * Array with three addresses: // "Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"] // // * INVALID // specification: "Addresses": [""] INVALID // // This member is required. Addresses []string // The version of the IP addresses, either IPV4 or IPV6. // // This member is required. IPAddressVersion types.IPAddressVersion // The name of the IP set. You cannot change the name of an IPSet after you create // it. // // This member is required. Name *string // Specifies 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 AppSync GraphQL API. To work with // CloudFront, you must also specify the Region US East (N. Virginia) as // follows: // // * CLI - Specify the Region when you use the CloudFront scope: // --scope=CLOUDFRONT --region=us-east-1. // // * API and SDKs - For all calls, use the // Region endpoint us-east-1. // // This member is required. Scope types.Scope // A description of the IP set that helps with identification. Description *string // An array of key:value pairs to associate with the resource. Tags []types.Tag // contains filtered or unexported fields }
type CreateIPSetOutput ¶
type CreateIPSetOutput struct { // High-level information about an IPSet, returned by operations like create and // list. This provides information like the ID, that you can use to retrieve and // manage an IPSet, and the ARN, that you provide to the IPSetReferenceStatement to // use the address set in a Rule. Summary *types.IPSetSummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateRegexPatternSetInput ¶
type CreateRegexPatternSetInput struct { // The name of the set. You cannot change the name after you create the set. // // This member is required. Name *string // Array of regular expression strings. // // This member is required. RegularExpressionList []types.Regex // Specifies 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 AppSync GraphQL API. To work with // CloudFront, you must also specify the Region US East (N. Virginia) as // follows: // // * CLI - Specify the Region when you use the CloudFront scope: // --scope=CLOUDFRONT --region=us-east-1. // // * API and SDKs - For all calls, use the // Region endpoint us-east-1. // // This member is required. Scope types.Scope // A description of the set that helps with identification. Description *string // An array of key:value pairs to associate with the resource. Tags []types.Tag // contains filtered or unexported fields }
type CreateRegexPatternSetOutput ¶
type CreateRegexPatternSetOutput struct { // High-level information about a RegexPatternSet, returned by operations like // create and list. This provides information like the ID, that you can use to // retrieve and manage a RegexPatternSet, and the ARN, that you provide to the // RegexPatternSetReferenceStatement to use the pattern set in a Rule. Summary *types.RegexPatternSetSummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateRuleGroupInput ¶
type CreateRuleGroupInput struct { // The web ACL capacity units (WCUs) required for this rule group. When you create // your own rule group, you define this, and you cannot change it after creation. // When you add or modify the rules in a rule group, WAF enforces this limit. You // can check the capacity for a set of rules using CheckCapacity. WAF uses WCUs to // calculate and control the operating resources that are used to run your rules, // rule groups, and web ACLs. 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. // // This member is required. Capacity int64 // The name of the rule group. You cannot change the name of a rule group after you // create it. // // This member is required. Name *string // Specifies 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 AppSync GraphQL API. To work with // CloudFront, you must also specify the Region US East (N. Virginia) as // follows: // // * CLI - Specify the Region when you use the CloudFront scope: // --scope=CLOUDFRONT --region=us-east-1. // // * API and SDKs - For all calls, use the // Region endpoint us-east-1. // // This member is required. Scope types.Scope // Defines and enables Amazon CloudWatch metrics and web request sample collection. // // This member is required. VisibilityConfig *types.VisibilityConfig // A map of custom response keys and content bodies. When you create a rule with a // block action, you can send a custom response to the web request. You define // these for the rule group, and then use them in the rules that you define in the // rule group. For information about customizing web requests and responses, see // Customizing web requests and responses in WAF // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) // in the WAF Developer Guide // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). For // information about the limits on count and size for custom request and response // settings, see WAF quotas // (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the WAF // Developer Guide // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). CustomResponseBodies map[string]types.CustomResponseBody // A description of the rule group that helps with identification. Description *string // The Rule statements used to identify the web requests that you want to allow, // block, or count. Each rule includes one top-level statement that WAF uses to // identify matching web requests, and parameters that govern how WAF handles them. Rules []types.Rule // An array of key:value pairs to associate with the resource. Tags []types.Tag // contains filtered or unexported fields }
type CreateRuleGroupOutput ¶
type CreateRuleGroupOutput struct { // High-level information about a RuleGroup, returned by operations like create and // list. This provides information like the ID, that you can use to retrieve and // manage a RuleGroup, and the ARN, that you provide to the // RuleGroupReferenceStatement to use the rule group in a Rule. Summary *types.RuleGroupSummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateWebACLInput ¶
type CreateWebACLInput struct { // The action to perform if none of the Rules contained in the WebACL match. // // This member is required. DefaultAction *types.DefaultAction // The name of the web ACL. You cannot change the name of a web ACL after you // create it. // // This member is required. Name *string // Specifies 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 AppSync GraphQL API. To work with // CloudFront, you must also specify the Region US East (N. Virginia) as // follows: // // * CLI - Specify the Region when you use the CloudFront scope: // --scope=CLOUDFRONT --region=us-east-1. // // * API and SDKs - For all calls, use the // Region endpoint us-east-1. // // This member is required. Scope types.Scope // Defines and enables Amazon CloudWatch metrics and web request sample collection. // // This member is required. VisibilityConfig *types.VisibilityConfig // Specifies how WAF should handle CAPTCHA evaluations for rules that don't have // their own CaptchaConfig settings. If you don't specify this, WAF uses its // default settings for CaptchaConfig. CaptchaConfig *types.CaptchaConfig // A map of custom response keys and content bodies. When you create a rule with a // block action, you can send a custom response to the web request. You define // these for the web ACL, and then use them in the rules and default actions that // you define in the web ACL. For information about customizing web requests and // responses, see Customizing web requests and responses in WAF // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) // in the WAF Developer Guide // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). For // information about the limits on count and size for custom request and response // settings, see WAF quotas // (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the WAF // Developer Guide // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). CustomResponseBodies map[string]types.CustomResponseBody // A description of the web ACL that helps with identification. Description *string // The Rule statements used to identify the web requests that you want to allow, // block, or count. Each rule includes one top-level statement that WAF uses to // identify matching web requests, and parameters that govern how WAF handles them. Rules []types.Rule // An array of key:value pairs to associate with the resource. Tags []types.Tag // contains filtered or unexported fields }
type CreateWebACLOutput ¶
type CreateWebACLOutput struct { // High-level information about a WebACL, returned by operations like create and // list. This provides information like the ID, that you can use to retrieve and // manage a WebACL, and the ARN, that you provide to operations like // AssociateWebACL. Summary *types.WebACLSummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteFirewallManagerRuleGroupsInput ¶
type DeleteFirewallManagerRuleGroupsInput struct { // The Amazon Resource Name (ARN) of the web ACL. // // This member is required. WebACLArn *string // A token used for optimistic locking. WAF returns a token to your get and list // requests, to mark the state of the entity at the time of the request. To make // changes to the entity associated with the token, you provide the token to // operations like update and delete. WAF uses the token to ensure that no changes // have been made to the entity since you last retrieved it. If a change has been // made, the update fails with a WAFOptimisticLockException. If this happens, // perform another get, and use the new token returned by that operation. // // This member is required. WebACLLockToken *string // contains filtered or unexported fields }
type DeleteFirewallManagerRuleGroupsOutput ¶
type DeleteFirewallManagerRuleGroupsOutput struct { // A token used for optimistic locking. WAF returns a token to your get and list // requests, to mark the state of the entity at the time of the request. To make // changes to the entity associated with the token, you provide the token to // operations like update and delete. WAF uses the token to ensure that no changes // have been made to the entity since you last retrieved it. If a change has been // made, the update fails with a WAFOptimisticLockException. If this happens, // perform another get, and use the new token returned by that operation. NextWebACLLockToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteIPSetInput ¶
type DeleteIPSetInput struct { // A unique identifier for the set. This ID is returned in the responses to create // and list commands. You provide it to operations like update and delete. // // This member is required. Id *string // A token used for optimistic locking. WAF returns a token to your get and list // requests, to mark the state of the entity at the time of the request. To make // changes to the entity associated with the token, you provide the token to // operations like update and delete. WAF uses the token to ensure that no changes // have been made to the entity since you last retrieved it. If a change has been // made, the update fails with a WAFOptimisticLockException. If this happens, // perform another get, and use the new token returned by that operation. // // This member is required. LockToken *string // The name of the IP set. You cannot change the name of an IPSet after you create // it. // // This member is required. Name *string // Specifies 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 AppSync GraphQL API. To work with // CloudFront, you must also specify the Region US East (N. Virginia) as // follows: // // * CLI - Specify the Region when you use the CloudFront scope: // --scope=CLOUDFRONT --region=us-east-1. // // * API and SDKs - For all calls, use the // Region endpoint us-east-1. // // This member is required. Scope types.Scope // contains filtered or unexported fields }
type DeleteIPSetOutput ¶
type DeleteIPSetOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteLoggingConfigurationInput ¶
type DeleteLoggingConfigurationInput struct { // The Amazon Resource Name (ARN) of the web ACL from which you want to delete the // LoggingConfiguration. // // This member is required. ResourceArn *string // contains filtered or unexported fields }
type DeleteLoggingConfigurationOutput ¶
type DeleteLoggingConfigurationOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeletePermissionPolicyInput ¶
type DeletePermissionPolicyInput struct { // The Amazon Resource Name (ARN) of the rule group from which you want to delete // the policy. You must be the owner of the rule group to perform this operation. // // This member is required. ResourceArn *string // contains filtered or unexported fields }
type DeletePermissionPolicyOutput ¶
type DeletePermissionPolicyOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteRegexPatternSetInput ¶
type DeleteRegexPatternSetInput struct { // A unique identifier for the set. This ID is returned in the responses to create // and list commands. You provide it to operations like update and delete. // // This member is required. Id *string // A token used for optimistic locking. WAF returns a token to your get and list // requests, to mark the state of the entity at the time of the request. To make // changes to the entity associated with the token, you provide the token to // operations like update and delete. WAF uses the token to ensure that no changes // have been made to the entity since you last retrieved it. If a change has been // made, the update fails with a WAFOptimisticLockException. If this happens, // perform another get, and use the new token returned by that operation. // // This member is required. LockToken *string // The name of the set. You cannot change the name after you create the set. // // This member is required. Name *string // Specifies 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 AppSync GraphQL API. To work with // CloudFront, you must also specify the Region US East (N. Virginia) as // follows: // // * CLI - Specify the Region when you use the CloudFront scope: // --scope=CLOUDFRONT --region=us-east-1. // // * API and SDKs - For all calls, use the // Region endpoint us-east-1. // // This member is required. Scope types.Scope // contains filtered or unexported fields }
type DeleteRegexPatternSetOutput ¶
type DeleteRegexPatternSetOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteRuleGroupInput ¶
type DeleteRuleGroupInput struct { // A unique identifier for the rule group. This ID is returned in the responses to // create and list commands. You provide it to operations like update and delete. // // This member is required. Id *string // A token used for optimistic locking. WAF returns a token to your get and list // requests, to mark the state of the entity at the time of the request. To make // changes to the entity associated with the token, you provide the token to // operations like update and delete. WAF uses the token to ensure that no changes // have been made to the entity since you last retrieved it. If a change has been // made, the update fails with a WAFOptimisticLockException. If this happens, // perform another get, and use the new token returned by that operation. // // This member is required. LockToken *string // The name of the rule group. You cannot change the name of a rule group after you // create it. // // This member is required. Name *string // Specifies 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 AppSync GraphQL API. To work with // CloudFront, you must also specify the Region US East (N. Virginia) as // follows: // // * CLI - Specify the Region when you use the CloudFront scope: // --scope=CLOUDFRONT --region=us-east-1. // // * API and SDKs - For all calls, use the // Region endpoint us-east-1. // // This member is required. Scope types.Scope // contains filtered or unexported fields }
type DeleteRuleGroupOutput ¶
type DeleteRuleGroupOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteWebACLInput ¶
type DeleteWebACLInput struct { // The unique identifier for the web ACL. This ID is returned in the responses to // create and list commands. You provide it to operations like update and delete. // // This member is required. Id *string // A token used for optimistic locking. WAF returns a token to your get and list // requests, to mark the state of the entity at the time of the request. To make // changes to the entity associated with the token, you provide the token to // operations like update and delete. WAF uses the token to ensure that no changes // have been made to the entity since you last retrieved it. If a change has been // made, the update fails with a WAFOptimisticLockException. If this happens, // perform another get, and use the new token returned by that operation. // // This member is required. LockToken *string // The name of the web ACL. You cannot change the name of a web ACL after you // create it. // // This member is required. Name *string // Specifies 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 AppSync GraphQL API. To work with // CloudFront, you must also specify the Region US East (N. Virginia) as // follows: // // * CLI - Specify the Region when you use the CloudFront scope: // --scope=CLOUDFRONT --region=us-east-1. // // * API and SDKs - For all calls, use the // Region endpoint us-east-1. // // This member is required. Scope types.Scope // contains filtered or unexported fields }
type DeleteWebACLOutput ¶
type DeleteWebACLOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeManagedRuleGroupInput ¶
type DescribeManagedRuleGroupInput struct { // The name of the managed rule group. You use this, along with the vendor name, to // identify the rule group. // // This member is required. Name *string // Specifies 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 AppSync GraphQL API. To work with // CloudFront, you must also specify the Region US East (N. Virginia) as // follows: // // * CLI - Specify the Region when you use the CloudFront scope: // --scope=CLOUDFRONT --region=us-east-1. // // * API and SDKs - For all calls, use the // Region endpoint us-east-1. // // This member is required. Scope types.Scope // The name of the managed rule group vendor. You use this, along with the rule // group name, to identify the rule group. // // This member is required. VendorName *string // The version of the rule group. You can only use a version that is not scheduled // for expiration. If you don't provide this, WAF uses the vendor's default // version. VersionName *string // contains filtered or unexported fields }
type DescribeManagedRuleGroupOutput ¶
type DescribeManagedRuleGroupOutput struct { // The labels that one or more rules in this rule group add to matching web // requests. These labels are defined in the RuleLabels for a Rule. AvailableLabels []types.LabelSummary // The web ACL capacity units (WCUs) required for this rule group. WAF uses web ACL // capacity units (WCU) to calculate and control the operating resources that are // used to run your rules, rule groups, and web ACLs. WAF calculates capacity // differently for each rule type, to reflect each rule's relative cost. Rule group // capacity is fixed at creation, so users can plan their web ACL WCU usage when // they use a rule group. The WCU limit for web ACLs is 1,500. Capacity int64 // The labels that one or more rules in this rule group match against in label // match statements. These labels are defined in a LabelMatchStatement // specification, in the Statement definition of a rule. ConsumedLabels []types.LabelSummary // The label namespace prefix for this rule group. All labels added by rules in // this rule group have this prefix. // // * The syntax for the label namespace prefix // for a managed rule group is the following: awswaf:managed::: // // * When a rule with // a label matches a web request, WAF adds the fully qualified label to the // request. A fully qualified label is made up of the label namespace from the rule // group or web ACL where the rule is defined and the label from the rule, // separated by a colon: : LabelNamespace *string // Rules []types.RuleSummary // The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS // topic that's used to record changes to the managed rule group. You can subscribe // to the SNS topic to receive notifications when the managed rule group is // modified, such as for new versions and for version expiration. For more // information, see the Amazon Simple Notification Service Developer Guide // (https://docs.aws.amazon.com/sns/latest/dg/welcome.html). SnsTopicArn *string // The managed rule group's version. VersionName *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DisassociateWebACLInput ¶
type DisassociateWebACLInput struct { // The Amazon Resource Name (ARN) of the resource to disassociate from the web ACL. // The ARN must be in one of the following formats: // // * For an Application Load // Balancer: // arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id // // * // For an Amazon API Gateway REST API: // arn:aws:apigateway:region::/restapis/api-id/stages/stage-name // // * For an AppSync // GraphQL API: arn:aws:appsync:region:account-id:apis/GraphQLApiId // // This member is required. ResourceArn *string // contains filtered or unexported fields }
type DisassociateWebACLOutput ¶
type DisassociateWebACLOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type EndpointResolver ¶
type EndpointResolver interface { ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error) }
EndpointResolver interface for resolving service endpoints.
func EndpointResolverFromURL ¶
func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver
EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)
EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.
func (EndpointResolverFunc) ResolveEndpoint ¶
func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)
type EndpointResolverOptions ¶
type EndpointResolverOptions = internalendpoints.Options
EndpointResolverOptions is the service endpoint resolver options
type GenerateMobileSdkReleaseUrlInput ¶
type GenerateMobileSdkReleaseUrlInput struct { // The device platform. // // This member is required. Platform types.Platform // The release version. For the latest available version, specify LATEST. // // This member is required. ReleaseVersion *string // contains filtered or unexported fields }
type GenerateMobileSdkReleaseUrlOutput ¶
type GenerateMobileSdkReleaseUrlOutput struct { // The presigned download URL for the specified SDK release. Url *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetIPSetInput ¶
type GetIPSetInput struct { // A unique identifier for the set. This ID is returned in the responses to create // and list commands. You provide it to operations like update and delete. // // This member is required. Id *string // The name of the IP set. You cannot change the name of an IPSet after you create // it. // // This member is required. Name *string // Specifies 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 AppSync GraphQL API. To work with // CloudFront, you must also specify the Region US East (N. Virginia) as // follows: // // * CLI - Specify the Region when you use the CloudFront scope: // --scope=CLOUDFRONT --region=us-east-1. // // * API and SDKs - For all calls, use the // Region endpoint us-east-1. // // This member is required. Scope types.Scope // contains filtered or unexported fields }
type GetIPSetOutput ¶
type GetIPSetOutput struct { // IPSet *types.IPSet // A token used for optimistic locking. WAF returns a token to your get and list // requests, to mark the state of the entity at the time of the request. To make // changes to the entity associated with the token, you provide the token to // operations like update and delete. WAF uses the token to ensure that no changes // have been made to the entity since you last retrieved it. If a change has been // made, the update fails with a WAFOptimisticLockException. If this happens, // perform another get, and use the new token returned by that operation. LockToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetLoggingConfigurationInput ¶
type GetLoggingConfigurationInput struct { // The Amazon Resource Name (ARN) of the web ACL for which you want to get the // LoggingConfiguration. // // This member is required. ResourceArn *string // contains filtered or unexported fields }
type GetLoggingConfigurationOutput ¶
type GetLoggingConfigurationOutput struct { // The LoggingConfiguration for the specified web ACL. LoggingConfiguration *types.LoggingConfiguration // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetManagedRuleSetInput ¶
type GetManagedRuleSetInput struct { // A unique identifier for the managed rule set. The ID is returned in the // responses to commands like list. You provide it to operations like get and // update. // // This member is required. Id *string // The name of the managed rule set. You use this, along with the rule set ID, to // identify the rule set. This name is assigned to the corresponding managed rule // group, which your customers can access and use. // // This member is required. Name *string // Specifies 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 AppSync GraphQL API. To work with // CloudFront, you must also specify the Region US East (N. Virginia) as // follows: // // * CLI - Specify the Region when you use the CloudFront scope: // --scope=CLOUDFRONT --region=us-east-1. // // * API and SDKs - For all calls, use the // Region endpoint us-east-1. // // This member is required. Scope types.Scope // contains filtered or unexported fields }
type GetManagedRuleSetOutput ¶
type GetManagedRuleSetOutput struct { // A token used for optimistic locking. WAF returns a token to your get and list // requests, to mark the state of the entity at the time of the request. To make // changes to the entity associated with the token, you provide the token to // operations like update and delete. WAF uses the token to ensure that no changes // have been made to the entity since you last retrieved it. If a change has been // made, the update fails with a WAFOptimisticLockException. If this happens, // perform another get, and use the new token returned by that operation. LockToken *string // The managed rule set that you requested. ManagedRuleSet *types.ManagedRuleSet // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetMobileSdkReleaseInput ¶
type GetMobileSdkReleaseInput struct { // The device platform. // // This member is required. Platform types.Platform // The release version. For the latest available version, specify LATEST. // // This member is required. ReleaseVersion *string // contains filtered or unexported fields }
type GetMobileSdkReleaseOutput ¶
type GetMobileSdkReleaseOutput struct { // Information for a specified SDK release, including release notes and tags. MobileSdkRelease *types.MobileSdkRelease // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetPermissionPolicyInput ¶
type GetPermissionPolicyInput struct { // The Amazon Resource Name (ARN) of the rule group for which you want to get the // policy. // // This member is required. ResourceArn *string // contains filtered or unexported fields }
type GetPermissionPolicyOutput ¶
type GetPermissionPolicyOutput struct { // The IAM policy that is attached to the specified rule group. Policy *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetRateBasedStatementManagedKeysInput ¶
type GetRateBasedStatementManagedKeysInput struct { // The name of the rate-based rule to get the keys for. If you have the rule // defined inside a rule group that you're using in your web ACL, also provide the // name of the rule group reference statement in the request parameter // RuleGroupRuleName. // // This member is required. RuleName *string // Specifies 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 AppSync GraphQL API. To work with // CloudFront, you must also specify the Region US East (N. Virginia) as // follows: // // * CLI - Specify the Region when you use the CloudFront scope: // --scope=CLOUDFRONT --region=us-east-1. // // * API and SDKs - For all calls, use the // Region endpoint us-east-1. // // This member is required. Scope types.Scope // The unique identifier for the web ACL. This ID is returned in the responses to // create and list commands. You provide it to operations like update and delete. // // This member is required. WebACLId *string // The name of the web ACL. You cannot change the name of a web ACL after you // create it. // // This member is required. WebACLName *string // The name of the rule group reference statement in your web ACL. This is required // only when you have the rate-based rule nested inside a rule group. RuleGroupRuleName *string // contains filtered or unexported fields }
type GetRateBasedStatementManagedKeysOutput ¶
type GetRateBasedStatementManagedKeysOutput struct { // The keys that are of Internet Protocol version 4 (IPv4). ManagedKeysIPV4 *types.RateBasedStatementManagedKeysIPSet // The keys that are of Internet Protocol version 6 (IPv6). ManagedKeysIPV6 *types.RateBasedStatementManagedKeysIPSet // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetRegexPatternSetInput ¶
type GetRegexPatternSetInput struct { // A unique identifier for the set. This ID is returned in the responses to create // and list commands. You provide it to operations like update and delete. // // This member is required. Id *string // The name of the set. You cannot change the name after you create the set. // // This member is required. Name *string // Specifies 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 AppSync GraphQL API. To work with // CloudFront, you must also specify the Region US East (N. Virginia) as // follows: // // * CLI - Specify the Region when you use the CloudFront scope: // --scope=CLOUDFRONT --region=us-east-1. // // * API and SDKs - For all calls, use the // Region endpoint us-east-1. // // This member is required. Scope types.Scope // contains filtered or unexported fields }
type GetRegexPatternSetOutput ¶
type GetRegexPatternSetOutput struct { // A token used for optimistic locking. WAF returns a token to your get and list // requests, to mark the state of the entity at the time of the request. To make // changes to the entity associated with the token, you provide the token to // operations like update and delete. WAF uses the token to ensure that no changes // have been made to the entity since you last retrieved it. If a change has been // made, the update fails with a WAFOptimisticLockException. If this happens, // perform another get, and use the new token returned by that operation. LockToken *string // RegexPatternSet *types.RegexPatternSet // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetRuleGroupInput ¶
type GetRuleGroupInput struct { // The Amazon Resource Name (ARN) of the entity. ARN *string // A unique identifier for the rule group. This ID is returned in the responses to // create and list commands. You provide it to operations like update and delete. Id *string // The name of the rule group. You cannot change the name of a rule group after you // create it. Name *string // Specifies 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 AppSync GraphQL API. To work with // CloudFront, you must also specify the Region US East (N. Virginia) as // follows: // // * CLI - Specify the Region when you use the CloudFront scope: // --scope=CLOUDFRONT --region=us-east-1. // // * API and SDKs - For all calls, use the // Region endpoint us-east-1. Scope types.Scope // contains filtered or unexported fields }
type GetRuleGroupOutput ¶
type GetRuleGroupOutput struct { // A token used for optimistic locking. WAF returns a token to your get and list // requests, to mark the state of the entity at the time of the request. To make // changes to the entity associated with the token, you provide the token to // operations like update and delete. WAF uses the token to ensure that no changes // have been made to the entity since you last retrieved it. If a change has been // made, the update fails with a WAFOptimisticLockException. If this happens, // perform another get, and use the new token returned by that operation. LockToken *string // RuleGroup *types.RuleGroup // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetSampledRequestsInput ¶
type GetSampledRequestsInput struct { // The number of requests that you want WAF to return from among the first 5,000 // requests that your Amazon Web Services resource received during the time range. // If your resource received fewer requests than the value of MaxItems, // GetSampledRequests returns information about all of them. // // This member is required. MaxItems int64 // The metric name assigned to the Rule or RuleGroup for which you want a sample of // requests. // // This member is required. RuleMetricName *string // Specifies 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 AppSync GraphQL API. To work with // CloudFront, you must also specify the Region US East (N. Virginia) as // follows: // // * CLI - Specify the Region when you use the CloudFront scope: // --scope=CLOUDFRONT --region=us-east-1. // // * API and SDKs - For all calls, use the // Region endpoint us-east-1. // // This member is required. Scope types.Scope // The start date and time and the end date and time of the range for which you // want GetSampledRequests to return a sample of requests. You must specify the // times in Coordinated Universal Time (UTC) format. UTC format includes the // special designator, Z. For example, "2016-09-27T14:50Z". You can specify any // time range in the previous three hours. If you specify a start time that's // earlier than three hours ago, WAF sets it to three hours ago. // // This member is required. TimeWindow *types.TimeWindow // The Amazon resource name (ARN) of the WebACL for which you want a sample of // requests. // // This member is required. WebAclArn *string // contains filtered or unexported fields }
type GetSampledRequestsOutput ¶
type GetSampledRequestsOutput struct { // The total number of requests from which GetSampledRequests got a sample of // MaxItems requests. If PopulationSize is less than MaxItems, the sample includes // every request that your Amazon Web Services resource received during the // specified time range. PopulationSize int64 // A complex type that contains detailed information about each of the requests in // the sample. SampledRequests []types.SampledHTTPRequest // Usually, TimeWindow is the time range that you specified in the // GetSampledRequests request. However, if your Amazon Web Services resource // received more than 5,000 requests during the time range that you specified in // the request, GetSampledRequests returns the time range for the first 5,000 // requests. Times are in Coordinated Universal Time (UTC) format. TimeWindow *types.TimeWindow // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetWebACLForResourceInput ¶
type GetWebACLForResourceInput struct { // The ARN (Amazon Resource Name) of the resource. // // This member is required. ResourceArn *string // contains filtered or unexported fields }
type GetWebACLForResourceOutput ¶
type GetWebACLForResourceOutput struct { // The web ACL that is associated with the resource. If there is no associated // resource, WAF returns a null web ACL. WebACL *types.WebACL // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetWebACLInput ¶
type GetWebACLInput struct { // The unique identifier for the web ACL. This ID is returned in the responses to // create and list commands. You provide it to operations like update and delete. // // This member is required. Id *string // The name of the web ACL. You cannot change the name of a web ACL after you // create it. // // This member is required. Name *string // Specifies 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 AppSync GraphQL API. To work with // CloudFront, you must also specify the Region US East (N. Virginia) as // follows: // // * CLI - Specify the Region when you use the CloudFront scope: // --scope=CLOUDFRONT --region=us-east-1. // // * API and SDKs - For all calls, use the // Region endpoint us-east-1. // // This member is required. Scope types.Scope // contains filtered or unexported fields }
type GetWebACLOutput ¶
type GetWebACLOutput struct { // The URL to use in SDK integrations with Amazon Web Services managed rule groups. // For example, you can use the integration SDKs with the account takeover // prevention managed rule group AWSManagedRulesATPRuleSet. This is only populated // if you are using a rule group in your web ACL that integrates with your // applications in this way. For more information, see WAF client application // integration // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html) // in the WAF Developer Guide. ApplicationIntegrationURL *string // A token used for optimistic locking. WAF returns a token to your get and list // requests, to mark the state of the entity at the time of the request. To make // changes to the entity associated with the token, you provide the token to // operations like update and delete. WAF uses the token to ensure that no changes // have been made to the entity since you last retrieved it. If a change has been // made, the update fails with a WAFOptimisticLockException. If this happens, // perform another get, and use the new token returned by that operation. LockToken *string // The web ACL specification. You can modify the settings in this web ACL and use // it to update this web ACL or create a new one. WebACL *types.WebACL // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type HTTPClient ¶
type HTTPSignerV4 ¶
type HTTPSignerV4 interface { SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error }
type ListAvailableManagedRuleGroupVersionsInput ¶
type ListAvailableManagedRuleGroupVersionsInput struct { // The name of the managed rule group. You use this, along with the vendor name, to // identify the rule group. // // This member is required. Name *string // Specifies 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 AppSync GraphQL API. To work with // CloudFront, you must also specify the Region US East (N. Virginia) as // follows: // // * CLI - Specify the Region when you use the CloudFront scope: // --scope=CLOUDFRONT --region=us-east-1. // // * API and SDKs - For all calls, use the // Region endpoint us-east-1. // // This member is required. Scope types.Scope // The name of the managed rule group vendor. You use this, along with the rule // group name, to identify the rule group. // // This member is required. VendorName *string // The maximum number of objects that you want WAF to return for this request. If // more objects are available, in the response, WAF provides a NextMarker value // that you can use in a subsequent call to get the next batch of objects. Limit *int32 // When you request a list of objects with a Limit setting, if the number of // objects that are still available for retrieval exceeds the limit, WAF returns a // NextMarker value in the response. To retrieve the next batch of objects, provide // the marker from the prior call in your next request. NextMarker *string // contains filtered or unexported fields }
type ListAvailableManagedRuleGroupVersionsOutput ¶
type ListAvailableManagedRuleGroupVersionsOutput struct { // The name of the version that's currently set as the default. CurrentDefaultVersion *string // When you request a list of objects with a Limit setting, if the number of // objects that are still available for retrieval exceeds the limit, WAF returns a // NextMarker value in the response. To retrieve the next batch of objects, provide // the marker from the prior call in your next request. NextMarker *string // The versions that are currently available for the specified managed rule group. Versions []types.ManagedRuleGroupVersion // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListAvailableManagedRuleGroupsInput ¶
type ListAvailableManagedRuleGroupsInput struct { // Specifies 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 AppSync GraphQL API. To work with // CloudFront, you must also specify the Region US East (N. Virginia) as // follows: // // * CLI - Specify the Region when you use the CloudFront scope: // --scope=CLOUDFRONT --region=us-east-1. // // * API and SDKs - For all calls, use the // Region endpoint us-east-1. // // This member is required. Scope types.Scope // The maximum number of objects that you want WAF to return for this request. If // more objects are available, in the response, WAF provides a NextMarker value // that you can use in a subsequent call to get the next batch of objects. Limit *int32 // When you request a list of objects with a Limit setting, if the number of // objects that are still available for retrieval exceeds the limit, WAF returns a // NextMarker value in the response. To retrieve the next batch of objects, provide // the marker from the prior call in your next request. NextMarker *string // contains filtered or unexported fields }
type ListAvailableManagedRuleGroupsOutput ¶
type ListAvailableManagedRuleGroupsOutput struct { // ManagedRuleGroups []types.ManagedRuleGroupSummary // When you request a list of objects with a Limit setting, if the number of // objects that are still available for retrieval exceeds the limit, WAF returns a // NextMarker value in the response. To retrieve the next batch of objects, provide // the marker from the prior call in your next request. NextMarker *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListIPSetsInput ¶
type ListIPSetsInput struct { // Specifies 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 AppSync GraphQL API. To work with // CloudFront, you must also specify the Region US East (N. Virginia) as // follows: // // * CLI - Specify the Region when you use the CloudFront scope: // --scope=CLOUDFRONT --region=us-east-1. // // * API and SDKs - For all calls, use the // Region endpoint us-east-1. // // This member is required. Scope types.Scope // The maximum number of objects that you want WAF to return for this request. If // more objects are available, in the response, WAF provides a NextMarker value // that you can use in a subsequent call to get the next batch of objects. Limit *int32 // When you request a list of objects with a Limit setting, if the number of // objects that are still available for retrieval exceeds the limit, WAF returns a // NextMarker value in the response. To retrieve the next batch of objects, provide // the marker from the prior call in your next request. NextMarker *string // contains filtered or unexported fields }
type ListIPSetsOutput ¶
type ListIPSetsOutput struct { // Array of IPSets. This may not be the full list of IPSets that you have defined. // See the Limit specification for this request. IPSets []types.IPSetSummary // When you request a list of objects with a Limit setting, if the number of // objects that are still available for retrieval exceeds the limit, WAF returns a // NextMarker value in the response. To retrieve the next batch of objects, provide // the marker from the prior call in your next request. NextMarker *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListLoggingConfigurationsInput ¶
type ListLoggingConfigurationsInput struct { // Specifies 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 AppSync GraphQL API. To work with // CloudFront, you must also specify the Region US East (N. Virginia) as // follows: // // * CLI - Specify the Region when you use the CloudFront scope: // --scope=CLOUDFRONT --region=us-east-1. // // * API and SDKs - For all calls, use the // Region endpoint us-east-1. // // This member is required. Scope types.Scope // The maximum number of objects that you want WAF to return for this request. If // more objects are available, in the response, WAF provides a NextMarker value // that you can use in a subsequent call to get the next batch of objects. Limit *int32 // When you request a list of objects with a Limit setting, if the number of // objects that are still available for retrieval exceeds the limit, WAF returns a // NextMarker value in the response. To retrieve the next batch of objects, provide // the marker from the prior call in your next request. NextMarker *string // contains filtered or unexported fields }
type ListLoggingConfigurationsOutput ¶
type ListLoggingConfigurationsOutput struct { // LoggingConfigurations []types.LoggingConfiguration // When you request a list of objects with a Limit setting, if the number of // objects that are still available for retrieval exceeds the limit, WAF returns a // NextMarker value in the response. To retrieve the next batch of objects, provide // the marker from the prior call in your next request. NextMarker *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListManagedRuleSetsInput ¶
type ListManagedRuleSetsInput struct { // Specifies 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 AppSync GraphQL API. To work with // CloudFront, you must also specify the Region US East (N. Virginia) as // follows: // // * CLI - Specify the Region when you use the CloudFront scope: // --scope=CLOUDFRONT --region=us-east-1. // // * API and SDKs - For all calls, use the // Region endpoint us-east-1. // // This member is required. Scope types.Scope // The maximum number of objects that you want WAF to return for this request. If // more objects are available, in the response, WAF provides a NextMarker value // that you can use in a subsequent call to get the next batch of objects. Limit *int32 // When you request a list of objects with a Limit setting, if the number of // objects that are still available for retrieval exceeds the limit, WAF returns a // NextMarker value in the response. To retrieve the next batch of objects, provide // the marker from the prior call in your next request. NextMarker *string // contains filtered or unexported fields }
type ListManagedRuleSetsOutput ¶
type ListManagedRuleSetsOutput struct { // Your managed rule sets. ManagedRuleSets []types.ManagedRuleSetSummary // When you request a list of objects with a Limit setting, if the number of // objects that are still available for retrieval exceeds the limit, WAF returns a // NextMarker value in the response. To retrieve the next batch of objects, provide // the marker from the prior call in your next request. NextMarker *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListMobileSdkReleasesInput ¶
type ListMobileSdkReleasesInput struct { // The device platform to retrieve the list for. // // This member is required. Platform types.Platform // The maximum number of objects that you want WAF to return for this request. If // more objects are available, in the response, WAF provides a NextMarker value // that you can use in a subsequent call to get the next batch of objects. Limit *int32 // When you request a list of objects with a Limit setting, if the number of // objects that are still available for retrieval exceeds the limit, WAF returns a // NextMarker value in the response. To retrieve the next batch of objects, provide // the marker from the prior call in your next request. NextMarker *string // contains filtered or unexported fields }
type ListMobileSdkReleasesOutput ¶
type ListMobileSdkReleasesOutput struct { // When you request a list of objects with a Limit setting, if the number of // objects that are still available for retrieval exceeds the limit, WAF returns a // NextMarker value in the response. To retrieve the next batch of objects, provide // the marker from the prior call in your next request. NextMarker *string // High level information for the available SDK releases. ReleaseSummaries []types.ReleaseSummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListRegexPatternSetsInput ¶
type ListRegexPatternSetsInput struct { // Specifies 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 AppSync GraphQL API. To work with // CloudFront, you must also specify the Region US East (N. Virginia) as // follows: // // * CLI - Specify the Region when you use the CloudFront scope: // --scope=CLOUDFRONT --region=us-east-1. // // * API and SDKs - For all calls, use the // Region endpoint us-east-1. // // This member is required. Scope types.Scope // The maximum number of objects that you want WAF to return for this request. If // more objects are available, in the response, WAF provides a NextMarker value // that you can use in a subsequent call to get the next batch of objects. Limit *int32 // When you request a list of objects with a Limit setting, if the number of // objects that are still available for retrieval exceeds the limit, WAF returns a // NextMarker value in the response. To retrieve the next batch of objects, provide // the marker from the prior call in your next request. NextMarker *string // contains filtered or unexported fields }
type ListRegexPatternSetsOutput ¶
type ListRegexPatternSetsOutput struct { // When you request a list of objects with a Limit setting, if the number of // objects that are still available for retrieval exceeds the limit, WAF returns a // NextMarker value in the response. To retrieve the next batch of objects, provide // the marker from the prior call in your next request. NextMarker *string // RegexPatternSets []types.RegexPatternSetSummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListResourcesForWebACLInput ¶
type ListResourcesForWebACLInput struct { // The Amazon Resource Name (ARN) of the web ACL. // // This member is required. WebACLArn *string // Used for web ACLs that are scoped for regional applications. A regional // application can be an Application Load Balancer (ALB), an Amazon API Gateway // REST API, or an AppSync GraphQL API. ResourceType types.ResourceType // contains filtered or unexported fields }
type ListResourcesForWebACLOutput ¶
type ListResourcesForWebACLOutput struct { // The array of Amazon Resource Names (ARNs) of the associated resources. ResourceArns []string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListRuleGroupsInput ¶
type ListRuleGroupsInput struct { // Specifies 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 AppSync GraphQL API. To work with // CloudFront, you must also specify the Region US East (N. Virginia) as // follows: // // * CLI - Specify the Region when you use the CloudFront scope: // --scope=CLOUDFRONT --region=us-east-1. // // * API and SDKs - For all calls, use the // Region endpoint us-east-1. // // This member is required. Scope types.Scope // The maximum number of objects that you want WAF to return for this request. If // more objects are available, in the response, WAF provides a NextMarker value // that you can use in a subsequent call to get the next batch of objects. Limit *int32 // When you request a list of objects with a Limit setting, if the number of // objects that are still available for retrieval exceeds the limit, WAF returns a // NextMarker value in the response. To retrieve the next batch of objects, provide // the marker from the prior call in your next request. NextMarker *string // contains filtered or unexported fields }
type ListRuleGroupsOutput ¶
type ListRuleGroupsOutput struct { // When you request a list of objects with a Limit setting, if the number of // objects that are still available for retrieval exceeds the limit, WAF returns a // NextMarker value in the response. To retrieve the next batch of objects, provide // the marker from the prior call in your next request. NextMarker *string // RuleGroups []types.RuleGroupSummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListTagsForResourceInput ¶
type ListTagsForResourceInput struct { // The Amazon Resource Name (ARN) of the resource. // // This member is required. ResourceARN *string // The maximum number of objects that you want WAF to return for this request. If // more objects are available, in the response, WAF provides a NextMarker value // that you can use in a subsequent call to get the next batch of objects. Limit *int32 // When you request a list of objects with a Limit setting, if the number of // objects that are still available for retrieval exceeds the limit, WAF returns a // NextMarker value in the response. To retrieve the next batch of objects, provide // the marker from the prior call in your next request. NextMarker *string // contains filtered or unexported fields }
type ListTagsForResourceOutput ¶
type ListTagsForResourceOutput struct { // When you request a list of objects with a Limit setting, if the number of // objects that are still available for retrieval exceeds the limit, WAF returns a // NextMarker value in the response. To retrieve the next batch of objects, provide // the marker from the prior call in your next request. NextMarker *string // The collection of tagging definitions for the resource. TagInfoForResource *types.TagInfoForResource // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListWebACLsInput ¶
type ListWebACLsInput struct { // Specifies 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 AppSync GraphQL API. To work with // CloudFront, you must also specify the Region US East (N. Virginia) as // follows: // // * CLI - Specify the Region when you use the CloudFront scope: // --scope=CLOUDFRONT --region=us-east-1. // // * API and SDKs - For all calls, use the // Region endpoint us-east-1. // // This member is required. Scope types.Scope // The maximum number of objects that you want WAF to return for this request. If // more objects are available, in the response, WAF provides a NextMarker value // that you can use in a subsequent call to get the next batch of objects. Limit *int32 // When you request a list of objects with a Limit setting, if the number of // objects that are still available for retrieval exceeds the limit, WAF returns a // NextMarker value in the response. To retrieve the next batch of objects, provide // the marker from the prior call in your next request. NextMarker *string // contains filtered or unexported fields }
type ListWebACLsOutput ¶
type ListWebACLsOutput struct { // When you request a list of objects with a Limit setting, if the number of // objects that are still available for retrieval exceeds the limit, WAF returns a // NextMarker value in the response. To retrieve the next batch of objects, provide // the marker from the prior call in your next request. NextMarker *string // WebACLs []types.WebACLSummary // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type Options ¶
type Options struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. APIOptions []func(*middleware.Stack) error // Configures the events that will be sent to the configured logger. ClientLogMode aws.ClientLogMode // The credentials object to use when signing requests. Credentials aws.CredentialsProvider // The configuration DefaultsMode that the SDK should use when constructing the // clients initial default settings. DefaultsMode aws.DefaultsMode // The endpoint options to be used when attempting to resolve an endpoint. EndpointOptions EndpointResolverOptions // The service endpoint resolver. EndpointResolver EndpointResolver // Signature Version 4 (SigV4) Signer HTTPSignerV4 HTTPSignerV4 // The logger writer interface to write logging messages to. Logger logging.Logger // The region to send requests to. (Required) Region string // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify // per operation call's retry max attempts. When creating a new API Clients this // member will only be used if the Retryer Options member is nil. This value will // be ignored if Retryer is not nil. If specified in an operation call's functional // options with a value that is different than the constructed client's Options, // the Client's Retryer will be wrapped to use the operation's specific // RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if // Retryer option is not also specified. When creating a new API Clients this // member will only be used if the Retryer Options member is nil. This value will // be ignored if Retryer is not nil. Currently does not support per operation call // overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable // failures. When nil the API client will use a default retryer. The kind of // default retry created by the API client can be changed with the RetryMode // option. Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment // The HTTP client to invoke API calls with. Defaults to client's default HTTP // implementation if nil. HTTPClient HTTPClient // contains filtered or unexported fields }
func (Options) Copy ¶
Copy creates a clone where the APIOptions list is deep copied.
type PutLoggingConfigurationInput ¶
type PutLoggingConfigurationInput struct { // // // This member is required. LoggingConfiguration *types.LoggingConfiguration // contains filtered or unexported fields }
type PutLoggingConfigurationOutput ¶
type PutLoggingConfigurationOutput struct { // LoggingConfiguration *types.LoggingConfiguration // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type PutManagedRuleSetVersionsInput ¶
type PutManagedRuleSetVersionsInput struct { // A unique identifier for the managed rule set. The ID is returned in the // responses to commands like list. You provide it to operations like get and // update. // // This member is required. Id *string // A token used for optimistic locking. WAF returns a token to your get and list // requests, to mark the state of the entity at the time of the request. To make // changes to the entity associated with the token, you provide the token to // operations like update and delete. WAF uses the token to ensure that no changes // have been made to the entity since you last retrieved it. If a change has been // made, the update fails with a WAFOptimisticLockException. If this happens, // perform another get, and use the new token returned by that operation. // // This member is required. LockToken *string // The name of the managed rule set. You use this, along with the rule set ID, to // identify the rule set. This name is assigned to the corresponding managed rule // group, which your customers can access and use. // // This member is required. Name *string // Specifies 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 AppSync GraphQL API. To work with // CloudFront, you must also specify the Region US East (N. Virginia) as // follows: // // * CLI - Specify the Region when you use the CloudFront scope: // --scope=CLOUDFRONT --region=us-east-1. // // * API and SDKs - For all calls, use the // Region endpoint us-east-1. // // This member is required. Scope types.Scope // The version of the named managed rule group that you'd like your customers to // choose, from among your version offerings. RecommendedVersion *string // The versions of the named managed rule group that you want to offer to your // customers. VersionsToPublish map[string]types.VersionToPublish // contains filtered or unexported fields }
type PutManagedRuleSetVersionsOutput ¶
type PutManagedRuleSetVersionsOutput struct { // A token used for optimistic locking. WAF returns a token to your get and list // requests, to mark the state of the entity at the time of the request. To make // changes to the entity associated with the token, you provide the token to // operations like update and delete. WAF uses the token to ensure that no changes // have been made to the entity since you last retrieved it. If a change has been // made, the update fails with a WAFOptimisticLockException. If this happens, // perform another get, and use the new token returned by that operation. NextLockToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type PutPermissionPolicyInput ¶
type PutPermissionPolicyInput struct { // The policy to attach to the specified rule group. The policy specifications must // conform to the following: // // * The policy must be composed using IAM Policy // version 2012-10-17 or version 2015-01-01. // // * The policy must include // specifications for Effect, Action, and Principal. // // * Effect must specify // Allow. // // * Action must specify wafv2:CreateWebACL, wafv2:UpdateWebACL, and // wafv2:PutFirewallManagerRuleGroups and may optionally specify // wafv2:GetRuleGroup. WAF rejects any extra actions or wildcard actions in the // policy. // // * The policy must not include a Resource parameter. // // For more // information, see IAM Policies // (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html). // // This member is required. Policy *string // The Amazon Resource Name (ARN) of the RuleGroup to which you want to attach the // policy. // // This member is required. ResourceArn *string // contains filtered or unexported fields }
type PutPermissionPolicyOutput ¶
type PutPermissionPolicyOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ResolveEndpoint ¶
type ResolveEndpoint struct { Resolver EndpointResolver Options EndpointResolverOptions }
func (*ResolveEndpoint) HandleSerialize ¶
func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
func (*ResolveEndpoint) ID ¶
func (*ResolveEndpoint) ID() string
type TagResourceInput ¶
type TagResourceInput struct { // The Amazon Resource Name (ARN) of the resource. // // This member is required. ResourceARN *string // An array of key:value pairs to associate with the resource. // // This member is required. Tags []types.Tag // contains filtered or unexported fields }
type TagResourceOutput ¶
type TagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UntagResourceInput ¶
type UntagResourceInput struct { // The Amazon Resource Name (ARN) of the resource. // // This member is required. ResourceARN *string // An array of keys identifying the tags to disassociate from the resource. // // This member is required. TagKeys []string // contains filtered or unexported fields }
type UntagResourceOutput ¶
type UntagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateIPSetInput ¶
type UpdateIPSetInput struct { // Contains an array of strings that specifies zero or more IP addresses or blocks // of IP addresses in Classless Inter-Domain Routing (CIDR) notation. WAF supports // all IPv4 and IPv6 CIDR ranges except for /0. Example address strings: // // * To // configure WAF to allow, block, or count requests that originated from the IP // address 192.0.2.44, specify 192.0.2.44/32. // // * To configure WAF to allow, block, // or count requests that originated from IP addresses from 192.0.2.0 to // 192.0.2.255, specify 192.0.2.0/24. // // * To configure WAF to allow, block, or count // requests that originated from the IP address // 1111:0000:0000:0000:0000:0000:0000:0111, specify // 1111:0000:0000:0000:0000:0000:0000:0111/128. // // * To configure WAF to allow, // block, or count requests that originated from IP addresses // 1111:0000:0000:0000:0000:0000:0000:0000 to // 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify // 1111:0000:0000:0000:0000:0000:0000:0000/64. // // For more information about CIDR // notation, see the Wikipedia entry Classless Inter-Domain Routing // (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing). Example JSON // Addresses specifications: // // * Empty array: "Addresses": [] // // * Array with one // address: "Addresses": ["192.0.2.44/32"] // // * Array with three addresses: // "Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"] // // * INVALID // specification: "Addresses": [""] INVALID // // This member is required. Addresses []string // A unique identifier for the set. This ID is returned in the responses to create // and list commands. You provide it to operations like update and delete. // // This member is required. Id *string // A token used for optimistic locking. WAF returns a token to your get and list // requests, to mark the state of the entity at the time of the request. To make // changes to the entity associated with the token, you provide the token to // operations like update and delete. WAF uses the token to ensure that no changes // have been made to the entity since you last retrieved it. If a change has been // made, the update fails with a WAFOptimisticLockException. If this happens, // perform another get, and use the new token returned by that operation. // // This member is required. LockToken *string // The name of the IP set. You cannot change the name of an IPSet after you create // it. // // This member is required. Name *string // Specifies 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 AppSync GraphQL API. To work with // CloudFront, you must also specify the Region US East (N. Virginia) as // follows: // // * CLI - Specify the Region when you use the CloudFront scope: // --scope=CLOUDFRONT --region=us-east-1. // // * API and SDKs - For all calls, use the // Region endpoint us-east-1. // // This member is required. Scope types.Scope // A description of the IP set that helps with identification. Description *string // contains filtered or unexported fields }
type UpdateIPSetOutput ¶
type UpdateIPSetOutput struct { // A token used for optimistic locking. WAF returns this token to your update // requests. You use NextLockToken in the same manner as you use LockToken. NextLockToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateManagedRuleSetVersionExpiryDateInput ¶
type UpdateManagedRuleSetVersionExpiryDateInput struct { // The time that you want the version to expire. Times are in Coordinated Universal // Time (UTC) format. UTC format includes the special designator, Z. For example, // "2016-09-27T14:50Z". // // This member is required. ExpiryTimestamp *time.Time // A unique identifier for the managed rule set. The ID is returned in the // responses to commands like list. You provide it to operations like get and // update. // // This member is required. Id *string // A token used for optimistic locking. WAF returns a token to your get and list // requests, to mark the state of the entity at the time of the request. To make // changes to the entity associated with the token, you provide the token to // operations like update and delete. WAF uses the token to ensure that no changes // have been made to the entity since you last retrieved it. If a change has been // made, the update fails with a WAFOptimisticLockException. If this happens, // perform another get, and use the new token returned by that operation. // // This member is required. LockToken *string // The name of the managed rule set. You use this, along with the rule set ID, to // identify the rule set. This name is assigned to the corresponding managed rule // group, which your customers can access and use. // // This member is required. Name *string // Specifies 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 AppSync GraphQL API. To work with // CloudFront, you must also specify the Region US East (N. Virginia) as // follows: // // * CLI - Specify the Region when you use the CloudFront scope: // --scope=CLOUDFRONT --region=us-east-1. // // * API and SDKs - For all calls, use the // Region endpoint us-east-1. // // This member is required. Scope types.Scope // The version that you want to remove from your list of offerings for the named // managed rule group. // // This member is required. VersionToExpire *string // contains filtered or unexported fields }
type UpdateManagedRuleSetVersionExpiryDateOutput ¶
type UpdateManagedRuleSetVersionExpiryDateOutput struct { // The version that is set to expire. ExpiringVersion *string // The time that the version will expire. Times are in Coordinated Universal Time // (UTC) format. UTC format includes the special designator, Z. For example, // "2016-09-27T14:50Z". ExpiryTimestamp *time.Time // A token used for optimistic locking. WAF returns a token to your get and list // requests, to mark the state of the entity at the time of the request. To make // changes to the entity associated with the token, you provide the token to // operations like update and delete. WAF uses the token to ensure that no changes // have been made to the entity since you last retrieved it. If a change has been // made, the update fails with a WAFOptimisticLockException. If this happens, // perform another get, and use the new token returned by that operation. NextLockToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateRegexPatternSetInput ¶
type UpdateRegexPatternSetInput struct { // A unique identifier for the set. This ID is returned in the responses to create // and list commands. You provide it to operations like update and delete. // // This member is required. Id *string // A token used for optimistic locking. WAF returns a token to your get and list // requests, to mark the state of the entity at the time of the request. To make // changes to the entity associated with the token, you provide the token to // operations like update and delete. WAF uses the token to ensure that no changes // have been made to the entity since you last retrieved it. If a change has been // made, the update fails with a WAFOptimisticLockException. If this happens, // perform another get, and use the new token returned by that operation. // // This member is required. LockToken *string // The name of the set. You cannot change the name after you create the set. // // This member is required. Name *string // // // This member is required. RegularExpressionList []types.Regex // Specifies 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 AppSync GraphQL API. To work with // CloudFront, you must also specify the Region US East (N. Virginia) as // follows: // // * CLI - Specify the Region when you use the CloudFront scope: // --scope=CLOUDFRONT --region=us-east-1. // // * API and SDKs - For all calls, use the // Region endpoint us-east-1. // // This member is required. Scope types.Scope // A description of the set that helps with identification. Description *string // contains filtered or unexported fields }
type UpdateRegexPatternSetOutput ¶
type UpdateRegexPatternSetOutput struct { // A token used for optimistic locking. WAF returns this token to your update // requests. You use NextLockToken in the same manner as you use LockToken. NextLockToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateRuleGroupInput ¶
type UpdateRuleGroupInput struct { // A unique identifier for the rule group. This ID is returned in the responses to // create and list commands. You provide it to operations like update and delete. // // This member is required. Id *string // A token used for optimistic locking. WAF returns a token to your get and list // requests, to mark the state of the entity at the time of the request. To make // changes to the entity associated with the token, you provide the token to // operations like update and delete. WAF uses the token to ensure that no changes // have been made to the entity since you last retrieved it. If a change has been // made, the update fails with a WAFOptimisticLockException. If this happens, // perform another get, and use the new token returned by that operation. // // This member is required. LockToken *string // The name of the rule group. You cannot change the name of a rule group after you // create it. // // This member is required. Name *string // Specifies 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 AppSync GraphQL API. To work with // CloudFront, you must also specify the Region US East (N. Virginia) as // follows: // // * CLI - Specify the Region when you use the CloudFront scope: // --scope=CLOUDFRONT --region=us-east-1. // // * API and SDKs - For all calls, use the // Region endpoint us-east-1. // // This member is required. Scope types.Scope // Defines and enables Amazon CloudWatch metrics and web request sample collection. // // This member is required. VisibilityConfig *types.VisibilityConfig // A map of custom response keys and content bodies. When you create a rule with a // block action, you can send a custom response to the web request. You define // these for the rule group, and then use them in the rules that you define in the // rule group. For information about customizing web requests and responses, see // Customizing web requests and responses in WAF // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) // in the WAF Developer Guide // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). For // information about the limits on count and size for custom request and response // settings, see WAF quotas // (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the WAF // Developer Guide // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). CustomResponseBodies map[string]types.CustomResponseBody // A description of the rule group that helps with identification. Description *string // The Rule statements used to identify the web requests that you want to allow, // block, or count. Each rule includes one top-level statement that WAF uses to // identify matching web requests, and parameters that govern how WAF handles them. Rules []types.Rule // contains filtered or unexported fields }
type UpdateRuleGroupOutput ¶
type UpdateRuleGroupOutput struct { // A token used for optimistic locking. WAF returns this token to your update // requests. You use NextLockToken in the same manner as you use LockToken. NextLockToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateWebACLInput ¶
type UpdateWebACLInput struct { // The action to perform if none of the Rules contained in the WebACL match. // // This member is required. DefaultAction *types.DefaultAction // The unique identifier for the web ACL. This ID is returned in the responses to // create and list commands. You provide it to operations like update and delete. // // This member is required. Id *string // A token used for optimistic locking. WAF returns a token to your get and list // requests, to mark the state of the entity at the time of the request. To make // changes to the entity associated with the token, you provide the token to // operations like update and delete. WAF uses the token to ensure that no changes // have been made to the entity since you last retrieved it. If a change has been // made, the update fails with a WAFOptimisticLockException. If this happens, // perform another get, and use the new token returned by that operation. // // This member is required. LockToken *string // The name of the web ACL. You cannot change the name of a web ACL after you // create it. // // This member is required. Name *string // Specifies 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 AppSync GraphQL API. To work with // CloudFront, you must also specify the Region US East (N. Virginia) as // follows: // // * CLI - Specify the Region when you use the CloudFront scope: // --scope=CLOUDFRONT --region=us-east-1. // // * API and SDKs - For all calls, use the // Region endpoint us-east-1. // // This member is required. Scope types.Scope // Defines and enables Amazon CloudWatch metrics and web request sample collection. // // This member is required. VisibilityConfig *types.VisibilityConfig // Specifies how WAF should handle CAPTCHA evaluations for rules that don't have // their own CaptchaConfig settings. If you don't specify this, WAF uses its // default settings for CaptchaConfig. CaptchaConfig *types.CaptchaConfig // A map of custom response keys and content bodies. When you create a rule with a // block action, you can send a custom response to the web request. You define // these for the web ACL, and then use them in the rules and default actions that // you define in the web ACL. For information about customizing web requests and // responses, see Customizing web requests and responses in WAF // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) // in the WAF Developer Guide // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). For // information about the limits on count and size for custom request and response // settings, see WAF quotas // (https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the WAF // Developer Guide // (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). CustomResponseBodies map[string]types.CustomResponseBody // A description of the web ACL that helps with identification. Description *string // The Rule statements used to identify the web requests that you want to allow, // block, or count. Each rule includes one top-level statement that WAF uses to // identify matching web requests, and parameters that govern how WAF handles them. Rules []types.Rule // contains filtered or unexported fields }
type UpdateWebACLOutput ¶
type UpdateWebACLOutput struct { // A token used for optimistic locking. WAF returns this token to your update // requests. You use NextLockToken in the same manner as you use LockToken. NextLockToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Source Files ¶
api_client.go api_op_AssociateWebACL.go api_op_CheckCapacity.go api_op_CreateIPSet.go api_op_CreateRegexPatternSet.go api_op_CreateRuleGroup.go api_op_CreateWebACL.go api_op_DeleteFirewallManagerRuleGroups.go api_op_DeleteIPSet.go api_op_DeleteLoggingConfiguration.go api_op_DeletePermissionPolicy.go api_op_DeleteRegexPatternSet.go api_op_DeleteRuleGroup.go api_op_DeleteWebACL.go api_op_DescribeManagedRuleGroup.go api_op_DisassociateWebACL.go api_op_GenerateMobileSdkReleaseUrl.go api_op_GetIPSet.go api_op_GetLoggingConfiguration.go api_op_GetManagedRuleSet.go api_op_GetMobileSdkRelease.go api_op_GetPermissionPolicy.go api_op_GetRateBasedStatementManagedKeys.go api_op_GetRegexPatternSet.go api_op_GetRuleGroup.go api_op_GetSampledRequests.go api_op_GetWebACL.go api_op_GetWebACLForResource.go api_op_ListAvailableManagedRuleGroupVersions.go api_op_ListAvailableManagedRuleGroups.go api_op_ListIPSets.go api_op_ListLoggingConfigurations.go api_op_ListManagedRuleSets.go api_op_ListMobileSdkReleases.go api_op_ListRegexPatternSets.go api_op_ListResourcesForWebACL.go api_op_ListRuleGroups.go api_op_ListTagsForResource.go api_op_ListWebACLs.go api_op_PutLoggingConfiguration.go api_op_PutManagedRuleSetVersions.go api_op_PutPermissionPolicy.go api_op_TagResource.go api_op_UntagResource.go api_op_UpdateIPSet.go api_op_UpdateManagedRuleSetVersionExpiryDate.go api_op_UpdateRegexPatternSet.go api_op_UpdateRuleGroup.go api_op_UpdateWebACL.go deserializers.go doc.go endpoints.go go_module_metadata.go serializers.go validators.go
Directories ¶
Path | Synopsis |
---|---|
internal | |
types |
- Version
- v1.19.0
- Published
- Apr 8, 2022
- Platform
- js/wasm
- Imports
- 33 packages
- Last checked
- now –
Tools for package owners.