Package software.amazon.awscdk.services.guardduty

Interface CfnTrustedEntitySetProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTrustedEntitySetProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-09-02T11:25:32.706Z")
@Stability(Stable)
public interface CfnTrustedEntitySetProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnTrustedEntitySet.

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

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTrustedEntitySetProps.Builder	builder()
default Object	getActivate()	A boolean value that determines if GuardDuty can start using this list for custom threat detection.
default String	getDetectorId()	The unique regional detector ID of the GuardDuty account for which you want to create a trusted entity set.
default String	getExpectedBucketOwner()	The AWS account ID that owns the Amazon S3 bucket specified in the Location field.
String	getFormat()	The format of the file that contains the trusted entity set.
String	getLocation()	The URI of the file that contains the trusted entity set.
default String	getName()	A user-friendly name to identify the trusted entity set.
default List<CfnTrustedEntitySet.TagItemProperty>	getTags()	The tags to be added to a new trusted entity 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 trusted entity set.

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

See Also:

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

getLocation

@Stability(Stable)
@NotNull
String getLocation()

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

See Also:

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

getActivate

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

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.

See Also:

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

getDetectorId

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

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.

See Also:

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

getExpectedBucketOwner

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

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.

See Also:

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

getName

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

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

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

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTrustedEntitySet.TagItemProperty> getTags()

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 .

See Also:

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

builder

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

Returns:

a CfnTrustedEntitySetProps.Builder of CfnTrustedEntitySetProps