Skip to content

Get Ip Set

wafv2_get_ip_set R Documentation

Retrieves the specified IPSet

Description

Retrieves the specified IPSet.

Usage

wafv2_get_ip_set(Name, Scope, Id)

Arguments

Name

[required] The name of the IP set. You cannot change the name of an IPSet after you create it.

Scope

[required] Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution.

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.

Id

[required] 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.

Value

A list with the following syntax: 

list(
  IPSet = list(
    Name = "string",
    Id = "string",
    ARN = "string",
    Description = "string",
    IPAddressVersion = "IPV4"|"IPV6",
    Addresses = list(
      "string"
    )
  ),
  LockToken = "string"
)

Request syntax

svc$get_ip_set(
  Name = "string",
  Scope = "CLOUDFRONT"|"REGIONAL",
  Id = "string"
)