Package software.amazon.awscdk.services.guardduty

Class CfnTrustedEntitySet.Builder

java.lang.Object

software.amazon.awscdk.services.guardduty.CfnTrustedEntitySet.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnTrustedEntitySet>

Enclosing class:

CfnTrustedEntitySet

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

A fluent builder for CfnTrustedEntitySet.

Method Summary

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

format

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

The format of the file that contains the trusted 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 trusted entity set. This parameter is required.

Returns:

this

See Also:

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

location

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

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

Parameters:

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

Returns:

this

See Also:

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

activate

@Stability(Stable)
public CfnTrustedEntitySet.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-trustedentityset.html#cfn-guardduty-trustedentityset-activate

activate

@Stability(Stable)
public CfnTrustedEntitySet.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-trustedentityset.html#cfn-guardduty-trustedentityset-activate

detectorId

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

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

Returns:

this

See Also:

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

expectedBucketOwner

@Stability(Stable)
public CfnTrustedEntitySet.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 value 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-trustedentityset.html#cfn-guardduty-trustedentityset-expectedbucketowner

name

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

A user-friendly name to identify the trusted entity set.

Valid characters include lowercase letters, uppercase letters, numbers, dash(-), and underscore (_).

Parameters:

name - A user-friendly name to identify the trusted entity set. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnTrustedEntitySet.Builder tags(List<? extends CfnTrustedEntitySet.TagItemProperty> tags)

The tags to be added to a new trusted 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 trusted entity set resource. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnTrustedEntitySet build()

Specified by:

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

Returns:

a newly built instance of CfnTrustedEntitySet.