class CfnTrustedEntitySet (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.GuardDuty.CfnTrustedEntitySet`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsguardduty#CfnTrustedEntitySet`
Java	`software.amazon.awscdk.services.guardduty.CfnTrustedEntitySet`
Python	`aws_cdk.aws_guardduty.CfnTrustedEntitySet`
TypeScript	`aws-cdk-lib` » `aws_guardduty` » `CfnTrustedEntitySet`

Implements IConstruct, IDependable, IInspectable, ITaggableV2

The AWS::GuardDuty::TrustedEntitySet resource helps you create a list of IP addresses and domain names that you can use for secure communication with your AWS infrastructure and applications.

Once you activate this list, GuardDuty will not generate findings when there is an activity associated with these safe IP addresses and domain names. At any given time, you can have only one trusted entity set.

Only the users of the GuardDuty administrator account can manage the entity sets. These settings automatically apply member accounts.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_guardduty as guardduty } from 'aws-cdk-lib';
const cfnTrustedEntitySet = new guardduty.CfnTrustedEntitySet(this, 'MyCfnTrustedEntitySet', {
  format: 'format',
  location: 'location',

  // the properties below are optional
  activate: false,
  detectorId: 'detectorId',
  expectedBucketOwner: 'expectedBucketOwner',
  name: 'name',
  tags: [{
    key: 'key',
    value: 'value',
  }],
});

Initializer

new CfnTrustedEntitySet(scope: Construct, id: string, props: CfnTrustedEntitySetProps)

Parameters

scope Construct — Scope in which this resource is defined.
id string — Construct identifier for this resource (unique in its scope).
props CfnTrustedEntitySetProps — Resource properties.

Construct Props

Name	Type	Description
format	`string`	The format of the file that contains the trusted entity set.
location	`string`	The URI of the file that contains the trusted entity set.
activate?	`boolean \|` `IResolvable`	A boolean value that determines if GuardDuty can start using this list for custom threat detection.
detectorId?	`string`	The unique regional detector ID of the GuardDuty account for which you want to create a trusted entity set.
expectedBucketOwner?	`string`	The AWS account ID that owns the Amazon S3 bucket specified in the Location field.
name?	`string`	A user-friendly name to identify the trusted entity set.
tags?	`TagItemProperty[]`	The tags to be added to a new trusted entity set resource.

format

Type: string

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 .

location

Type: string

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

activate?

Type: boolean | IResolvable (optional)

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.

detectorId?

Type: string (optional)

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.

expectedBucketOwner?

Type: string (optional)

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.

name?

Type: string (optional)

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

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

tags?

Type: TagItemProperty[] (optional)

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 .

Properties

Name	Type	Description
attrCreatedAt	`string`	The timestamp when the trusted entity set was created.
attrErrorDetails	`string`	Specifies the error details when the status of the trusted entity set shows as Error .
attrId	`string`
attrStatus	`string`	The status of your `TrustedEntitySet` .
attrUpdatedAt	`string`	The timestamp when the trusted entity set was updated.
cdkTagManager	`TagManager`	Tag Manager which manages the tags for this resource.
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnResourceType	`string`	AWS resource type.
creationStack	`string[]`
format	`string`	The format of the file that contains the trusted entity set.
location	`string`	The URI of the file that contains the trusted entity set.
logicalId	`string`	The logical ID for this CloudFormation stack element.
node	`Node`	The tree node.
ref	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
stack	`Stack`	The stack in which this element is defined.
activate?	`boolean \|` `IResolvable`	A boolean value that determines if GuardDuty can start using this list for custom threat detection.
detectorId?	`string`	The unique regional detector ID of the GuardDuty account for which you want to create a trusted entity set.
expectedBucketOwner?	`string`	The AWS account ID that owns the Amazon S3 bucket specified in the Location field.
name?	`string`	A user-friendly name to identify the trusted entity set.
tags?	`TagItemProperty[]`	The tags to be added to a new trusted entity set resource.
static CFN_RESOURCE_TYPE_NAME	`string`	The CloudFormation resource type name for this resource class.

attrCreatedAt

Type: string

The timestamp when the trusted entity set was created.

attrErrorDetails

Type: string

Specifies the error details when the status of the trusted entity set shows as Error .

attrId

Type: string

attrStatus

Type: string

The status of your TrustedEntitySet .

For information about valid status values, see Understanding list statuses in the Amazon GuardDuty User Guide .

attrUpdatedAt

Type: string

The timestamp when the trusted entity set was updated.

cdkTagManager

Type: TagManager

Tag Manager which manages the tags for this resource.

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

creationStack

Type: string[]

format

Type: string

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

location

Type: string

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

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

node

Type: Node

The tree node.

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

activate?

Type: boolean | IResolvable (optional)

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

detectorId?

Type: string (optional)

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

expectedBucketOwner?

Type: string (optional)

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

name?

Type: string (optional)

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

tags?

Type: TagItemProperty[] (optional)

The tags to be added to a new trusted entity set resource.

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for `addOverride(path, undefined)`.
addDependency(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
obtainDependencies()	Retrieves an array of resources this resource depends on.
obtainResourceDependencies()	Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)	Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)	Replaces one dependency with another.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependency(target)

public addDependency(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

key string
value any

Add a value to the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

path string — - The path of the property, you can use dot notation to override values in complex types.
value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

propertyPath string — The path of the property.
value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

policy RemovalPolicy
options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

attributeName string — The name of the attribute.
typeHint ResolutionTypeHint

Returns

Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

getMetadata(key)

public getMetadata(key: string): any

Parameters

key string

Returns

any

Retrieve a value value from the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

inspector TreeInspector — tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

obtainDependencies()

public obtainDependencies(): Stack &#124; CfnResource[]

Returns

Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

target CfnResource — The dependency to replace.
newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

props { [string]: any }

Returns

{ [string]: any }