Package software.amazon.awscdk.services.guardduty

Class CfnIPSet

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.guardduty.CfnIPSet
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:57.169Z") @Stability(Stable) public class CfnIPSet extends CfnResource implements IInspectable
A CloudFormation AWS::GuardDuty::IPSet.

The AWS::GuardDuty::IPSet resource specifies a new IPSet . An IPSet is a list of trusted IP addresses from which secure communication is allowed with AWS infrastructure and applications.

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")
         .activate(false)
         .detectorId("detectorId")
         .format("format")
         .location("location")
         // the properties below are optional
         .name("name")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • 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 Construct scope, @NotNull String id, @NotNull CfnIPSetProps props)
      Create a new AWS::GuardDuty::IPSet.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      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.

    • getCfnProperties

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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      The tags to be added to a new IP set resource.

      Each tag consists of a key and an optional value, both of which you define.

      For more information, see Tag .

    • getActivate

      @Stability(Stable) @NotNull public Object getActivate()
      Indicates whether or not GuardDuty uses the IPSet .

    • setActivate

      @Stability(Stable) public void setActivate(@NotNull Boolean value)
      Indicates whether or not GuardDuty uses the IPSet .

    • setActivate

      @Stability(Stable) public void setActivate(@NotNull IResolvable value)
      Indicates whether or not GuardDuty uses the IPSet .

    • getDetectorId

      @Stability(Stable) @NotNull public String getDetectorId()
      The unique ID of the detector of the GuardDuty account that you want to create an IPSet for.

    • setDetectorId

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

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

    • getName

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

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

    • setName

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

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