Show / Hide Table of Contents

Class CfnTrustedEntitySetProps

Properties for defining a CfnTrustedEntitySet.

Inheritance
object
CfnTrustedEntitySetProps
Implements
ICfnTrustedEntitySetProps
Inherited Members
object.GetType()
object.MemberwiseClone()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: Amazon.CDK.AWS.GuardDuty
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnTrustedEntitySetProps : ICfnTrustedEntitySetProps
Syntax (vb)
Public Class CfnTrustedEntitySetProps Implements ICfnTrustedEntitySetProps
Remarks

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

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.GuardDuty;

             var cfnTrustedEntitySetProps = new CfnTrustedEntitySetProps {
                 Format = "format",
                 Location = "location",

                 // the properties below are optional
                 Activate = false,
                 DetectorId = "detectorId",
                 ExpectedBucketOwner = "expectedBucketOwner",
                 Name = "name",
                 Tags = new [] { new TagItemProperty {
                     Key = "key",
                     Value = "value"
                 } }
             };

Synopsis

Constructors

CfnTrustedEntitySetProps()

Properties for defining a CfnTrustedEntitySet.

Properties

Activate

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

DetectorId

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

ExpectedBucketOwner

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

Format

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

Location

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

Name

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

Tags

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

Constructors

CfnTrustedEntitySetProps()

Properties for defining a CfnTrustedEntitySet.

public CfnTrustedEntitySetProps()
Remarks

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

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.GuardDuty;

             var cfnTrustedEntitySetProps = new CfnTrustedEntitySetProps {
                 Format = "format",
                 Location = "location",

                 // the properties below are optional
                 Activate = false,
                 DetectorId = "detectorId",
                 ExpectedBucketOwner = "expectedBucketOwner",
                 Name = "name",
                 Tags = new [] { new TagItemProperty {
                     Key = "key",
                     Value = "value"
                 } }
             };

Properties

Activate

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

public object? Activate { get; set; }
Property Value

object

Remarks

For GuardDuty to prevent generating findings based on an activity associated with these entries, this list must be active.

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

Type union: either bool or IResolvable

DetectorId

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

public string? DetectorId { get; set; }
Property Value

string

Remarks

To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

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

ExpectedBucketOwner

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

public string? ExpectedBucketOwner { get; set; }
Property Value

string

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-trustedentityset.html#cfn-guardduty-trustedentityset-expectedbucketowner

Format

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

public string Format { get; set; }
Property Value

string

Remarks

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

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

Location

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

public string Location { get; set; }
Property Value

string

Remarks

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

Name

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

public string? Name { get; set; }
Property Value

string

Remarks

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

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

Tags

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

public CfnTrustedEntitySet.ITagItemProperty[]? Tags { get; set; }
Property Value

ITagItemProperty[]

Remarks

Each tag consists of a key and an optional value, both of which you define.

For more information, see Tag .

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

Implements

ICfnTrustedEntitySetProps
Back to top Generated by DocFX