1. Packages
  2. AWS Native
  3. API Docs
  4. wafv2
  5. getWebAcl

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.100.0 published on Wednesday, Mar 27, 2024 by Pulumi

aws-native.wafv2.getWebAcl

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.100.0 published on Wednesday, Mar 27, 2024 by Pulumi

    Contains the Rules that identify the requests that you want to allow, block, or count. In a WebACL, you also specify a default action (ALLOW or BLOCK), and the action for each Rule that you add to a WebACL, for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the WebACL with a CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one Rule to a WebACL, a request needs to match only one of the specifications to be allowed, blocked, or counted.

    Using getWebAcl

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getWebAcl(args: GetWebAclArgs, opts?: InvokeOptions): Promise<GetWebAclResult>
    function getWebAclOutput(args: GetWebAclOutputArgs, opts?: InvokeOptions): Output<GetWebAclResult>
    def get_web_acl(id: Optional[str] = None,
                    name: Optional[str] = None,
                    scope: Optional[WebAclScope] = None,
                    opts: Optional[InvokeOptions] = None) -> GetWebAclResult
    def get_web_acl_output(id: Optional[pulumi.Input[str]] = None,
                    name: Optional[pulumi.Input[str]] = None,
                    scope: Optional[pulumi.Input[WebAclScope]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetWebAclResult]
    func LookupWebAcl(ctx *Context, args *LookupWebAclArgs, opts ...InvokeOption) (*LookupWebAclResult, error)
    func LookupWebAclOutput(ctx *Context, args *LookupWebAclOutputArgs, opts ...InvokeOption) LookupWebAclResultOutput

    > Note: This function is named LookupWebAcl in the Go SDK.

    public static class GetWebAcl 
    {
        public static Task<GetWebAclResult> InvokeAsync(GetWebAclArgs args, InvokeOptions? opts = null)
        public static Output<GetWebAclResult> Invoke(GetWebAclInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetWebAclResult> getWebAcl(GetWebAclArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:wafv2:getWebAcl
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    Name string
    Scope WebAclScope
    id String
    name String
    scope WebAclScope
    id string
    name string
    scope WebAclScope

    getWebAcl Result

    The following output properties are available:

    Supporting Types

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    WebAclAllowAction

    WebAclAndStatement

    WebAclAssociationConfig

    RequestBody Dictionary<string, Pulumi.AwsNative.WaFv2.Inputs.WebAclRequestBodyAssociatedResourceTypeConfig>
    RequestBody map[string]WebAclRequestBodyAssociatedResourceTypeConfig
    requestBody Map<String,WebAclRequestBodyAssociatedResourceTypeConfig>
    requestBody {[key: string]: WebAclRequestBodyAssociatedResourceTypeConfig}
    request_body Mapping[str, WebAclRequestBodyAssociatedResourceTypeConfig]
    requestBody Map<Property Map>

    WebAclAwsManagedRulesAcfpRuleSet

    WebAclAwsManagedRulesAtpRuleSet

    WebAclAwsManagedRulesBotControlRuleSet

    WebAclAwsManagedRulesBotControlRuleSetInspectionLevel

    WebAclBlockAction

    WebAclBody

    WebAclBodyParsingFallbackBehavior

    WebAclByteMatchStatement

    WebAclCaptchaAction

    WebAclCaptchaConfig

    WebAclChallengeAction

    WebAclChallengeConfig

    WebAclCookieMatchPattern

    All object
    Inspect all parts of the web request cookies.
    ExcludedCookies List<string>
    IncludedCookies List<string>
    All interface{}
    Inspect all parts of the web request cookies.
    ExcludedCookies []string
    IncludedCookies []string
    all Object
    Inspect all parts of the web request cookies.
    excludedCookies List<String>
    includedCookies List<String>
    all any
    Inspect all parts of the web request cookies.
    excludedCookies string[]
    includedCookies string[]
    all Any
    Inspect all parts of the web request cookies.
    excluded_cookies Sequence[str]
    included_cookies Sequence[str]
    all Any
    Inspect all parts of the web request cookies.
    excludedCookies List<String>
    includedCookies List<String>

    WebAclCookies

    WebAclCountAction

    WebAclCustomHttpHeader

    Name string
    Value string
    Name string
    Value string
    name String
    value String
    name string
    value string
    name str
    value str
    name String
    value String

    WebAclCustomRequestHandling

    InsertHeaders []WebAclCustomHttpHeader
    Collection of HTTP headers.
    insertHeaders List<WebAclCustomHttpHeader>
    Collection of HTTP headers.
    insertHeaders WebAclCustomHttpHeader[]
    Collection of HTTP headers.
    insertHeaders List<Property Map>
    Collection of HTTP headers.

    WebAclCustomResponse

    ResponseCode int
    CustomResponseBodyKey string
    Custom response body key.
    ResponseHeaders []WebAclCustomHttpHeader
    Collection of HTTP headers.
    responseCode Integer
    customResponseBodyKey String
    Custom response body key.
    responseHeaders List<WebAclCustomHttpHeader>
    Collection of HTTP headers.
    responseCode number
    customResponseBodyKey string
    Custom response body key.
    responseHeaders WebAclCustomHttpHeader[]
    Collection of HTTP headers.
    response_code int
    custom_response_body_key str
    Custom response body key.
    response_headers Sequence[WebAclCustomHttpHeader]
    Collection of HTTP headers.
    responseCode Number
    customResponseBodyKey String
    Custom response body key.
    responseHeaders List<Property Map>
    Collection of HTTP headers.

    WebAclCustomResponseBody

    WebAclDefaultAction

    WebAclExcludedRule

    Name string
    Name string
    name String
    name string
    name str
    name String

    WebAclFieldIdentifier

    Identifier string
    Identifier string
    identifier String
    identifier string
    identifier String

    WebAclFieldToMatch

    AllQueryArguments object
    All query arguments of a web request.
    Body Pulumi.AwsNative.WaFv2.Inputs.WebAclBody
    Cookies Pulumi.AwsNative.WaFv2.Inputs.WebAclCookies
    Headers Pulumi.AwsNative.WaFv2.Inputs.WebAclHeaders
    Ja3Fingerprint Pulumi.AwsNative.WaFv2.Inputs.WebAclJa3Fingerprint
    JsonBody Pulumi.AwsNative.WaFv2.Inputs.WebAclJsonBody
    Method object
    The HTTP method of a web request. The method indicates the type of operation that the request is asking the origin to perform.
    QueryString object
    The query string of a web request. This is the part of a URL that appears after a ? character, if any.
    SingleHeader Pulumi.AwsNative.WaFv2.Inputs.WebAclFieldToMatchSingleHeaderProperties
    SingleQueryArgument Pulumi.AwsNative.WaFv2.Inputs.WebAclFieldToMatchSingleQueryArgumentProperties
    One query argument in a web request, identified by name, for example UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive.
    UriPath object
    The path component of the URI of a web request. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.
    AllQueryArguments interface{}
    All query arguments of a web request.
    Body WebAclBody
    Cookies WebAclCookies
    Headers WebAclHeaders
    Ja3Fingerprint WebAclJa3Fingerprint
    JsonBody WebAclJsonBody
    Method interface{}
    The HTTP method of a web request. The method indicates the type of operation that the request is asking the origin to perform.
    QueryString interface{}
    The query string of a web request. This is the part of a URL that appears after a ? character, if any.
    SingleHeader WebAclFieldToMatchSingleHeaderProperties
    SingleQueryArgument WebAclFieldToMatchSingleQueryArgumentProperties
    One query argument in a web request, identified by name, for example UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive.
    UriPath interface{}
    The path component of the URI of a web request. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.
    allQueryArguments Object
    All query arguments of a web request.
    body WebAclBody
    cookies WebAclCookies
    headers WebAclHeaders
    ja3Fingerprint WebAclJa3Fingerprint
    jsonBody WebAclJsonBody
    method Object
    The HTTP method of a web request. The method indicates the type of operation that the request is asking the origin to perform.
    queryString Object
    The query string of a web request. This is the part of a URL that appears after a ? character, if any.
    singleHeader WebAclFieldToMatchSingleHeaderProperties
    singleQueryArgument WebAclFieldToMatchSingleQueryArgumentProperties
    One query argument in a web request, identified by name, for example UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive.
    uriPath Object
    The path component of the URI of a web request. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.
    allQueryArguments any
    All query arguments of a web request.
    body WebAclBody
    cookies WebAclCookies
    headers WebAclHeaders
    ja3Fingerprint WebAclJa3Fingerprint
    jsonBody WebAclJsonBody
    method any
    The HTTP method of a web request. The method indicates the type of operation that the request is asking the origin to perform.
    queryString any
    The query string of a web request. This is the part of a URL that appears after a ? character, if any.
    singleHeader WebAclFieldToMatchSingleHeaderProperties
    singleQueryArgument WebAclFieldToMatchSingleQueryArgumentProperties
    One query argument in a web request, identified by name, for example UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive.
    uriPath any
    The path component of the URI of a web request. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.
    all_query_arguments Any
    All query arguments of a web request.
    body WebAclBody
    cookies WebAclCookies
    headers WebAclHeaders
    ja3_fingerprint WebAclJa3Fingerprint
    json_body WebAclJsonBody
    method Any
    The HTTP method of a web request. The method indicates the type of operation that the request is asking the origin to perform.
    query_string Any
    The query string of a web request. This is the part of a URL that appears after a ? character, if any.
    single_header WebAclFieldToMatchSingleHeaderProperties
    single_query_argument WebAclFieldToMatchSingleQueryArgumentProperties
    One query argument in a web request, identified by name, for example UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive.
    uri_path Any
    The path component of the URI of a web request. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.
    allQueryArguments Any
    All query arguments of a web request.
    body Property Map
    cookies Property Map
    headers Property Map
    ja3Fingerprint Property Map
    jsonBody Property Map
    method Any
    The HTTP method of a web request. The method indicates the type of operation that the request is asking the origin to perform.
    queryString Any
    The query string of a web request. This is the part of a URL that appears after a ? character, if any.
    singleHeader Property Map
    singleQueryArgument Property Map
    One query argument in a web request, identified by name, for example UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive.
    uriPath Any
    The path component of the URI of a web request. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

    WebAclFieldToMatchSingleHeaderProperties

    Name string
    Name string
    name String
    name string
    name str
    name String

    WebAclFieldToMatchSingleQueryArgumentProperties

    Name string
    Name string
    name String
    name string
    name str
    name String

    WebAclForwardedIpConfiguration

    WebAclForwardedIpConfigurationFallbackBehavior

    WebAclGeoMatchStatement

    WebAclHeaderMatchPattern

    All object
    Inspect all parts of the web request headers.
    ExcludedHeaders List<string>
    IncludedHeaders List<string>
    All interface{}
    Inspect all parts of the web request headers.
    ExcludedHeaders []string
    IncludedHeaders []string
    all Object
    Inspect all parts of the web request headers.
    excludedHeaders List<String>
    includedHeaders List<String>
    all any
    Inspect all parts of the web request headers.
    excludedHeaders string[]
    includedHeaders string[]
    all Any
    Inspect all parts of the web request headers.
    excluded_headers Sequence[str]
    included_headers Sequence[str]
    all Any
    Inspect all parts of the web request headers.
    excludedHeaders List<String>
    includedHeaders List<String>

    WebAclHeaders

    WebAclImmunityTimeProperty

    immunityTime Integer

    WebAclIpSetForwardedIpConfiguration

    WebAclIpSetForwardedIpConfigurationFallbackBehavior

    WebAclIpSetForwardedIpConfigurationPosition

    WebAclIpSetReferenceStatement

    WebAclJa3Fingerprint

    WebAclJa3FingerprintFallbackBehavior

    WebAclJsonBody

    WebAclJsonMatchPattern

    All object
    Inspect all parts of the web request's JSON body.
    IncludedPaths List<string>
    All interface{}
    Inspect all parts of the web request's JSON body.
    IncludedPaths []string
    all Object
    Inspect all parts of the web request's JSON body.
    includedPaths List<String>
    all any
    Inspect all parts of the web request's JSON body.
    includedPaths string[]
    all Any
    Inspect all parts of the web request's JSON body.
    included_paths Sequence[str]
    all Any
    Inspect all parts of the web request's JSON body.
    includedPaths List<String>

    WebAclJsonMatchScope

    WebAclLabel

    Name string
    Name string
    name String
    name string
    name str
    name String

    WebAclLabelMatchScope

    WebAclLabelMatchStatement

    WebAclManagedRuleGroupConfig

    WebAclManagedRuleGroupConfigPayloadType

    WebAclManagedRuleGroupStatement

    name String
    vendorName String
    excludedRules List<Property Map>
    managedRuleGroupConfigs List<Property Map>
    Collection of ManagedRuleGroupConfig.
    ruleActionOverrides List<Property Map>
    Action overrides for rules in the rule group.
    scopeDownStatement Property Map
    version String

    WebAclMapMatchScope

    WebAclNotStatement

    WebAclOrStatement

    WebAclOverrideAction

    Count object
    Count traffic towards application.
    None object
    Keep the RuleGroup or ManagedRuleGroup behavior as is.
    Count interface{}
    Count traffic towards application.
    None interface{}
    Keep the RuleGroup or ManagedRuleGroup behavior as is.
    count Object
    Count traffic towards application.
    none Object
    Keep the RuleGroup or ManagedRuleGroup behavior as is.
    count any
    Count traffic towards application.
    none any
    Keep the RuleGroup or ManagedRuleGroup behavior as is.
    count Any
    Count traffic towards application.
    none Any
    Keep the RuleGroup or ManagedRuleGroup behavior as is.
    count Any
    Count traffic towards application.
    none Any
    Keep the RuleGroup or ManagedRuleGroup behavior as is.

    WebAclOversizeHandling

    WebAclPositionalConstraint

    WebAclRateBasedStatement

    WebAclRateBasedStatementAggregateKeyType

    WebAclRateBasedStatementCustomKey

    WebAclRateLimitCookie

    Name string
    The name of the cookie to use.
    TextTransformations []WebAclTextTransformation
    name String
    The name of the cookie to use.
    textTransformations List<WebAclTextTransformation>
    name string
    The name of the cookie to use.
    textTransformations WebAclTextTransformation[]
    name String
    The name of the cookie to use.
    textTransformations List<Property Map>

    WebAclRateLimitHeader

    Name string
    The name of the header to use.
    TextTransformations []WebAclTextTransformation
    name String
    The name of the header to use.
    textTransformations List<WebAclTextTransformation>
    name string
    The name of the header to use.
    textTransformations WebAclTextTransformation[]
    name String
    The name of the header to use.
    textTransformations List<Property Map>

    WebAclRateLimitLabelNamespace

    Namespace string
    The namespace to use for aggregation.
    Namespace string
    The namespace to use for aggregation.
    namespace String
    The namespace to use for aggregation.
    namespace string
    The namespace to use for aggregation.
    namespace str
    The namespace to use for aggregation.
    namespace String
    The namespace to use for aggregation.

    WebAclRateLimitQueryArgument

    Name string
    The name of the query argument to use.
    TextTransformations []WebAclTextTransformation
    name String
    The name of the query argument to use.
    textTransformations List<WebAclTextTransformation>
    name string
    The name of the query argument to use.
    textTransformations WebAclTextTransformation[]
    name str
    The name of the query argument to use.
    text_transformations Sequence[WebAclTextTransformation]
    name String
    The name of the query argument to use.
    textTransformations List<Property Map>

    WebAclRateLimitQueryString

    WebAclRateLimitUriPath

    WebAclRegexMatchStatement

    WebAclRegexPatternSetReferenceStatement

    WebAclRequestBodyAssociatedResourceTypeConfig

    WebAclRequestInspection

    WebAclRequestInspectionAcfp

    WebAclRequestInspectionAcfpPayloadType

    WebAclRequestInspectionPayloadType

    WebAclResponseContentType

    WebAclResponseInspection

    WebAclResponseInspectionBodyContains

    FailureStrings List<string>
    SuccessStrings List<string>
    failureStrings List<String>
    successStrings List<String>
    failure_strings Sequence[str]
    success_strings Sequence[str]
    failureStrings List<String>
    successStrings List<String>

    WebAclResponseInspectionHeader

    FailureValues List<string>
    Name string
    SuccessValues List<string>
    FailureValues []string
    Name string
    SuccessValues []string
    failureValues List<String>
    name String
    successValues List<String>
    failureValues string[]
    name string
    successValues string[]
    failure_values Sequence[str]
    name str
    success_values Sequence[str]
    failureValues List<String>
    name String
    successValues List<String>

    WebAclResponseInspectionJson

    FailureValues List<string>
    Identifier string
    SuccessValues List<string>
    FailureValues []string
    Identifier string
    SuccessValues []string
    failureValues List<String>
    identifier String
    successValues List<String>
    failureValues string[]
    identifier string
    successValues string[]
    failure_values Sequence[str]
    identifier str
    success_values Sequence[str]
    failureValues List<String>
    identifier String
    successValues List<String>

    WebAclResponseInspectionStatusCode

    FailureCodes List<int>
    SuccessCodes List<int>
    failureCodes List<Integer>
    successCodes List<Integer>
    failureCodes number[]
    successCodes number[]
    failure_codes Sequence[int]
    success_codes Sequence[int]
    failureCodes List<Number>
    successCodes List<Number>

    WebAclRule

    WebAclRuleAction

    WebAclRuleActionOverride

    WebAclRuleGroupReferenceStatement

    Arn string
    ExcludedRules []WebAclExcludedRule
    RuleActionOverrides []WebAclRuleActionOverride
    Action overrides for rules in the rule group.
    arn string
    excludedRules WebAclExcludedRule[]
    ruleActionOverrides WebAclRuleActionOverride[]
    Action overrides for rules in the rule group.
    arn String
    excludedRules List<Property Map>
    ruleActionOverrides List<Property Map>
    Action overrides for rules in the rule group.

    WebAclScope

    WebAclSensitivityLevel

    WebAclSizeConstraintStatement

    WebAclSizeConstraintStatementComparisonOperator

    WebAclSizeInspectionLimit

    WebAclSqliMatchStatement

    WebAclStatement

    AndStatement Pulumi.AwsNative.WaFv2.Inputs.WebAclAndStatement
    ByteMatchStatement Pulumi.AwsNative.WaFv2.Inputs.WebAclByteMatchStatement
    GeoMatchStatement Pulumi.AwsNative.WaFv2.Inputs.WebAclGeoMatchStatement
    IpSetReferenceStatement Pulumi.AwsNative.WaFv2.Inputs.WebAclIpSetReferenceStatement
    LabelMatchStatement Pulumi.AwsNative.WaFv2.Inputs.WebAclLabelMatchStatement
    ManagedRuleGroupStatement Pulumi.AwsNative.WaFv2.Inputs.WebAclManagedRuleGroupStatement
    NotStatement Pulumi.AwsNative.WaFv2.Inputs.WebAclNotStatement
    OrStatement Pulumi.AwsNative.WaFv2.Inputs.WebAclOrStatement
    RateBasedStatement Pulumi.AwsNative.WaFv2.Inputs.WebAclRateBasedStatement
    RegexMatchStatement Pulumi.AwsNative.WaFv2.Inputs.WebAclRegexMatchStatement
    RegexPatternSetReferenceStatement Pulumi.AwsNative.WaFv2.Inputs.WebAclRegexPatternSetReferenceStatement
    RuleGroupReferenceStatement Pulumi.AwsNative.WaFv2.Inputs.WebAclRuleGroupReferenceStatement
    SizeConstraintStatement Pulumi.AwsNative.WaFv2.Inputs.WebAclSizeConstraintStatement
    SqliMatchStatement Pulumi.AwsNative.WaFv2.Inputs.WebAclSqliMatchStatement
    XssMatchStatement Pulumi.AwsNative.WaFv2.Inputs.WebAclXssMatchStatement

    WebAclTextTransformation

    WebAclTextTransformationType

    WebAclVisibilityConfig

    WebAclXssMatchStatement

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.100.0 published on Wednesday, Mar 27, 2024 by Pulumi