Package software.amazon.awscdk.services.guardduty

Interface CfnIPSetProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnIPSetProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-12-06T14:43:20.002Z")
@Stability(Stable)
public interface CfnIPSetProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnIPSet.

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

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnIPSetProps.Builder	builder()
default Object	getActivate()	Indicates whether or not GuardDuty uses the IPSet .
default String	getDetectorId()	The unique ID of the detector of the GuardDuty account for which you want to create an IPSet.
String	getFormat()	The format of the file that contains the IPSet.
String	getLocation()	The URI of the file that contains the IPSet.
default String	getName()	The user-friendly name to identify the IPSet.
default List<CfnTag>	getTags()	The tags to be added to a new IP 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 IPSet.

See Also:

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

getLocation

@Stability(Stable)
@NotNull
String getLocation()

The URI of the file that contains the IPSet.

See Also:

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

getActivate

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

Indicates whether or not GuardDuty uses the IPSet .

See Also:

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

getDetectorId

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

The unique ID of the detector of the GuardDuty account for which you want to create an IPSet.

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-ipset.html#cfn-guardduty-ipset-detectorid

getName

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

The user-friendly name to identify the IPSet.

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

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> 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 .

See Also:

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

builder

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

Returns:

a CfnIPSetProps.Builder of CfnIPSetProps