AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::GuardDuty::IPSet

CfnIPSet

The `AWS::GuardDuty::IPSet` resource helps you create a list of trusted IP addresses that you can use for secure communication with AWS infrastructure and applications. Once you activate this list, GuardDuty will not generate findings when there is an activity associated with these safe IP addresses. Only the users of the GuardDuty administrator account can manage this list. These settings are also applied to the member accounts.

Import

import { CfnIPSet } from 'aws-cdk-lib/aws-guardduty';

Or use the module namespace:

import * as guardduty from 'aws-cdk-lib/aws-guardduty';
// guardduty.CfnIPSet

Properties

Configuration passed to the constructor as CfnIPSetProps.

formatRequired
string

The format of the file that contains the IPSet. For information about supported formats, see [List formats](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_upload-lists.html#prepare_list) in the *Amazon GuardDuty User Guide* .

locationRequired
string

The URI of the file that contains the IPSet.

activateOptional
boolean | IResolvable

A boolean value that determines if GuardDuty can start using this list for custom threat detection. For GuardDuty to prevent generating findings based on an activity associated with these entries, this list must be active.

detectorIdOptional
string

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 [ListDetectors](https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html) API.

expectedBucketOwnerOptional
string

The AWS account ID that owns the Amazon S3 bucket specified in the *Location* field. When you provide this account ID, GuardDuty will validate that the S3 bucket belongs to this account. If you don't specify an account ID owner, GuardDuty doesn't perform any validation.

nameOptional
string

The user-friendly name to identify the IPSet. The name of your list must be unique within an AWS account and Region. Valid characters are alphanumeric, whitespace, dash (-), and underscores (_).

tagsOptional
CfnTag[]

The tags to be added to a new threat entity set resource. Each tag consists of a key and an optional value, both of which you define. For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::GuardDuty::IPSetView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-guardduty
CFN TypeAWS::GuardDuty::IPSet
Properties7

Related Constructs

Explore This Service

External Links