Package software.amazon.awscdk.services.guardduty

Class CfnThreatEntitySet.Builder

java.lang.Object

software.amazon.awscdk.services.guardduty.CfnThreatEntitySet.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnThreatEntitySet>

Enclosing class:

CfnThreatEntitySet

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

A fluent builder for CfnThreatEntitySet.

Method Summary

Modifier and Type	Method	Description
CfnThreatEntitySet.Builder	activate(Boolean activate)	A boolean value that determines if GuardDuty can start using this list for custom threat detection.
CfnThreatEntitySet.Builder	activate(IResolvable activate)	A boolean value that determines if GuardDuty can start using this list for custom threat detection.
CfnThreatEntitySet	build()
static CfnThreatEntitySet.Builder	create(software.constructs.Construct scope, String id)
CfnThreatEntitySet.Builder	detectorId(String detectorId)	The unique regional detector ID of the GuardDuty account for which you want to create a threat entity set.
CfnThreatEntitySet.Builder	expectedBucketOwner(String expectedBucketOwner)	The AWS account ID that owns the Amazon S3 bucket specified in the Location field.
CfnThreatEntitySet.Builder	format(String format)	The format of the file that contains the threat entity set.
CfnThreatEntitySet.Builder	location(String location)	The URI of the file that contains the threat entity set.
CfnThreatEntitySet.Builder	name(String name)	The user-friendly name to identify the threat entity set.
CfnThreatEntitySet.Builder	tags(List<? extends CfnThreatEntitySet.TagItemProperty> 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 CfnThreatEntitySet.Builder create(software.constructs.Construct scope,
 String id)

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.

Returns:

a new instance of CfnThreatEntitySet.Builder.

format

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

The format of the file that contains the threat entity set.

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

Parameters:

format - The format of the file that contains the threat entity set. This parameter is required.

Returns:

this

See Also:

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

location

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

The URI of the file that contains the threat entity set.

Parameters:

location - The URI of the file that contains the threat entity set. This parameter is required.

Returns:

this

See Also:

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

activate

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

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

For GuardDuty to consider the entries in this list and generate findings based on associated activity, 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-threatentityset.html#cfn-guardduty-threatentityset-activate

activate

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

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

For GuardDuty to consider the entries in this list and generate findings based on associated activity, 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-threatentityset.html#cfn-guardduty-threatentityset-activate

detectorId

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

The unique regional detector ID of the GuardDuty account for which you want to create a threat entity set.

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 regional detector ID of the GuardDuty account for which you want to create a threat entity set. This parameter is required.

Returns:

this

See Also:

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

expectedBucketOwner

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

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

Whether or not you provide the account ID for this optional field, GuardDuty validates that the account ID associated with the DetectorId owns the S3 bucket in the Location field. If GuardDuty finds that this S3 bucket doesn't belong to the specified account ID, you will get an error at the time of activating this list.

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-threatentityset.html#cfn-guardduty-threatentityset-expectedbucketowner

name

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

The user-friendly name to identify the threat entity set.

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

Parameters:

name - The user-friendly name to identify the threat entity set. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnThreatEntitySet.Builder tags(List<? extends CfnThreatEntitySet.TagItemProperty> 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-threatentityset.html#cfn-guardduty-threatentityset-tags

build

@Stability(Stable)
public CfnThreatEntitySet build()

Specified by:

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

Returns:

a newly built instance of CfnThreatEntitySet.