Package software.amazon.awscdk.services.guardduty

Interface CfnThreatEntitySetProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnThreatEntitySetProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.125.0 (build fdbe357)",
           date="2026-02-02T11:31:29.982Z")
@Stability(Stable)
public interface CfnThreatEntitySetProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.guardduty.*;
 CfnThreatEntitySetProps cfnThreatEntitySetProps = CfnThreatEntitySetProps.builder()
         .format("format")
         .location("location")
         // the properties below are optional
         .activate(false)
         .detectorId("detectorId")
         .expectedBucketOwner("expectedBucketOwner")
         .name("name")
         .tags(List.of(TagItemProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-threatentityset.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnThreatEntitySetProps.Builder	A builder for CfnThreatEntitySetProps
static final class	CfnThreatEntitySetProps.Jsii$Proxy	An implementation for CfnThreatEntitySetProps

Method Summary

Modifier and Type	Method	Description
static CfnThreatEntitySetProps.Builder	builder()
default Object	getActivate()	A boolean value that determines if GuardDuty can start using this list for custom threat detection.
default String	getDetectorId()	The unique regional detector ID of the GuardDuty account for which you want to create a threat entity set.
default String	getExpectedBucketOwner()	The AWS account ID that owns the Amazon S3 bucket specified in the Location field.
String	getFormat()	The format of the file that contains the threat entity set.
String	getLocation()	The URI of the file that contains the threat entity set.
default String	getName()	The user-friendly name to identify the threat entity set.
default List<CfnThreatEntitySet.TagItemProperty>	getTags()	The tags to be added to a new threat entity set resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFormat

@Stability(Stable)
@NotNull
String getFormat()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-threatentityset.html#cfn-guardduty-threatentityset-format

getLocation

@Stability(Stable)
@NotNull
String getLocation()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-threatentityset.html#cfn-guardduty-threatentityset-location

getActivate

@Stability(Stable)
@Nullable
default Object getActivate()

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.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-threatentityset.html#cfn-guardduty-threatentityset-activate

getDetectorId

@Stability(Stable)
@Nullable
default String getDetectorId()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-threatentityset.html#cfn-guardduty-threatentityset-detectorid

getExpectedBucketOwner

@Stability(Stable)
@Nullable
default String getExpectedBucketOwner()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-threatentityset.html#cfn-guardduty-threatentityset-expectedbucketowner

getName

@Stability(Stable)
@Nullable
default String getName()

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-threatentityset.html#cfn-guardduty-threatentityset-name

getTags

@Stability(Stable)
@Nullable
default List<CfnThreatEntitySet.TagItemProperty> getTags()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-threatentityset.html#cfn-guardduty-threatentityset-tags

builder

@Stability(Stable)
static CfnThreatEntitySetProps.Builder builder()

Returns:

a CfnThreatEntitySetProps.Builder of CfnThreatEntitySetProps