Package software.amazon.awscdk.cfnpropertymixins.services.guardduty

Class CfnIPSetPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.guardduty.CfnIPSetPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnIPSetPropsMixin>

Enclosing class:

CfnIPSetPropsMixin

@Stability(Stable)
public static final class CfnIPSetPropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnIPSetPropsMixin>

A fluent builder for CfnIPSetPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnIPSetPropsMixin.Builder	activate(Boolean activate)	A boolean value that determines if GuardDuty can start using this list for custom threat detection.
CfnIPSetPropsMixin.Builder	activate(IResolvable activate)	A boolean value that determines if GuardDuty can start using this list for custom threat detection.
CfnIPSetPropsMixin	build()
static CfnIPSetPropsMixin.Builder	create()
static CfnIPSetPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnIPSetPropsMixin.Builder	detectorId(String detectorId)	The unique ID of the detector of the GuardDuty account for which you want to create an IPSet.
CfnIPSetPropsMixin.Builder	expectedBucketOwner(String expectedBucketOwner)	The AWS account ID that owns the Amazon S3 bucket specified in the Location field.
CfnIPSetPropsMixin.Builder	format(String format)	The format of the file that contains the IPSet.
CfnIPSetPropsMixin.Builder	location(String location)	The URI of the file that contains the IPSet.
CfnIPSetPropsMixin.Builder	name(String name)	The user-friendly name to identify the IPSet.
CfnIPSetPropsMixin.Builder	tags(List<? extends CfnTag> tags)	The tags to be added to a new threat entity set resource.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnIPSetPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnIPSetPropsMixin.Builder.

create

@Stability(Stable)
public static CfnIPSetPropsMixin.Builder create()

Returns:

a new instance of CfnIPSetPropsMixin.Builder.

activate

@Stability(Stable)
public CfnIPSetPropsMixin.Builder activate(Boolean activate)

A boolean value that determines if GuardDuty can start using this list for custom threat detection.

For GuardDuty to prevent generating findings based on an activity associated with these entries, this list must be active.

Parameters:

activate - A boolean value that determines if GuardDuty can start using this list for custom threat detection. This parameter is required.

Returns:

this

See Also:

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

activate

@Stability(Stable)
public CfnIPSetPropsMixin.Builder activate(IResolvable activate)

A boolean value that determines if GuardDuty can start using this list for custom threat detection.

For GuardDuty to prevent generating findings based on an activity associated with these entries, this list must be active.

Parameters:

activate - A boolean value that determines if GuardDuty can start using this list for custom threat detection. This parameter is required.

Returns:

this

See Also:

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

detectorId

@Stability(Stable)
public CfnIPSetPropsMixin.Builder detectorId(String detectorId)

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.

Parameters:

detectorId - The unique ID of the detector of the GuardDuty account for which you want to create an IPSet. This parameter is required.

Returns:

this

See Also:

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

expectedBucketOwner

@Stability(Stable)
public CfnIPSetPropsMixin.Builder expectedBucketOwner(String expectedBucketOwner)

The AWS account ID that owns the Amazon S3 bucket specified in the Location field.

When you provide this account ID, GuardDuty will validate that the S3 bucket belongs to this account. If you don't specify an account ID owner, GuardDuty doesn't perform any validation.

Parameters:

expectedBucketOwner - The AWS account ID that owns the Amazon S3 bucket specified in the Location field. This parameter is required.

Returns:

this

See Also:

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

format

@Stability(Stable)
public CfnIPSetPropsMixin.Builder format(String format)

The format of the file that contains the IPSet.

For information about supported formats, see List formats in the Amazon GuardDuty User Guide .

Parameters:

format - The format of the file that contains the IPSet. This parameter is required.

Returns:

this

See Also:

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

location

@Stability(Stable)
public CfnIPSetPropsMixin.Builder location(String location)

The URI of the file that contains the IPSet.

Parameters:

location - The URI of the file that contains the IPSet. This parameter is required.

Returns:

this

See Also:

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

name

@Stability(Stable)
public CfnIPSetPropsMixin.Builder name(String name)

The user-friendly name to identify the IPSet.

The name of your list must be unique within an AWS account and Region. Valid characters are alphanumeric, whitespace, dash (-), and underscores (_).

Parameters:

name - The user-friendly name to identify the IPSet. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnIPSetPropsMixin.Builder tags(List<? extends CfnTag> tags)

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 .

Parameters:

tags - The tags to be added to a new threat entity set resource. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnIPSetPropsMixin build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnIPSetPropsMixin>

Returns:

a newly built instance of CfnIPSetPropsMixin.