interface CfnIPSetProps

Language	Type name
.NET	`Amazon.CDK.AWS.GuardDuty.CfnIPSetProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsguardduty#CfnIPSetProps`
Java	`software.amazon.awscdk.services.guardduty.CfnIPSetProps`
Python	`aws_cdk.aws_guardduty.CfnIPSetProps`
TypeScript	`aws-cdk-lib` » `aws_guardduty` » `CfnIPSetProps`

Properties for defining a CfnIPSet.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_guardduty as guardduty } from 'aws-cdk-lib';
const cfnIPSetProps: guardduty.CfnIPSetProps = {
  format: 'format',
  location: 'location',

  // the properties below are optional
  activate: false,
  detectorId: 'detectorId',
  expectedBucketOwner: 'expectedBucketOwner',
  name: 'name',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
format	`string`	The format of the file that contains the IPSet.
location	`string`	The URI of the file that contains the IPSet.
activate?	`boolean \|` `IResolvable`	A boolean value that determines if GuardDuty can start using this list for custom threat detection.
detectorId?	`string`	The unique ID of the detector of the GuardDuty account for which you want to create an IPSet.
expectedBucketOwner?	`string`	The AWS account ID that owns the Amazon S3 bucket specified in the Location field.
name?	`string`	The user-friendly name to identify the IPSet.
tags?	`CfnTag[]`	The tags to be added to a new threat entity set resource.

format

Type: string

The format of the file that contains the IPSet.

For information about supported formats, see List formats in the Amazon GuardDuty User Guide .

location

Type: string

The URI of the file that contains the IPSet.

activate?

Type: boolean | IResolvable (optional)

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.

detectorId?

Type: string (optional)

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 API.

expectedBucketOwner?

Type: string (optional)

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.

name?

Type: string (optional)

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 (_).

tags?

Type: CfnTag[] (optional)

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 .