[ aws . wafv2 ]

list-resources-for-web-acl

Description

Note

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

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

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  list-resources-for-web-acl
--web-acl-arn <value>
[--resource-type <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--web-acl-arn (string)

The Amazon Resource Name (ARN) of the Web ACL.

--resource-type (string)

Used for web ACLs that are scoped for regional applications. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.

Possible values:

  • APPLICATION_LOAD_BALANCER

  • API_GATEWAY

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To retrieve the resources associated with a web ACL

The following list-resources-for-web-acl retrieves all resources that are currently associated with the specified web ACL in the region us-west-2.

aws wafv2 list-resources-for-web-acl \
    --web-acl-arn arn:aws:wafv2:us-west-2:123456789012:regional/webacl/TestWebAcl/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \
    --region us-west-2

Output:

{
    "ResourceArns":[
        "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/waf-cli-alb/1ea17125f8b25a2a"
    ]
}

For more information, see Associating or Disassociating a Web ACL with an AWS Resource in the AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide.

Output

ResourceArns -> (list)

The array of Amazon Resource Names (ARNs) of the associated resources.

(string)