AWS Classic

Pulumi Official
Package maintained by Pulumi
v5.4.0 published on Wednesday, May 4, 2022 by Pulumi

FindingsFilter

Provides a resource to manage an Amazon Macie Findings Filter.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Aws.Macie2.Account("example", new Aws.Macie2.AccountArgs
        {
        });
        var test = new Aws.Macie.FindingsFilter("test", new Aws.Macie.FindingsFilterArgs
        {
            Description = "DESCRIPTION",
            Position = 1,
            Action = "ARCHIVE",
            FindingCriteria = new Aws.Macie.Inputs.FindingsFilterFindingCriteriaArgs
            {
                Criterions = 
                {
                    new Aws.Macie.Inputs.FindingsFilterFindingCriteriaCriterionArgs
                    {
                        Field = "region",
                        Eqs = 
                        {
                            data.Aws_region.Current.Name,
                        },
                    },
                },
            },
        }, new CustomResourceOptions
        {
            DependsOn = 
            {
                aws_macie2_account.Test,
            },
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/macie"
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/macie2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := macie2.NewAccount(ctx, "example", nil)
		if err != nil {
			return err
		}
		_, err = macie.NewFindingsFilter(ctx, "test", &macie.FindingsFilterArgs{
			Description: pulumi.String("DESCRIPTION"),
			Position:    pulumi.Int(1),
			Action:      pulumi.String("ARCHIVE"),
			FindingCriteria: &macie.FindingsFilterFindingCriteriaArgs{
				Criterions: macie.FindingsFilterFindingCriteriaCriterionArray{
					&macie.FindingsFilterFindingCriteriaCriterionArgs{
						Field: pulumi.String("region"),
						Eqs: pulumi.StringArray{
							pulumi.Any(data.Aws_region.Current.Name),
						},
					},
				},
			},
		}, pulumi.DependsOn([]pulumi.Resource{
			aws_macie2_account.Test,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Account("example");

        var test = new FindingsFilter("test", FindingsFilterArgs.builder()        
            .description("DESCRIPTION")
            .position(1)
            .action("ARCHIVE")
            .findingCriteria(FindingsFilterFindingCriteria.builder()
                .criterions(FindingsFilterFindingCriteriaCriterion.builder()
                    .field("region")
                    .eqs(data.getAws_region().getCurrent().getName())
                    .build())
                .build())
            .build());

        }
}
import pulumi
import pulumi_aws as aws

example = aws.macie2.Account("example")
test = aws.macie.FindingsFilter("test",
    description="DESCRIPTION",
    position=1,
    action="ARCHIVE",
    finding_criteria=aws.macie.FindingsFilterFindingCriteriaArgs(
        criterions=[aws.macie.FindingsFilterFindingCriteriaCriterionArgs(
            field="region",
            eqs=[data["aws_region"]["current"]["name"]],
        )],
    ),
    opts=pulumi.ResourceOptions(depends_on=[aws_macie2_account["test"]]))
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.macie2.Account("example", {});
const test = new aws.macie.FindingsFilter("test", {
    description: "DESCRIPTION",
    position: 1,
    action: "ARCHIVE",
    findingCriteria: {
        criterions: [{
            field: "region",
            eqs: [data.aws_region.current.name],
        }],
    },
}, {
    dependsOn: [aws_macie2_account.test],
});
resources:
  example:
    type: aws:macie2:Account
  test:
    type: aws:macie:FindingsFilter
    properties:
      description: DESCRIPTION
      position: 1
      action: ARCHIVE
      findingCriteria:
        criterions:
          - field: region
            eqs:
              - ${data.aws_region.current.name}
    options:
      dependson:
        - ${aws_macie2_account.test}

Create a FindingsFilter Resource

new FindingsFilter(name: string, args: FindingsFilterArgs, opts?: CustomResourceOptions);
@overload
def FindingsFilter(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   action: Optional[str] = None,
                   description: Optional[str] = None,
                   finding_criteria: Optional[FindingsFilterFindingCriteriaArgs] = None,
                   name: Optional[str] = None,
                   name_prefix: Optional[str] = None,
                   position: Optional[int] = None,
                   tags: Optional[Mapping[str, str]] = None)
@overload
def FindingsFilter(resource_name: str,
                   args: FindingsFilterArgs,
                   opts: Optional[ResourceOptions] = None)
func NewFindingsFilter(ctx *Context, name string, args FindingsFilterArgs, opts ...ResourceOption) (*FindingsFilter, error)
public FindingsFilter(string name, FindingsFilterArgs args, CustomResourceOptions? opts = null)
public FindingsFilter(String name, FindingsFilterArgs args)
public FindingsFilter(String name, FindingsFilterArgs args, CustomResourceOptions options)
type: aws:macie:FindingsFilter
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args FindingsFilterArgs
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 FindingsFilterArgs
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 FindingsFilterArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args FindingsFilterArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args FindingsFilterArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

FindingsFilter Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The FindingsFilter resource accepts the following input properties:

Action string

The action to perform on findings that meet the filter criteria (finding_criteria). Valid values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.

FindingCriteria FindingsFilterFindingCriteriaArgs

The criteria to use to filter findings.

Description string

A custom description of the filter. The description can contain as many as 512 characters.

Name string
NamePrefix string

Creates a unique name beginning with the specified prefix. Conflicts with name.

Position int

The position of the filter in the list of saved filters on the Amazon Macie console. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings.

Tags Dictionary<string, string>

A map of key-value pairs that specifies the tags to associate with the filter.

Action string

The action to perform on findings that meet the filter criteria (finding_criteria). Valid values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.

FindingCriteria FindingsFilterFindingCriteriaArgs

The criteria to use to filter findings.

Description string

A custom description of the filter. The description can contain as many as 512 characters.

Name string
NamePrefix string

Creates a unique name beginning with the specified prefix. Conflicts with name.

Position int

The position of the filter in the list of saved filters on the Amazon Macie console. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings.

Tags map[string]string

A map of key-value pairs that specifies the tags to associate with the filter.

action String

The action to perform on findings that meet the filter criteria (finding_criteria). Valid values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.

findingCriteria FindingsFilterFindingCriteriaArgs

The criteria to use to filter findings.

description String

A custom description of the filter. The description can contain as many as 512 characters.

name String
namePrefix String

Creates a unique name beginning with the specified prefix. Conflicts with name.

position Integer

The position of the filter in the list of saved filters on the Amazon Macie console. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings.

tags Map

A map of key-value pairs that specifies the tags to associate with the filter.

action string

The action to perform on findings that meet the filter criteria (finding_criteria). Valid values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.

findingCriteria FindingsFilterFindingCriteriaArgs

The criteria to use to filter findings.

description string

A custom description of the filter. The description can contain as many as 512 characters.

name string
namePrefix string

Creates a unique name beginning with the specified prefix. Conflicts with name.

position number

The position of the filter in the list of saved filters on the Amazon Macie console. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings.

tags {[key: string]: string}

A map of key-value pairs that specifies the tags to associate with the filter.

action str

The action to perform on findings that meet the filter criteria (finding_criteria). Valid values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.

finding_criteria FindingsFilterFindingCriteriaArgs

The criteria to use to filter findings.

description str

A custom description of the filter. The description can contain as many as 512 characters.

name str
name_prefix str

Creates a unique name beginning with the specified prefix. Conflicts with name.

position int

The position of the filter in the list of saved filters on the Amazon Macie console. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings.

tags Mapping[str, str]

A map of key-value pairs that specifies the tags to associate with the filter.

action String

The action to perform on findings that meet the filter criteria (finding_criteria). Valid values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.

findingCriteria Property Map

The criteria to use to filter findings.

description String

A custom description of the filter. The description can contain as many as 512 characters.

name String
namePrefix String

Creates a unique name beginning with the specified prefix. Conflicts with name.

position Number

The position of the filter in the list of saved filters on the Amazon Macie console. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings.

tags Map

A map of key-value pairs that specifies the tags to associate with the filter.

Outputs

All input properties are implicitly available as output properties. Additionally, the FindingsFilter resource produces the following output properties:

Arn string

The Amazon Resource Name (ARN) of the Findings Filter.

Id string

The provider-assigned unique ID for this managed resource.

TagsAll Dictionary<string, string>
Arn string

The Amazon Resource Name (ARN) of the Findings Filter.

Id string

The provider-assigned unique ID for this managed resource.

TagsAll map[string]string
arn String

The Amazon Resource Name (ARN) of the Findings Filter.

id String

The provider-assigned unique ID for this managed resource.

tagsAll Map
arn string

The Amazon Resource Name (ARN) of the Findings Filter.

id string

The provider-assigned unique ID for this managed resource.

tagsAll {[key: string]: string}
arn str

The Amazon Resource Name (ARN) of the Findings Filter.

id str

The provider-assigned unique ID for this managed resource.

tags_all Mapping[str, str]
arn String

The Amazon Resource Name (ARN) of the Findings Filter.

id String

The provider-assigned unique ID for this managed resource.

tagsAll Map

Look up an Existing FindingsFilter Resource

Get an existing FindingsFilter resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: FindingsFilterState, opts?: CustomResourceOptions): FindingsFilter
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        action: Optional[str] = None,
        arn: Optional[str] = None,
        description: Optional[str] = None,
        finding_criteria: Optional[FindingsFilterFindingCriteriaArgs] = None,
        name: Optional[str] = None,
        name_prefix: Optional[str] = None,
        position: Optional[int] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> FindingsFilter
func GetFindingsFilter(ctx *Context, name string, id IDInput, state *FindingsFilterState, opts ...ResourceOption) (*FindingsFilter, error)
public static FindingsFilter Get(string name, Input<string> id, FindingsFilterState? state, CustomResourceOptions? opts = null)
public static FindingsFilter get(String name, Output<String> id, FindingsFilterState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Action string

The action to perform on findings that meet the filter criteria (finding_criteria). Valid values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.

Arn string

The Amazon Resource Name (ARN) of the Findings Filter.

Description string

A custom description of the filter. The description can contain as many as 512 characters.

FindingCriteria FindingsFilterFindingCriteriaArgs

The criteria to use to filter findings.

Name string
NamePrefix string

Creates a unique name beginning with the specified prefix. Conflicts with name.

Position int

The position of the filter in the list of saved filters on the Amazon Macie console. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings.

Tags Dictionary<string, string>

A map of key-value pairs that specifies the tags to associate with the filter.

TagsAll Dictionary<string, string>
Action string

The action to perform on findings that meet the filter criteria (finding_criteria). Valid values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.

Arn string

The Amazon Resource Name (ARN) of the Findings Filter.

Description string

A custom description of the filter. The description can contain as many as 512 characters.

FindingCriteria FindingsFilterFindingCriteriaArgs

The criteria to use to filter findings.

Name string
NamePrefix string

Creates a unique name beginning with the specified prefix. Conflicts with name.

Position int

The position of the filter in the list of saved filters on the Amazon Macie console. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings.

Tags map[string]string

A map of key-value pairs that specifies the tags to associate with the filter.

TagsAll map[string]string
action String

The action to perform on findings that meet the filter criteria (finding_criteria). Valid values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.

arn String

The Amazon Resource Name (ARN) of the Findings Filter.

description String

A custom description of the filter. The description can contain as many as 512 characters.

findingCriteria FindingsFilterFindingCriteriaArgs

The criteria to use to filter findings.

name String
namePrefix String

Creates a unique name beginning with the specified prefix. Conflicts with name.

position Integer

The position of the filter in the list of saved filters on the Amazon Macie console. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings.

tags Map

A map of key-value pairs that specifies the tags to associate with the filter.

tagsAll Map
action string

The action to perform on findings that meet the filter criteria (finding_criteria). Valid values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.

arn string

The Amazon Resource Name (ARN) of the Findings Filter.

description string

A custom description of the filter. The description can contain as many as 512 characters.

findingCriteria FindingsFilterFindingCriteriaArgs

The criteria to use to filter findings.

name string
namePrefix string

Creates a unique name beginning with the specified prefix. Conflicts with name.

position number

The position of the filter in the list of saved filters on the Amazon Macie console. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings.

tags {[key: string]: string}

A map of key-value pairs that specifies the tags to associate with the filter.

tagsAll {[key: string]: string}
action str

The action to perform on findings that meet the filter criteria (finding_criteria). Valid values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.

arn str

The Amazon Resource Name (ARN) of the Findings Filter.

description str

A custom description of the filter. The description can contain as many as 512 characters.

finding_criteria FindingsFilterFindingCriteriaArgs

The criteria to use to filter findings.

name str
name_prefix str

Creates a unique name beginning with the specified prefix. Conflicts with name.

position int

The position of the filter in the list of saved filters on the Amazon Macie console. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings.

tags Mapping[str, str]

A map of key-value pairs that specifies the tags to associate with the filter.

tags_all Mapping[str, str]
action String

The action to perform on findings that meet the filter criteria (finding_criteria). Valid values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.

arn String

The Amazon Resource Name (ARN) of the Findings Filter.

description String

A custom description of the filter. The description can contain as many as 512 characters.

findingCriteria Property Map

The criteria to use to filter findings.

name String
namePrefix String

Creates a unique name beginning with the specified prefix. Conflicts with name.

position Number

The position of the filter in the list of saved filters on the Amazon Macie console. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings.

tags Map

A map of key-value pairs that specifies the tags to associate with the filter.

tagsAll Map

Supporting Types

FindingsFilterFindingCriteria

Criterions List<FindingsFilterFindingCriteriaCriterion>

A condition that specifies the property, operator, and one or more values to use to filter the results. (documented below)

Criterions []FindingsFilterFindingCriteriaCriterion

A condition that specifies the property, operator, and one or more values to use to filter the results. (documented below)

criterions ListFilterFindingCriteriaCriterion>

A condition that specifies the property, operator, and one or more values to use to filter the results. (documented below)

criterions FindingsFilterFindingCriteriaCriterion[]

A condition that specifies the property, operator, and one or more values to use to filter the results. (documented below)

criterions Sequence[FindingsFilterFindingCriteriaCriterion]

A condition that specifies the property, operator, and one or more values to use to filter the results. (documented below)

criterions List

A condition that specifies the property, operator, and one or more values to use to filter the results. (documented below)

FindingsFilterFindingCriteriaCriterion

Field string

The name of the field to be evaluated.

EqExactMatches List<string>

The value for the property exclusively matches (equals an exact match for) all the specified values. If you specify multiple values, Amazon Macie uses AND logic to join the values.

Eqs List<string>

The value for the property matches (equals) the specified value. If you specify multiple values, Amazon Macie uses OR logic to join the values.

Gt string

The value for the property is greater than the specified value.

Gte string

The value for the property is greater than or equal to the specified value.

Lt string

The value for the property is less than the specified value.

Lte string

The value for the property is less than or equal to the specified value.

Neqs List<string>

The value for the property doesn't match (doesn't equal) the specified value. If you specify multiple values, Amazon Macie uses OR logic to join the values.

Field string

The name of the field to be evaluated.

EqExactMatches []string

The value for the property exclusively matches (equals an exact match for) all the specified values. If you specify multiple values, Amazon Macie uses AND logic to join the values.

Eqs []string

The value for the property matches (equals) the specified value. If you specify multiple values, Amazon Macie uses OR logic to join the values.

Gt string

The value for the property is greater than the specified value.

Gte string

The value for the property is greater than or equal to the specified value.

Lt string

The value for the property is less than the specified value.

Lte string

The value for the property is less than or equal to the specified value.

Neqs []string

The value for the property doesn't match (doesn't equal) the specified value. If you specify multiple values, Amazon Macie uses OR logic to join the values.

field String

The name of the field to be evaluated.

eqExactMatches List

The value for the property exclusively matches (equals an exact match for) all the specified values. If you specify multiple values, Amazon Macie uses AND logic to join the values.

eqs List

The value for the property matches (equals) the specified value. If you specify multiple values, Amazon Macie uses OR logic to join the values.

gt String

The value for the property is greater than the specified value.

gte String

The value for the property is greater than or equal to the specified value.

lt String

The value for the property is less than the specified value.

lte String

The value for the property is less than or equal to the specified value.

neqs List

The value for the property doesn't match (doesn't equal) the specified value. If you specify multiple values, Amazon Macie uses OR logic to join the values.

