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

Class CfnThreatEntitySetPropsMixin.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnThreatEntitySetPropsMixin>

Enclosing class:

CfnThreatEntitySetPropsMixin

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

A fluent builder for CfnThreatEntitySetPropsMixin.

Method Summary

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

Parameters:

options - Mixin options.

Returns:

a new instance of CfnThreatEntitySetPropsMixin.Builder.

create

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

Returns:

a new instance of CfnThreatEntitySetPropsMixin.Builder.

activate

@Stability(Stable)
public CfnThreatEntitySetPropsMixin.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 CfnThreatEntitySetPropsMixin.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 CfnThreatEntitySetPropsMixin.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 CfnThreatEntitySetPropsMixin.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

format

@Stability(Stable)
public CfnThreatEntitySetPropsMixin.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 CfnThreatEntitySetPropsMixin.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

name

@Stability(Stable)
public CfnThreatEntitySetPropsMixin.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 CfnThreatEntitySetPropsMixin.Builder tags(List<? extends CfnThreatEntitySetPropsMixin.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 CfnThreatEntitySetPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnThreatEntitySetPropsMixin.