@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)
122 lines (121 loc) • 6.91 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* Resource Type definition for AWS::GuardDuty::TrustedEntitySet
*/
export declare class TrustedEntitySet extends pulumi.CustomResource {
/**
* Get an existing TrustedEntitySet resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): TrustedEntitySet;
/**
* Returns true if the given object is an instance of TrustedEntitySet. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is TrustedEntitySet;
/**
* 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.
*/
readonly activate: pulumi.Output<boolean | undefined>;
readonly awsId: pulumi.Output<string>;
/**
* The timestamp when the trusted entity set was created.
*/
readonly createdAt: pulumi.Output<string>;
/**
* 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](https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html) API.
*/
readonly detectorId: pulumi.Output<string | undefined>;
/**
* Specifies the error details when the status of the trusted entity set shows as *Error* .
*/
readonly errorDetails: pulumi.Output<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` 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.
*/
readonly expectedBucketOwner: pulumi.Output<string | undefined>;
/**
* The format of the file that contains the trusted entity set. For information about supported formats, see [List formats](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_upload-lists.html#prepare_list) in the *Amazon GuardDuty User Guide* .
*/
readonly format: pulumi.Output<string>;
/**
* The URI of the file that contains the trusted entity set.
*/
readonly location: pulumi.Output<string>;
/**
* A user-friendly name to identify the trusted entity set. Valid characters include lowercase letters, uppercase letters, numbers, dash(-), and underscore (_).
*/
readonly name: pulumi.Output<string | undefined>;
/**
* The status of your `TrustedEntitySet` . 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: pulumi.Output<enums.guardduty.TrustedEntitySetStatus>;
/**
* 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
*/
readonly tags: pulumi.Output<outputs.Tag[] | undefined>;
/**
* The timestamp when the trusted entity set was updated.
*/
readonly updatedAt: pulumi.Output<string>;
/**
* Create a TrustedEntitySet resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: TrustedEntitySetArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a TrustedEntitySet resource.
*/
export interface TrustedEntitySetArgs {
/**
* 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.
*/
activate?: pulumi.Input<boolean>;
/**
* 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](https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html) API.
*/
detectorId?: pulumi.Input<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` 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.
*/
expectedBucketOwner?: pulumi.Input<string>;
/**
* The format of the file that contains the trusted entity set. For information about supported formats, see [List formats](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_upload-lists.html#prepare_list) in the *Amazon GuardDuty User Guide* .
*/
format: pulumi.Input<string>;
/**
* The URI of the file that contains the trusted entity set.
*/
location: pulumi.Input<string>;
/**
* A user-friendly name to identify the trusted entity set. Valid characters include lowercase letters, uppercase letters, numbers, dash(-), and underscore (_).
*/
name?: pulumi.Input<string>;
/**
* 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
*/
tags?: pulumi.Input<pulumi.Input<inputs.TagArgs>[]>;
}