We recommend new projects start with resources from the AWS provider.
aws-native.guardduty.ThreatEntitySet
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
Resource Type definition for AWS::GuardDuty::ThreatEntitySet
Create ThreatEntitySet Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ThreatEntitySet(name: string, args: ThreatEntitySetArgs, opts?: CustomResourceOptions);
@overload
def ThreatEntitySet(resource_name: str,
args: ThreatEntitySetArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ThreatEntitySet(resource_name: str,
opts: Optional[ResourceOptions] = None,
format: Optional[str] = None,
location: Optional[str] = None,
activate: Optional[bool] = None,
detector_id: Optional[str] = None,
expected_bucket_owner: Optional[str] = None,
name: Optional[str] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
func NewThreatEntitySet(ctx *Context, name string, args ThreatEntitySetArgs, opts ...ResourceOption) (*ThreatEntitySet, error)
public ThreatEntitySet(string name, ThreatEntitySetArgs args, CustomResourceOptions? opts = null)
public ThreatEntitySet(String name, ThreatEntitySetArgs args)
public ThreatEntitySet(String name, ThreatEntitySetArgs args, CustomResourceOptions options)
type: aws-native:guardduty:ThreatEntitySet
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args ThreatEntitySetArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ThreatEntitySetArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ThreatEntitySetArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ThreatEntitySetArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ThreatEntitySetArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
ThreatEntitySet Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The ThreatEntitySet resource accepts the following input properties:
- Format string
- 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 string
- The URI of the file that contains the threat entity set.
- Activate bool
- 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 string 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 stringOwner 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 theLocation
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 string
- The user-friendly name to identify the threat entity set. Valid characters are alphanumeric, whitespace, dash (-), and underscores (_).
- List<Pulumi.
Aws Native. Inputs. Tag> 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 .
- Format string
- 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 string
- The URI of the file that contains the threat entity set.
- Activate bool
- 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 string 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 stringOwner 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 theLocation
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 string
- The user-friendly name to identify the threat entity set. Valid characters are alphanumeric, whitespace, dash (-), and underscores (_).
- Tag
Args 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 .
- format String
- 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 String
- The URI of the file that contains the threat entity set.
- activate Boolean
- 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 String 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 StringOwner 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 theLocation
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 String
- The user-friendly name to identify the threat entity set. Valid characters are alphanumeric, whitespace, dash (-), and underscores (_).
- List<Tag>
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 .
- format string
- 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 string
- The URI of the file that contains the threat entity set.
- activate boolean
- 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 string 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 stringOwner 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 theLocation
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 string
- The user-friendly name to identify the threat entity set. Valid characters are alphanumeric, whitespace, dash (-), and underscores (_).
- Tag[]
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 .
- 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 bool
- 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 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_ strowner 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 theLocation
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 str
- The user-friendly name to identify the threat entity set. Valid characters are alphanumeric, whitespace, dash (-), and underscores (_).
- Sequence[Tag
Args] 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 .
- format String
- 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 String
- The URI of the file that contains the threat entity set.
- activate Boolean
- 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 String 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 StringOwner 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 theLocation
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 String
- The user-friendly name to identify the threat entity set. Valid characters are alphanumeric, whitespace, dash (-), and underscores (_).
- List<Property Map>
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 .
Outputs
All input properties are implicitly available as output properties. Additionally, the ThreatEntitySet resource produces the following output properties:
- Aws
Id string - Returns the unique ID associated with the newly created threat entity set.
- Created
At string - The timestamp when the threat entity set was created.
- Error
Details string - The details associated with the Error status of your threat entity list.
- Id string
- The provider-assigned unique ID for this managed resource.
- Status
Pulumi.
Aws Native. Guard Duty. Threat Entity Set Status - The status of your
ThreatEntitySet
. For information about valid status values, see Understanding list statuses in the Amazon GuardDuty User Guide . - Updated
At string - The timestamp when the threat entity set was updated.
- Aws
Id string - Returns the unique ID associated with the newly created threat entity set.
- Created
At string - The timestamp when the threat entity set was created.
- Error
Details string - The details associated with the Error status of your threat entity list.
- Id string
- The provider-assigned unique ID for this managed resource.
- Status
Threat
Entity Set Status - The status of your
ThreatEntitySet
. For information about valid status values, see Understanding list statuses in the Amazon GuardDuty User Guide . - Updated
At string - The timestamp when the threat entity set was updated.
- aws
Id String - Returns the unique ID associated with the newly created threat entity set.
- created
At String - The timestamp when the threat entity set was created.
- error
Details String - The details associated with the Error status of your threat entity list.
- id String
- The provider-assigned unique ID for this managed resource.
- status
Threat
Entity Set Status - The status of your
ThreatEntitySet
. For information about valid status values, see Understanding list statuses in the Amazon GuardDuty User Guide . - updated
At String - The timestamp when the threat entity set was updated.
- aws
Id string - Returns the unique ID associated with the newly created threat entity set.
- created
At string - The timestamp when the threat entity set was created.
- error
Details string - The details associated with the Error status of your threat entity list.
- id string
- The provider-assigned unique ID for this managed resource.
- status
Threat
Entity Set Status - The status of your
ThreatEntitySet
. For information about valid status values, see Understanding list statuses in the Amazon GuardDuty User Guide . - updated
At string - The timestamp when the threat entity set was updated.
- aws_
id str - Returns the unique ID associated with the newly created threat entity set.
- created_
at str - The timestamp when the threat entity set was created.
- error_
details str - The details associated with the Error status of your threat entity list.
- id str
- The provider-assigned unique ID for this managed resource.
- status
Threat
Entity Set Status - The status of your
ThreatEntitySet
. For information about valid status values, see Understanding list statuses in the Amazon GuardDuty User Guide . - updated_
at str - The timestamp when the threat entity set was updated.
- aws
Id String - Returns the unique ID associated with the newly created threat entity set.
- created
At String - The timestamp when the threat entity set was created.
- error
Details String - The details associated with the Error status of your threat entity list.
- id String
- The provider-assigned unique ID for this managed resource.
- status "INACTIVE" | "ACTIVATING" | "ACTIVE" | "DEACTIVATING" | "ERROR" | "DELETE_PENDING" | "DELETED"
- The status of your
ThreatEntitySet
. For information about valid status values, see Understanding list statuses in the Amazon GuardDuty User Guide . - updated
At String - The timestamp when the threat entity set was updated.
Supporting Types
Tag, TagArgs
ThreatEntitySetStatus, ThreatEntitySetStatusArgs
- Inactive
- INACTIVE
- Activating
- ACTIVATING
- Active
- ACTIVE
- Deactivating
- DEACTIVATING
- Error
- ERROR
- Delete
Pending - DELETE_PENDING
- Deleted
- DELETED
- Threat
Entity Set Status Inactive - INACTIVE
- Threat
Entity Set Status Activating - ACTIVATING
- Threat
Entity Set Status Active - ACTIVE
- Threat
Entity Set Status Deactivating - DEACTIVATING
- Threat
Entity Set Status Error - ERROR
- Threat
Entity Set Status Delete Pending - DELETE_PENDING
- Threat
Entity Set Status Deleted - DELETED
- Inactive
- INACTIVE
- Activating
- ACTIVATING
- Active
- ACTIVE
- Deactivating
- DEACTIVATING
- Error
- ERROR
- Delete
Pending - DELETE_PENDING
- Deleted
- DELETED
- Inactive
- INACTIVE
- Activating
- ACTIVATING
- Active
- ACTIVE
- Deactivating
- DEACTIVATING
- Error
- ERROR
- Delete
Pending - DELETE_PENDING
- Deleted
- DELETED
- INACTIVE
- INACTIVE
- ACTIVATING
- ACTIVATING
- ACTIVE
- ACTIVE
- DEACTIVATING
- DEACTIVATING
- ERROR
- ERROR
- DELETE_PENDING
- DELETE_PENDING
- DELETED
- DELETED
- "INACTIVE"
- INACTIVE
- "ACTIVATING"
- ACTIVATING
- "ACTIVE"
- ACTIVE
- "DEACTIVATING"
- DEACTIVATING
- "ERROR"
- ERROR
- "DELETE_PENDING"
- DELETE_PENDING
- "DELETED"
- DELETED
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.