FindingsFilter class
Provides a resource to manage an Amazon Macie Findings Filter.
Example Usage
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", {
findingCriteria: {
criterions: [{
field: "region",
eqs: [current.region],
}],
},
name: "NAME OF THE FINDINGS FILTER",
description: "DESCRIPTION",
position: 1,
action: "ARCHIVE",
}, {
dependsOn: [testAwsMacie2Account],
});
import pulumi
import pulumi_aws as aws
example = aws.macie2.Account("example")
test = aws.macie.FindingsFilter("test",
finding_criteria={
"criterions": [{
"field": "region",
"eqs": [current["region"]],
}],
},
name="NAME OF THE FINDINGS FILTER",
description="DESCRIPTION",
position=1,
action="ARCHIVE",
opts = pulumi.ResourceOptions(depends_on=[test_aws_macie2_account]))
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Macie2.Account("example");
var test = new Aws.Macie.FindingsFilter("test", new()
{
FindingCriteria = new Aws.Macie.Inputs.FindingsFilterFindingCriteriaArgs
{
Criterions = new[]
{
new Aws.Macie.Inputs.FindingsFilterFindingCriteriaCriterionArgs
{
Field = "region",
Eqs = new[]
{
current.Region,
},
},
},
},
Name = "NAME OF THE FINDINGS FILTER",
Description = "DESCRIPTION",
Position = 1,
Action = "ARCHIVE",
}, new CustomResourceOptions
{
DependsOn =
{
testAwsMacie2Account,
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/macie"
"github.com/pulumi/pulumi-aws/sdk/v7/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{
FindingCriteria: &macie.FindingsFilterFindingCriteriaArgs{
Criterions: macie.FindingsFilterFindingCriteriaCriterionArray{
&macie.FindingsFilterFindingCriteriaCriterionArgs{
Field: pulumi.String("region"),
Eqs: pulumi.StringArray{
current.Region,
},
},
},
},
Name: pulumi.String("NAME OF THE FINDINGS FILTER"),
Description: pulumi.String("DESCRIPTION"),
Position: pulumi.Int(1),
Action: pulumi.String("ARCHIVE"),
}, pulumi.DependsOn([]pulumi.Resource{
testAwsMacie2Account,
}))
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_macie2_account" "example" {
}
resource "aws_macie_findingsfilter" "test" {
depends_on = [testAwsMacie2Account]
finding_criteria = {
criterions = [{
"field" = "region"
"eqs" = [current.region]
}]
}
name = "NAME OF THE FINDINGS FILTER"
description = "DESCRIPTION"
position = 1
action = "ARCHIVE"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.macie2.Account;
import com.pulumi.aws.macie.FindingsFilter;
import com.pulumi.aws.macie.FindingsFilterArgs;
import com.pulumi.aws.macie.inputs.FindingsFilterFindingCriteriaArgs;
import com.pulumi.aws.macie.inputs.FindingsFilterFindingCriteriaCriterionArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
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()
.findingCriteria(FindingsFilterFindingCriteriaArgs.builder()
.criterions(FindingsFilterFindingCriteriaCriterionArgs.builder()
.field("region")
.eqs(current.region())
.build())
.build())
.name("NAME OF THE FINDINGS FILTER")
.description("DESCRIPTION")
.position(1)
.action("ARCHIVE")
.build(), CustomResourceOptions.builder()
.dependsOn(testAwsMacie2Account)
.build());
}
}
resources:
example:
type: aws:macie2:Account
test:
type: aws:macie:FindingsFilter
properties:
findingCriteria:
criterions:
- field: region
eqs:
- ${current.region}
name: NAME OF THE FINDINGS FILTER
description: DESCRIPTION
position: 1
action: ARCHIVE
options:
dependsOn:
- ${testAwsMacie2Account}
Import
Using pulumi import, import aws.macie.FindingsFilter using the id. For example:
$ pulumi import aws:macie/findingsFilter:FindingsFilter example abcd1
Constructors
- FindingsFilter(String name, {FindingsFilterArgs? args, CustomResourceOptions? options})
-
Creates a new FindingsFilter.
nameThe Pulumi resource name.argsArguments used to configure this FindingsFilter. The set of arguments for FindingsFilter.optionsResource options controlling this resource's behavior. - FindingsFilter.reference(String urn)
- Creates a typed reference to an existing FindingsFilter resource.
Properties
-
action
↔ Output<
String> -
The action to perform on findings that meet the filter criteria (
findingCriteria). Valid values are:ARCHIVE, suppress (automatically archive) the findings; and,NOOP, don't perform any action on the findings.latefinal -
arn
↔ Output<
String> -
ARN of the Findings Filter.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
description
↔ Output<
String?> -
A custom description of the filter. The description can contain as many as 512 characters.
latefinal
-
findingCriteria
↔ Output<
FindingsFilterFindingCriteria> -
The criteria to use to filter findings.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
name
↔ Output<
String> -
A custom name for the filter. The name must contain at least 3 characters and can contain as many as 64 characters. If omitted, the provider will assign a random, unique name. Conflicts with
namePrefix.latefinal -
namePrefix
↔ Output<
String> -
Creates a unique name beginning with the specified prefix. Conflicts with
name.latefinal -
position
↔ Output<
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.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
Map of tags to assign to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {FindingsFilterState? state, CustomResourceOptions? options}) → FindingsFilter -
Gets an existing FindingsFilter resource's state with the given
nameandid.