@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
78 lines (77 loc) • 3.68 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* Resource Type definition for AWS::GuardDuty::ThreatEntitySet
*/
export declare function getThreatEntitySet(args: GetThreatEntitySetArgs, opts?: pulumi.InvokeOptions): Promise<GetThreatEntitySetResult>;
export interface GetThreatEntitySetArgs {
/**
* 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](https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html) API.
*/
detectorId: string;
/**
* Returns the unique ID associated with the newly created threat entity set.
*/
id: string;
}
export interface GetThreatEntitySetResult {
/**
* The timestamp when the threat entity set was created.
*/
readonly createdAt?: string;
/**
* The details associated with the *Error* status of your threat entity list.
*/
readonly errorDetails?: string;
/**
* 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.
*/
readonly expectedBucketOwner?: string;
/**
* Returns the unique ID associated with the newly created threat entity set.
*/
readonly id?: string;
/**
* The URI of the file that contains the threat entity set.
*/
readonly location?: string;
/**
* The user-friendly name to identify the threat entity set. Valid characters are alphanumeric, whitespace, dash (-), and underscores (_).
*/
readonly name?: string;
/**
* The status of your `ThreatEntitySet` . For information about valid status values, see [Understanding list statuses](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_upload-lists.html#guardduty-entity-list-statuses) in the *Amazon GuardDuty User Guide* .
*/
readonly status?: enums.guardduty.ThreatEntitySetStatus;
/**
* 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
*/
readonly tags?: outputs.Tag[];
/**
* The timestamp when the threat entity set was updated.
*/
readonly updatedAt?: string;
}
/**
* Resource Type definition for AWS::GuardDuty::ThreatEntitySet
*/
export declare function getThreatEntitySetOutput(args: GetThreatEntitySetOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetThreatEntitySetResult>;
export interface GetThreatEntitySetOutputArgs {
/**
* 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](https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html) API.
*/
detectorId: pulumi.Input<string>;
/**
* Returns the unique ID associated with the newly created threat entity set.
*/
id: pulumi.Input<string>;
}