Skip to content

Create Ip Set

guardduty_create_ip_set R Documentation

Creates a new IPSet, which is called a trusted IP list in the console user interface

Description

Creates a new IPSet, which is called a trusted IP list in the console user interface. An IPSet is a list of IP addresses that are trusted for secure communication with Amazon Web Services infrastructure and applications. GuardDuty doesn't generate findings for IP addresses that are included in IPSets. Only users from the administrator account can use this operation.

Usage

guardduty_create_ip_set(DetectorId, Name, Format, Location, Activate,
  ClientToken, Tags)

Arguments

DetectorId

[required] The unique ID of the detector of the GuardDuty account for which you want to create an IPSet.

To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the list_detectors API.

Name

[required] The user-friendly name to identify the IPSet.

Allowed characters are alphanumeric, whitespace, dash (-), and underscores (_).

Format

[required] The format of the file that contains the IPSet.

Location

[required] The URI of the file that contains the IPSet.

Activate

[required] A Boolean value that indicates whether GuardDuty is to start using the uploaded IPSet.

ClientToken

The idempotency token for the create request.

Tags

The tags to be added to a new IP set resource.

Value

A list with the following syntax: 

list(
  IpSetId = "string"
)

Request syntax

svc$create_ip_set(
  DetectorId = "string",
  Name = "string",
  Format = "TXT"|"STIX"|"OTX_CSV"|"ALIEN_VAULT"|"PROOF_POINT"|"FIRE_EYE",
  Location = "string",
  Activate = TRUE|FALSE,
  ClientToken = "string",
  Tags = list(
    "string"
  )
)