@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
date="2023-03-14T16:25:26.366Z")
public interface CfnWebACLProps
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.wafv2.*; Object all; Object allQueryArguments; Object count; Object method; Object none; Object queryString; Object singleHeader; Object singleQueryArgument; StatementProperty statementProperty_; Object uriPath; CfnWebACLProps cfnWebACLProps = CfnWebACLProps.builder() .defaultAction(DefaultActionProperty.builder() .allow(AllowActionProperty.builder() .customRequestHandling(CustomRequestHandlingProperty.builder() .insertHeaders(List.of(CustomHTTPHeaderProperty.builder() .name("name") .value("value") .build())) .build()) .build()) .block(BlockActionProperty.builder() .customResponse(CustomResponseProperty.builder() .responseCode(123) // the properties below are optional .customResponseBodyKey("customResponseBodyKey") .responseHeaders(List.of(CustomHTTPHeaderProperty.builder() .name("name") .value("value") .build())) .build()) .build()) .build()) .scope("scope") .visibilityConfig(VisibilityConfigProperty.builder() .cloudWatchMetricsEnabled(false) .metricName("metricName") .sampledRequestsEnabled(false) .build()) // the properties below are optional .captchaConfig(CaptchaConfigProperty.builder() .immunityTimeProperty(ImmunityTimePropertyProperty.builder() .immunityTime(123) .build()) .build()) .challengeConfig(ChallengeConfigProperty.builder() .immunityTimeProperty(ImmunityTimePropertyProperty.builder() .immunityTime(123) .build()) .build()) .customResponseBodies(Map.of( "customResponseBodiesKey", CustomResponseBodyProperty.builder() .content("content") .contentType("contentType") .build())) .description("description") .name("name") .rules(List.of(RuleProperty.builder() .name("name") .priority(123) .statement(StatementProperty.builder() .andStatement(AndStatementProperty.builder() .statements(List.of(statementProperty_)) .build()) .byteMatchStatement(ByteMatchStatementProperty.builder() .fieldToMatch(FieldToMatchProperty.builder() .allQueryArguments(allQueryArguments) .body(BodyProperty.builder() .oversizeHandling("oversizeHandling") .build()) .cookies(CookiesProperty.builder() .matchPattern(CookieMatchPatternProperty.builder() .all(all) .excludedCookies(List.of("excludedCookies")) .includedCookies(List.of("includedCookies")) .build()) .matchScope("matchScope") .oversizeHandling("oversizeHandling") .build()) .headers(HeadersProperty.builder() .matchPattern(HeaderMatchPatternProperty.builder() .all(all) .excludedHeaders(List.of("excludedHeaders")) .includedHeaders(List.of("includedHeaders")) .build()) .matchScope("matchScope") .oversizeHandling("oversizeHandling") .build()) .jsonBody(JsonBodyProperty.builder() .matchPattern(JsonMatchPatternProperty.builder() .all(all) .includedPaths(List.of("includedPaths")) .build()) .matchScope("matchScope") // the properties below are optional .invalidFallbackBehavior("invalidFallbackBehavior") .oversizeHandling("oversizeHandling") .build()) .method(method) .queryString(queryString) .singleHeader(singleHeader) .singleQueryArgument(singleQueryArgument) .uriPath(uriPath) .build()) .positionalConstraint("positionalConstraint") .textTransformations(List.of(TextTransformationProperty.builder() .priority(123) .type("type") .build())) // the properties below are optional .searchString("searchString") .searchStringBase64("searchStringBase64") .build()) .geoMatchStatement(GeoMatchStatementProperty.builder() .countryCodes(List.of("countryCodes")) .forwardedIpConfig(ForwardedIPConfigurationProperty.builder() .fallbackBehavior("fallbackBehavior") .headerName("headerName") .build()) .build()) .ipSetReferenceStatement(Map.of( "arn", "arn", // the properties below are optional "ipSetForwardedIpConfig", Map.of( "fallbackBehavior", "fallbackBehavior", "headerName", "headerName", "position", "position"))) .labelMatchStatement(LabelMatchStatementProperty.builder() .key("key") .scope("scope") .build()) .managedRuleGroupStatement(ManagedRuleGroupStatementProperty.builder() .name("name") .vendorName("vendorName") // the properties below are optional .excludedRules(List.of(ExcludedRuleProperty.builder() .name("name") .build())) .managedRuleGroupConfigs(List.of(ManagedRuleGroupConfigProperty.builder() .awsManagedRulesBotControlRuleSet(AWSManagedRulesBotControlRuleSetProperty.builder() .inspectionLevel("inspectionLevel") .build()) .loginPath("loginPath") .passwordField(FieldIdentifierProperty.builder() .identifier("identifier") .build()) .payloadType("payloadType") .usernameField(FieldIdentifierProperty.builder() .identifier("identifier") .build()) .build())) .ruleActionOverrides(List.of(RuleActionOverrideProperty.builder() .actionToUse(RuleActionProperty.builder() .allow(AllowActionProperty.builder() .customRequestHandling(CustomRequestHandlingProperty.builder() .insertHeaders(List.of(CustomHTTPHeaderProperty.builder() .name("name") .value("value") .build())) .build()) .build()) .block(BlockActionProperty.builder() .customResponse(CustomResponseProperty.builder() .responseCode(123) // the properties below are optional .customResponseBodyKey("customResponseBodyKey") .responseHeaders(List.of(CustomHTTPHeaderProperty.builder() .name("name") .value("value") .build())) .build()) .build()) .captcha(CaptchaActionProperty.builder() .customRequestHandling(CustomRequestHandlingProperty.builder() .insertHeaders(List.of(CustomHTTPHeaderProperty.builder() .name("name") .value("value") .build())) .build()) .build()) .challenge(ChallengeActionProperty.builder() .customRequestHandling(CustomRequestHandlingProperty.builder() .insertHeaders(List.of(CustomHTTPHeaderProperty.builder() .name("name") .value("value") .build())) .build()) .build()) .count(CountActionProperty.builder() .customRequestHandling(CustomRequestHandlingProperty.builder() .insertHeaders(List.of(CustomHTTPHeaderProperty.builder() .name("name") .value("value") .build())) .build()) .build()) .build()) .name("name") .build())) .scopeDownStatement(statementProperty_) .version("version") .build()) .notStatement(NotStatementProperty.builder() .statement(statementProperty_) .build()) .orStatement(OrStatementProperty.builder() .statements(List.of(statementProperty_)) .build()) .rateBasedStatement(RateBasedStatementProperty.builder() .aggregateKeyType("aggregateKeyType") .limit(123) // the properties below are optional .forwardedIpConfig(ForwardedIPConfigurationProperty.builder() .fallbackBehavior("fallbackBehavior") .headerName("headerName") .build()) .scopeDownStatement(statementProperty_) .build()) .regexMatchStatement(RegexMatchStatementProperty.builder() .fieldToMatch(FieldToMatchProperty.builder() .allQueryArguments(allQueryArguments) .body(BodyProperty.builder() .oversizeHandling("oversizeHandling") .build()) .cookies(CookiesProperty.builder() .matchPattern(CookieMatchPatternProperty.builder() .all(all) .excludedCookies(List.of("excludedCookies")) .includedCookies(List.of("includedCookies")) .build()) .matchScope("matchScope") .oversizeHandling("oversizeHandling") .build()) .headers(HeadersProperty.builder() .matchPattern(HeaderMatchPatternProperty.builder() .all(all) .excludedHeaders(List.of("excludedHeaders")) .includedHeaders(List.of("includedHeaders")) .build()) .matchScope("matchScope") .oversizeHandling("oversizeHandling") .build()) .jsonBody(JsonBodyProperty.builder() .matchPattern(JsonMatchPatternProperty.builder() .all(all) .includedPaths(List.of("includedPaths")) .build()) .matchScope("matchScope") // the properties below are optional .invalidFallbackBehavior("invalidFallbackBehavior") .oversizeHandling("oversizeHandling") .build()) .method(method) .queryString(queryString) .singleHeader(singleHeader) .singleQueryArgument(singleQueryArgument) .uriPath(uriPath) .build()) .regexString("regexString") .textTransformations(List.of(TextTransformationProperty.builder() .priority(123) .type("type") .build())) .build()) .regexPatternSetReferenceStatement(RegexPatternSetReferenceStatementProperty.builder() .arn("arn") .fieldToMatch(FieldToMatchProperty.builder() .allQueryArguments(allQueryArguments) .body(BodyProperty.builder() .oversizeHandling("oversizeHandling") .build()) .cookies(CookiesProperty.builder() .matchPattern(CookieMatchPatternProperty.builder() .all(all) .excludedCookies(List.of("excludedCookies")) .includedCookies(List.of("includedCookies")) .build()) .matchScope("matchScope") .oversizeHandling("oversizeHandling") .build()) .headers(HeadersProperty.builder() .matchPattern(HeaderMatchPatternProperty.builder() .all(all) .excludedHeaders(List.of("excludedHeaders")) .includedHeaders(List.of("includedHeaders")) .build()) .matchScope("matchScope") .oversizeHandling("oversizeHandling") .build()) .jsonBody(JsonBodyProperty.builder() .matchPattern(JsonMatchPatternProperty.builder() .all(all) .includedPaths(List.of("includedPaths")) .build()) .matchScope("matchScope") // the properties below are optional .invalidFallbackBehavior("invalidFallbackBehavior") .oversizeHandling("oversizeHandling") .build()) .method(method) .queryString(queryString) .singleHeader(singleHeader) .singleQueryArgument(singleQueryArgument) .uriPath(uriPath) .build()) .textTransformations(List.of(TextTransformationProperty.builder() .priority(123) .type("type") .build())) .build()) .ruleGroupReferenceStatement(RuleGroupReferenceStatementProperty.builder() .arn("arn") // the properties below are optional .excludedRules(List.of(ExcludedRuleProperty.builder() .name("name") .build())) .ruleActionOverrides(List.of(RuleActionOverrideProperty.builder() .actionToUse(RuleActionProperty.builder() .allow(AllowActionProperty.builder() .customRequestHandling(CustomRequestHandlingProperty.builder() .insertHeaders(List.of(CustomHTTPHeaderProperty.builder() .name("name") .value("value") .build())) .build()) .build()) .block(BlockActionProperty.builder() .customResponse(CustomResponseProperty.builder() .responseCode(123) // the properties below are optional .customResponseBodyKey("customResponseBodyKey") .responseHeaders(List.of(CustomHTTPHeaderProperty.builder() .name("name") .value("value") .build())) .build()) .build()) .captcha(CaptchaActionProperty.builder() .customRequestHandling(CustomRequestHandlingProperty.builder() .insertHeaders(List.of(CustomHTTPHeaderProperty.builder() .name("name") .value("value") .build())) .build()) .build()) .challenge(ChallengeActionProperty.builder() .customRequestHandling(CustomRequestHandlingProperty.builder() .insertHeaders(List.of(CustomHTTPHeaderProperty.builder() .name("name") .value("value") .build())) .build()) .build()) .count(CountActionProperty.builder() .customRequestHandling(CustomRequestHandlingProperty.builder() .insertHeaders(List.of(CustomHTTPHeaderProperty.builder() .name("name") .value("value") .build())) .build()) .build()) .build()) .name("name") .build())) .build()) .sizeConstraintStatement(SizeConstraintStatementProperty.builder() .comparisonOperator("comparisonOperator") .fieldToMatch(FieldToMatchProperty.builder() .allQueryArguments(allQueryArguments) .body(BodyProperty.builder() .oversizeHandling("oversizeHandling") .build()) .cookies(CookiesProperty.builder() .matchPattern(CookieMatchPatternProperty.builder() .all(all) .excludedCookies(List.of("excludedCookies")) .includedCookies(List.of("includedCookies")) .build()) .matchScope("matchScope") .oversizeHandling("oversizeHandling") .build()) .headers(HeadersProperty.builder() .matchPattern(HeaderMatchPatternProperty.builder() .all(all) .excludedHeaders(List.of("excludedHeaders")) .includedHeaders(List.of("includedHeaders")) .build()) .matchScope("matchScope") .oversizeHandling("oversizeHandling") .build()) .jsonBody(JsonBodyProperty.builder() .matchPattern(JsonMatchPatternProperty.builder() .all(all) .includedPaths(List.of("includedPaths")) .build()) .matchScope("matchScope") // the properties below are optional .invalidFallbackBehavior("invalidFallbackBehavior") .oversizeHandling("oversizeHandling") .build()) .method(method) .queryString(queryString) .singleHeader(singleHeader) .singleQueryArgument(singleQueryArgument) .uriPath(uriPath) .build()) .size(123) .textTransformations(List.of(TextTransformationProperty.builder() .priority(123) .type("type") .build())) .build()) .sqliMatchStatement(SqliMatchStatementProperty.builder() .fieldToMatch(FieldToMatchProperty.builder() .allQueryArguments(allQueryArguments) .body(BodyProperty.builder() .oversizeHandling("oversizeHandling") .build()) .cookies(CookiesProperty.builder() .matchPattern(CookieMatchPatternProperty.builder() .all(all) .excludedCookies(List.of("excludedCookies")) .includedCookies(List.of("includedCookies")) .build()) .matchScope("matchScope") .oversizeHandling("oversizeHandling") .build()) .headers(HeadersProperty.builder() .matchPattern(HeaderMatchPatternProperty.builder() .all(all) .excludedHeaders(List.of("excludedHeaders")) .includedHeaders(List.of("includedHeaders")) .build()) .matchScope("matchScope") .oversizeHandling("oversizeHandling") .build()) .jsonBody(JsonBodyProperty.builder() .matchPattern(JsonMatchPatternProperty.builder() .all(all) .includedPaths(List.of("includedPaths")) .build()) .matchScope("matchScope") // the properties below are optional .invalidFallbackBehavior("invalidFallbackBehavior") .oversizeHandling("oversizeHandling") .build()) .method(method) .queryString(queryString) .singleHeader(singleHeader) .singleQueryArgument(singleQueryArgument) .uriPath(uriPath) .build()) .textTransformations(List.of(TextTransformationProperty.builder() .priority(123) .type("type") .build())) // the properties below are optional .sensitivityLevel("sensitivityLevel") .build()) .xssMatchStatement(XssMatchStatementProperty.builder() .fieldToMatch(FieldToMatchProperty.builder() .allQueryArguments(allQueryArguments) .body(BodyProperty.builder() .oversizeHandling("oversizeHandling") .build()) .cookies(CookiesProperty.builder() .matchPattern(CookieMatchPatternProperty.builder() .all(all) .excludedCookies(List.of("excludedCookies")) .includedCookies(List.of("includedCookies")) .build()) .matchScope("matchScope") .oversizeHandling("oversizeHandling") .build()) .headers(HeadersProperty.builder() .matchPattern(HeaderMatchPatternProperty.builder() .all(all) .excludedHeaders(List.of("excludedHeaders")) .includedHeaders(List.of("includedHeaders")) .build()) .matchScope("matchScope") .oversizeHandling("oversizeHandling") .build()) .jsonBody(JsonBodyProperty.builder() .matchPattern(JsonMatchPatternProperty.builder() .all(all) .includedPaths(List.of("includedPaths")) .build()) .matchScope("matchScope") // the properties below are optional .invalidFallbackBehavior("invalidFallbackBehavior") .oversizeHandling("oversizeHandling") .build()) .method(method) .queryString(queryString) .singleHeader(singleHeader) .singleQueryArgument(singleQueryArgument) .uriPath(uriPath) .build()) .textTransformations(List.of(TextTransformationProperty.builder() .priority(123) .type("type") .build())) .build()) .build()) .visibilityConfig(VisibilityConfigProperty.builder() .cloudWatchMetricsEnabled(false) .metricName("metricName") .sampledRequestsEnabled(false) .build()) // the properties below are optional .action(RuleActionProperty.builder() .allow(AllowActionProperty.builder() .customRequestHandling(CustomRequestHandlingProperty.builder() .insertHeaders(List.of(CustomHTTPHeaderProperty.builder() .name("name") .value("value") .build())) .build()) .build()) .block(BlockActionProperty.builder() .customResponse(CustomResponseProperty.builder() .responseCode(123) // the properties below are optional .customResponseBodyKey("customResponseBodyKey") .responseHeaders(List.of(CustomHTTPHeaderProperty.builder() .name("name") .value("value") .build())) .build()) .build()) .captcha(CaptchaActionProperty.builder() .customRequestHandling(CustomRequestHandlingProperty.builder() .insertHeaders(List.of(CustomHTTPHeaderProperty.builder() .name("name") .value("value") .build())) .build()) .build()) .challenge(ChallengeActionProperty.builder() .customRequestHandling(CustomRequestHandlingProperty.builder() .insertHeaders(List.of(CustomHTTPHeaderProperty.builder() .name("name") .value("value") .build())) .build()) .build()) .count(CountActionProperty.builder() .customRequestHandling(CustomRequestHandlingProperty.builder() .insertHeaders(List.of(CustomHTTPHeaderProperty.builder() .name("name") .value("value") .build())) .build()) .build()) .build()) .captchaConfig(CaptchaConfigProperty.builder() .immunityTimeProperty(ImmunityTimePropertyProperty.builder() .immunityTime(123) .build()) .build()) .challengeConfig(ChallengeConfigProperty.builder() .immunityTimeProperty(ImmunityTimePropertyProperty.builder() .immunityTime(123) .build()) .build()) .overrideAction(OverrideActionProperty.builder() .count(count) .none(none) .build()) .ruleLabels(List.of(LabelProperty.builder() .name("name") .build())) .build())) .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .tokenDomains(List.of("tokenDomains")) .build();
Modifier and Type | Interface and Description |
---|---|
static class |
CfnWebACLProps.Builder
A builder for
CfnWebACLProps |
static class |
CfnWebACLProps.Jsii$Proxy
An implementation for
CfnWebACLProps |
Modifier and Type | Method and Description |
---|---|
static CfnWebACLProps.Builder |
builder() |
default java.lang.Object |
getCaptchaConfig()
Specifies how AWS WAF should handle `CAPTCHA` evaluations for rules that don't have their own `CaptchaConfig` settings.
|
default java.lang.Object |
getChallengeConfig()
Specifies how AWS WAF should handle challenge evaluations for rules that don't have their own `ChallengeConfig` settings.
|
default java.lang.Object |
getCustomResponseBodies()
A map of custom response keys and content bodies.
|
java.lang.Object |
getDefaultAction()
The action to perform if none of the `Rules` contained in the `WebACL` match.
|
default java.lang.String |
getDescription()
A description of the web ACL that helps with identification.
|
default java.lang.String |
getName()
The name of the web ACL.
|
default java.lang.Object |
getRules()
The rule statements used to identify the web requests that you want to allow, block, or count.
|
java.lang.String |
getScope()
Specifies whether this is for an Amazon CloudFront distribution or for a regional application.
|
default java.util.List<CfnTag> |
getTags()
Key:value pairs associated with an AWS resource.
|
default java.util.List<java.lang.String> |
getTokenDomains()
Specifies the domains that AWS WAF should accept in a web request token.
|
java.lang.Object |
getVisibilityConfig()
Defines and enables Amazon CloudWatch metrics and web request sample collection.
|
java.lang.Object getDefaultAction()
java.lang.String getScope()
A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AWS AppSync GraphQL API, an Amazon Cognito user pool, or an AWS App Runner service. Valid Values are CLOUDFRONT
and REGIONAL
.
For
CLOUDFRONT
, you must create your WAFv2 resources in the US East (N. Virginia) Region,us-east-1
.
For information about how to define the association of the web ACL with your resource, see WebACLAssociation
.
java.lang.Object getVisibilityConfig()
default java.lang.Object getCaptchaConfig()
If you don't specify this, AWS WAF uses its default settings for CaptchaConfig
.
default java.lang.Object getChallengeConfig()
If you don't specify this, AWS WAF uses its default settings for ChallengeConfig
.
default java.lang.Object getCustomResponseBodies()
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 AWS WAF in the AWS WAF Developer Guide .
For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide .
default java.lang.String getDescription()
default java.lang.String getName()
You cannot change the name of a web ACL after you create it.
default java.lang.Object getRules()
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.
default java.util.List<CfnTag> getTags()
The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each AWS resource.
To modify tags on existing resources, use the AWS WAF APIs or command line interface. With AWS CloudFormation , you can only add tags to AWS WAF resources during resource creation.
default java.util.List<java.lang.String> getTokenDomains()
This enables the use of tokens across multiple protected websites. When AWS WAF provides a token, it uses the domain of the AWS resource that the web ACL is protecting. If you don't specify a list of token domains, AWS WAF accepts tokens only for the domain of the protected resource. With a token domain list, AWS WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.
static CfnWebACLProps.Builder builder()
CfnWebACLProps.Builder
of CfnWebACLProps