Package software.amazon.awscdk.services.guardduty

Class CfnIPSet

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.CfnIPSet
All Implemented Interfaces:
IInspectable, ITaggable, IIPSetRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:41.049Z") @Stability(Stable) public class CfnIPSet extends CfnResource implements IInspectable, IIPSetRef, ITaggable
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.

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.*;
 CfnIPSet cfnIPSet = CfnIPSet.Builder.create(this, "MyCfnIPSet")
         .format("format")
         .location("location")
         // the properties below are optional
         .activate(false)
         .detectorId("detectorId")
         .expectedBucketOwner("expectedBucketOwner")
         .name("name")
         .tags(List.of(CfnTag.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

    • CfnIPSet

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

    • CfnIPSet

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

    • CfnIPSet

      @Stability(Stable) public CfnIPSet(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnIPSetProps props)
      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.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()

    • getCfnProperties

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

    • getIpSetRef

      @Stability(Stable) @NotNull public IPSetReference getIpSetRef()
      A reference to a IPSet resource.
      Specified by:
      getIpSetRef in interface IIPSetRef

    • getTags

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

    • getFormat

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

    • setFormat

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

    • getLocation

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

    • setLocation

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

    • 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 ID of the detector of the GuardDuty account for which you want to create an IPSet.

    • setDetectorId

      @Stability(Stable) public void setDetectorId(@Nullable String value)
      The unique ID of the detector of the GuardDuty account for which you want to create an IPSet.

    • 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 IPSet.

    • setName

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

    • getTagsRaw

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

    • setTagsRaw

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