Paws::WAFv2::CreateRuleGroup - Arguments for method CreateRuleGroup on Paws::WAFv2
This class represents the parameters used for calling the method CreateRuleGroup on the AWS WAFV2 service. Use the attributes of this class as arguments to method CreateRuleGroup.
You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateRuleGroup.
my $wafv2 = Paws->service('WAFv2'); my $CreateRuleGroupResponse = $wafv2->CreateRuleGroup( Capacity => 1, Name => 'MyEntityName', Scope => 'CLOUDFRONT', VisibilityConfig => { CloudWatchMetricsEnabled => 1, MetricName => 'MyMetricName', # min: 1, max: 255 SampledRequestsEnabled => 1, }, Description => 'MyEntityDescription', # OPTIONAL Rules => [ { Name => 'MyEntityName', # min: 1, max: 128 Priority => 1, Statement => { AndStatement => { Statements => [ <Statement>, ... ], }, # OPTIONAL ByteMatchStatement => { FieldToMatch => { AllQueryArguments => { }, # OPTIONAL Body => { }, # OPTIONAL Method => { }, # OPTIONAL QueryString => { }, # OPTIONAL SingleHeader => { Name => 'MyFieldToMatchData', # min: 1, max: 64 }, # OPTIONAL SingleQueryArgument => { Name => 'MyFieldToMatchData', # min: 1, max: 64 }, # OPTIONAL UriPath => { }, # OPTIONAL }, PositionalConstraint => 'EXACTLY' , # values: EXACTLY, STARTS_WITH, ENDS_WITH, CONTAINS, CONTAINS_WORD SearchString => 'BlobSearchString', TextTransformations => [ { Priority => 1, Type => 'NONE' , # values: NONE, COMPRESS_WHITE_SPACE, HTML_ENTITY_DECODE, LOWERCASE, CMD_LINE, URL_DECODE }, ... ], # min: 1 }, # OPTIONAL GeoMatchStatement => { CountryCodes => [ 'AF', ... # values: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KP, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW ], # min: 1; OPTIONAL }, # OPTIONAL IPSetReferenceStatement => { ARN => 'MyResourceArn', # min: 20, max: 2048 }, # OPTIONAL ManagedRuleGroupStatement => { Name => 'MyEntityName', # min: 1, max: 128 VendorName => 'MyVendorName', # min: 1, max: 128 ExcludedRules => [ { Name => 'MyEntityName', # min: 1, max: 128 }, ... ], # OPTIONAL }, # OPTIONAL NotStatement => { Statement => <Statement>, }, # OPTIONAL OrStatement => { Statements => [ <Statement>, ... ], }, # OPTIONAL RateBasedStatement => { AggregateKeyType => 'IP', # values: IP Limit => 1, # min: 100, max: 2000000000 ScopeDownStatement => <Statement>, }, # OPTIONAL RegexPatternSetReferenceStatement => { ARN => 'MyResourceArn', # min: 20, max: 2048 FieldToMatch => { AllQueryArguments => { }, # OPTIONAL Body => { }, # OPTIONAL Method => { }, # OPTIONAL QueryString => { }, # OPTIONAL SingleHeader => { Name => 'MyFieldToMatchData', # min: 1, max: 64 }, # OPTIONAL SingleQueryArgument => { Name => 'MyFieldToMatchData', # min: 1, max: 64 }, # OPTIONAL UriPath => { }, # OPTIONAL }, TextTransformations => [ { Priority => 1, Type => 'NONE' , # values: NONE, COMPRESS_WHITE_SPACE, HTML_ENTITY_DECODE, LOWERCASE, CMD_LINE, URL_DECODE }, ... ], # min: 1 }, # OPTIONAL RuleGroupReferenceStatement => { ARN => 'MyResourceArn', # min: 20, max: 2048 ExcludedRules => [ { Name => 'MyEntityName', # min: 1, max: 128 }, ... ], # OPTIONAL }, # OPTIONAL SizeConstraintStatement => { ComparisonOperator => 'EQ', # values: EQ, NE, LE, LT, GE, GT FieldToMatch => { AllQueryArguments => { }, # OPTIONAL Body => { }, # OPTIONAL Method => { }, # OPTIONAL QueryString => { }, # OPTIONAL SingleHeader => { Name => 'MyFieldToMatchData', # min: 1, max: 64 }, # OPTIONAL SingleQueryArgument => { Name => 'MyFieldToMatchData', # min: 1, max: 64 }, # OPTIONAL UriPath => { }, # OPTIONAL }, Size => 1, # max: 21474836480 TextTransformations => [ { Priority => 1, Type => 'NONE' , # values: NONE, COMPRESS_WHITE_SPACE, HTML_ENTITY_DECODE, LOWERCASE, CMD_LINE, URL_DECODE }, ... ], # min: 1 }, # OPTIONAL SqliMatchStatement => { FieldToMatch => { AllQueryArguments => { }, # OPTIONAL Body => { }, # OPTIONAL Method => { }, # OPTIONAL QueryString => { }, # OPTIONAL SingleHeader => { Name => 'MyFieldToMatchData', # min: 1, max: 64 }, # OPTIONAL SingleQueryArgument => { Name => 'MyFieldToMatchData', # min: 1, max: 64 }, # OPTIONAL UriPath => { }, # OPTIONAL }, TextTransformations => [ { Priority => 1, Type => 'NONE' , # values: NONE, COMPRESS_WHITE_SPACE, HTML_ENTITY_DECODE, LOWERCASE, CMD_LINE, URL_DECODE }, ... ], # min: 1 }, # OPTIONAL XssMatchStatement => { FieldToMatch => { AllQueryArguments => { }, # OPTIONAL Body => { }, # OPTIONAL Method => { }, # OPTIONAL QueryString => { }, # OPTIONAL SingleHeader => { Name => 'MyFieldToMatchData', # min: 1, max: 64 }, # OPTIONAL SingleQueryArgument => { Name => 'MyFieldToMatchData', # min: 1, max: 64 }, # OPTIONAL UriPath => { }, # OPTIONAL }, TextTransformations => [ { Priority => 1, Type => 'NONE' , # values: NONE, COMPRESS_WHITE_SPACE, HTML_ENTITY_DECODE, LOWERCASE, CMD_LINE, URL_DECODE }, ... ], # min: 1 }, # OPTIONAL }, VisibilityConfig => { CloudWatchMetricsEnabled => 1, MetricName => 'MyMetricName', # min: 1, max: 255 SampledRequestsEnabled => 1, }, Action => { Allow => { }, # OPTIONAL Block => { }, # OPTIONAL Count => { }, # OPTIONAL }, # OPTIONAL OverrideAction => { Count => { }, # OPTIONAL None => { }, # OPTIONAL }, # OPTIONAL }, ... ], # OPTIONAL Tags => [ { Key => 'MyTagKey', # min: 1, max: 128 Value => 'MyTagValue', # max: 256 }, ... ], # OPTIONAL ); # Results: my $Summary = $CreateRuleGroupResponse->Summary; # Returns a L<Paws::WAFv2::CreateRuleGroupResponse> object.
Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/wafv2/CreateRuleGroup
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, AWS WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity.
AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.
A friendly description of the rule group. You cannot change the description of a rule group after you create it.
A friendly name of the rule group. You cannot change the name of a rule group after you create it.
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 AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them.
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
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.
--scope=CLOUDFRONT --region=us-east-1
API and SDKs - For all calls, use the Region endpoint us-east-1.
Valid values are: "CLOUDFRONT", "REGIONAL"
"CLOUDFRONT"
"REGIONAL"
An array of key:value pairs to associate with the resource.
Defines and enables Amazon CloudWatch metrics and web request sample collection.
This class forms part of Paws, documenting arguments for method CreateRuleGroup in Paws::WAFv2
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
To install Paws::SDK::Config, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Paws::SDK::Config
CPAN shell
perl -MCPAN -e shell install Paws::SDK::Config
For more information on module installation, please visit the detailed CPAN module installation guide.