@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)
106 lines (105 loc) • 6.05 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Resource Type definition for AWS::GuardDuty::Filter
*/
export declare class Filter extends pulumi.CustomResource {
/**
* Get an existing Filter 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): Filter;
/**
* Returns true if the given object is an instance of Filter. 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 Filter;
/**
* Specifies the action that is to be applied to the findings that match the filter.
*/
readonly action: pulumi.Output<string | undefined>;
/**
* The description of the filter. Valid characters include alphanumeric characters, and special characters such as hyphen, period, colon, underscore, parentheses ( `{ }` , `[ ]` , and `( )` ), forward slash, horizontal tab, vertical tab, newline, form feed, return, and whitespace.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The detector ID associated with the GuardDuty account for which you want to create a filter.
*
* 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>;
/**
* Represents the criteria to be used in the filter for querying findings.
*/
readonly findingCriteria: pulumi.Output<outputs.guardduty.FilterFindingCriteria>;
/**
* The name of the filter. Valid characters include period (.), underscore (_), dash (-), and alphanumeric characters. A whitespace is considered to be an invalid character.
*/
readonly name: pulumi.Output<string>;
/**
* Specifies the position of the filter in the list of current filters. Also specifies the order in which this filter is applied to the findings. The minimum value for this property is 1 and the maximum is 100.
*
* By default, filters may not be created in the same order as they are ranked. To ensure that the filters are created in the expected order, you can use an optional attribute, [DependsOn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) , with the following syntax: `"DependsOn":[ "ObjectName" ]` .
*/
readonly rank: pulumi.Output<number | undefined>;
/**
* The tags to be added to a new filter 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>;
/**
* Create a Filter 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: FilterArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a Filter resource.
*/
export interface FilterArgs {
/**
* Specifies the action that is to be applied to the findings that match the filter.
*/
action?: pulumi.Input<string>;
/**
* The description of the filter. Valid characters include alphanumeric characters, and special characters such as hyphen, period, colon, underscore, parentheses ( `{ }` , `[ ]` , and `( )` ), forward slash, horizontal tab, vertical tab, newline, form feed, return, and whitespace.
*/
description?: pulumi.Input<string>;
/**
* The detector ID associated with the GuardDuty account for which you want to create a filter.
*
* 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>;
/**
* Represents the criteria to be used in the filter for querying findings.
*/
findingCriteria: pulumi.Input<inputs.guardduty.FilterFindingCriteriaArgs>;
/**
* The name of the filter. Valid characters include period (.), underscore (_), dash (-), and alphanumeric characters. A whitespace is considered to be an invalid character.
*/
name?: pulumi.Input<string>;
/**
* Specifies the position of the filter in the list of current filters. Also specifies the order in which this filter is applied to the findings. The minimum value for this property is 1 and the maximum is 100.
*
* By default, filters may not be created in the same order as they are ranked. To ensure that the filters are created in the expected order, you can use an optional attribute, [DependsOn](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) , with the following syntax: `"DependsOn":[ "ObjectName" ]` .
*/
rank?: pulumi.Input<number>;
/**
* The tags to be added to a new filter 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>[]>;
}