CfnThreatEntitySetProps

class aws_cdk.aws_guardduty.CfnThreatEntitySetProps(*, format, location, activate=None, detector_id=None, expected_bucket_owner=None, name=None, tags=None)

Bases: object

Properties for defining a CfnThreatEntitySet.

Parameters:

format (str) – 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 .
location (str) – The URI of the file that contains the threat entity set.
activate (Union[bool, IResolvable, None]) – 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.
detector_id (Optional[str]) – 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.
expected_bucket_owner (Optional[str]) – 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.
name (Optional[str]) – The user-friendly name to identify the threat entity set. Valid characters are alphanumeric, whitespace, dash (-), and underscores (_).
tags (Optional[Sequence[Union[TagItemProperty, Dict[str, Any]]]]) – 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 .

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_guardduty as guardduty

cfn_threat_entity_set_props = guardduty.CfnThreatEntitySetProps(
    format="format",
    location="location",

    # the properties below are optional
    activate=False,
    detector_id="detectorId",
    expected_bucket_owner="expectedBucketOwner",
    name="name",
    tags=[guardduty.CfnThreatEntitySet.TagItemProperty(
        key="key",
        value="value"
    )]
)

Attributes

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.

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

detector_id

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.

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

expected_bucket_owner

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.