Package software.amazon.awscdk.services.guardduty

Class CfnThreatEntitySet

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.guardduty.CfnThreatEntitySet
All Implemented Interfaces:
IInspectable, IThreatEntitySetRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-20T23:37:22.860Z") @Stability(Stable) public class CfnThreatEntitySet extends CfnResource implements IInspectable, IThreatEntitySetRef, ITaggableV2
The AWS::GuardDuty::ThreatEntitySet resource helps you create a list of known malicious IP addresses and domain names in your AWS environment.

Once you activate this list, GuardDuty will use the entries in this list as an additional source of threat detection and generate findings when there is an activity associated with these known malicious IP addresses and domain names. GuardDuty continues to monitor independently of this custom threat entity set.

Only the users of the GuardDuty administrator account can manage this list. These settings automatically apply to the member accounts.

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.*;
 CfnThreatEntitySet cfnThreatEntitySet = CfnThreatEntitySet.Builder.create(this, "MyCfnThreatEntitySet")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnThreatEntitySet

      protected CfnThreatEntitySet(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnThreatEntitySet

      protected CfnThreatEntitySet(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnThreatEntitySet

      @Stability(Stable) public CfnThreatEntitySet(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnThreatEntitySetProps props)
      Create a new AWS::GuardDuty::ThreatEntitySet.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      The timestamp when the threat entity set was created.

    • getAttrErrorDetails

      @Stability(Stable) @NotNull public String getAttrErrorDetails()
      The details associated with the Error status of your threat entity list.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      Returns the unique ID associated with the newly created threat entity set.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The status of your ThreatEntitySet .

      For information about valid status values, see Understanding list statuses in the Amazon GuardDuty User Guide .

    • getAttrUpdatedAt

      @Stability(Stable) @NotNull public String getAttrUpdatedAt()
      The timestamp when the threat entity set was updated.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getThreatEntitySetRef

      @Stability(Stable) @NotNull public ThreatEntitySetReference getThreatEntitySetRef()
      A reference to a ThreatEntitySet resource.
      Specified by:
      getThreatEntitySetRef in interface IThreatEntitySetRef

    • getFormat

      @Stability(Stable) @NotNull public String getFormat()
      The format of the file that contains the threat entity set.

    • setFormat

      @Stability(Stable) public void setFormat(@NotNull String value)
      The format of the file that contains the threat entity set.

    • getLocation

      @Stability(Stable) @NotNull public String getLocation()
      The URI of the file that contains the threat entity set.

    • setLocation

      @Stability(Stable) public void setLocation(@NotNull String value)
      The URI of the file that contains the threat entity set.

    • getActivate

      @Stability(Stable) @Nullable public Object getActivate()
      A boolean value that determines if GuardDuty can start using this list for custom threat detection.

      Returns union: either Boolean or IResolvable

    • setActivate

      @Stability(Stable) public void setActivate(@Nullable Boolean value)
      A boolean value that determines if GuardDuty can start using this list for custom threat detection.

    • setActivate

      @Stability(Stable) public void setActivate(@Nullable IResolvable value)
      A boolean value that determines if GuardDuty can start using this list for custom threat detection.

    • getDetectorId

      @Stability(Stable) @Nullable public String getDetectorId()
      The unique regional detector ID of the GuardDuty account for which you want to create a threat entity set.

    • setDetectorId

      @Stability(Stable) public void setDetectorId(@Nullable String value)
      The unique regional detector ID of the GuardDuty account for which you want to create a threat entity set.

    • getExpectedBucketOwner

      @Stability(Stable) @Nullable public String getExpectedBucketOwner()
      The AWS account ID that owns the Amazon S3 bucket specified in the Location field.

    • setExpectedBucketOwner

      @Stability(Stable) public void setExpectedBucketOwner(@Nullable String value)
      The AWS account ID that owns the Amazon S3 bucket specified in the Location field.

    • getName

      @Stability(Stable) @Nullable public String getName()
      The user-friendly name to identify the threat entity set.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The user-friendly name to identify the threat entity set.

    • getTags

      @Stability(Stable) @Nullable public List<CfnThreatEntitySet.TagItemProperty> getTags()
      The tags to be added to a new threat entity set resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnThreatEntitySet.TagItemProperty> value)
      The tags to be added to a new threat entity set resource.