interface CfnThreatEntitySetProps

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

Properties for defining a CfnThreatEntitySet.

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 cfnThreatEntitySetProps: guardduty.CfnThreatEntitySetProps = {
  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 threat entity set.
location	`string`	The URI of the file that contains the threat entity set.
activate?	`boolean \|` `IResolvable`	A boolean value that determines if GuardDuty can start using this list for custom threat detection.
detectorId?	`string`	The unique regional detector ID of the GuardDuty account for which you want to create a threat entity set.
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 threat entity set.
tags?	`TagItemProperty[]`	The tags to be added to a new threat entity set resource.

format

Type: string

The format of the file that contains the threat entity set.

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 threat entity set.

activate?

Type: boolean | IResolvable (optional)

A boolean value that determines if GuardDuty can start using this list for custom threat detection.

For GuardDuty to consider the entries in this list and generate findings based on associated activity, this list must be active.

detectorId?

Type: string (optional)

The unique regional detector ID of the GuardDuty account for which you want to create a threat entity set.

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.

Whether or not you provide the account ID for this optional field, GuardDuty validates that the account ID associated with the DetectorId owns the S3 bucket in the Location field. If GuardDuty finds that this S3 bucket doesn't belong to the specified account ID, you will get an error at the time of activating this list.

name?

Type: string (optional)

The user-friendly name to identify the threat entity set.

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

tags?

Type: TagItemProperty[] (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 .