field string

The name of the field to be evaluated.

eqExactMatches string[]

The value for the property exclusively matches (equals an exact match for) all the specified values. If you specify multiple values, Amazon Macie uses AND logic to join the values.

eqs string[]

The value for the property matches (equals) the specified value. If you specify multiple values, Amazon Macie uses OR logic to join the values.

gt string

The value for the property is greater than the specified value.

gte string

The value for the property is greater than or equal to the specified value.

lt string

The value for the property is less than the specified value.

lte string

The value for the property is less than or equal to the specified value.

neqs string[]

The value for the property doesn't match (doesn't equal) the specified value. If you specify multiple values, Amazon Macie uses OR logic to join the values.

field str

The name of the field to be evaluated.

eq_exact_matches Sequence[str]

The value for the property exclusively matches (equals an exact match for) all the specified values. If you specify multiple values, Amazon Macie uses AND logic to join the values.

eqs Sequence[str]

The value for the property matches (equals) the specified value. If you specify multiple values, Amazon Macie uses OR logic to join the values.

gt str

The value for the property is greater than the specified value.

gte str

The value for the property is greater than or equal to the specified value.

lt str

The value for the property is less than the specified value.

lte str

The value for the property is less than or equal to the specified value.

neqs Sequence[str]

The value for the property doesn't match (doesn't equal) the specified value. If you specify multiple values, Amazon Macie uses OR logic to join the values.

field String

The name of the field to be evaluated.

eqExactMatches List

The value for the property exclusively matches (equals an exact match for) all the specified values. If you specify multiple values, Amazon Macie uses AND logic to join the values.

eqs List

The value for the property matches (equals) the specified value. If you specify multiple values, Amazon Macie uses OR logic to join the values.

gt String

The value for the property is greater than the specified value.

gte String

The value for the property is greater than or equal to the specified value.

lt String

The value for the property is less than the specified value.

lte String

The value for the property is less than or equal to the specified value.

neqs List

The value for the property doesn't match (doesn't equal) the specified value. If you specify multiple values, Amazon Macie uses OR logic to join the values.

Import

aws_macie2_findings_filter can be imported using the id, e.g.,

 $ pulumi import aws:macie/findingsFilter:FindingsFilter example abcd1

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.