Filter class

Resource for managing an AWS Inspector Filter.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.inspector2.Filter("example", {
    filterCriterias: [{
        awsAccountIds: [{
            comparison: "EQUALS",
            value: "111222333444",
        }],
    }],
    name: "test",
    action: "NONE",
});
import pulumi
import pulumi_aws as aws

example = aws.inspector2.Filter("example",
    filter_criterias=[{
        "aws_account_ids": [{
            "comparison": "EQUALS",
            "value": "111222333444",
        }],
    }],
    name="test",
    action="NONE")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Inspector2.Filter("example", new()
    {
        FilterCriterias = new[]
        {
            new Aws.Inspector2.Inputs.FilterFilterCriteriaArgs
            {
                AwsAccountIds = new[]
                {
                    new Aws.Inspector2.Inputs.FilterFilterCriteriaAwsAccountIdArgs
                    {
                        Comparison = "EQUALS",
                        Value = "111222333444",
                    },
                },
            },
        },
        Name = "test",
        Action = "NONE",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/inspector2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := inspector2.NewFilter(ctx, "example", &inspector2.FilterArgs{
			FilterCriterias: inspector2.FilterFilterCriteriaArray{
				&inspector2.FilterFilterCriteriaArgs{
					AwsAccountIds: inspector2.FilterFilterCriteriaAwsAccountIdArray{
						&inspector2.FilterFilterCriteriaAwsAccountIdArgs{
							Comparison: pulumi.String("EQUALS"),
							Value:      pulumi.String("111222333444"),
						},
					},
				},
			},
			Name:   pulumi.String("test"),
			Action: pulumi.String("NONE"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_inspector2_filter" "example" {
  filter_criterias {
    aws_account_ids {
      comparison = "EQUALS"
      value      = "111222333444"
    }
  }
  name   = "test"
  action = "NONE"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.inspector2.Filter;
import com.pulumi.aws.inspector2.FilterArgs;
import com.pulumi.aws.inspector2.inputs.FilterFilterCriteriaArgs;
import com.pulumi.aws.inspector2.inputs.FilterFilterCriteriaAwsAccountIdArgs;
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 Filter("example", FilterArgs.builder()
            .filterCriterias(FilterFilterCriteriaArgs.builder()
                .awsAccountIds(FilterFilterCriteriaAwsAccountIdArgs.builder()
                    .comparison("EQUALS")
                    .value("111222333444")
                    .build())
                .build())
            .name("test")
            .action("NONE")
            .build());

    }
}
resources:
  example:
    type: aws:inspector2:Filter
    properties:
      filterCriterias:
        - awsAccountIds:
            - comparison: EQUALS
              value: '111222333444'
      name: test
      action: NONE

Import

Identity Schema

Required

  • arn (String) ARN of the Inspector filter.

Using pulumi import, import Inspector Filter using the arn. For example:

$ pulumi import aws:inspector2/filter:Filter example "arn:aws:inspector2:us-east-1:111222333444:owner/111222333444/filter/abcdefgh12345678"

Constructors

Filter(String name, {FilterArgs? args, CustomResourceOptions? options})
Creates a new Filter. name The Pulumi resource name. args Arguments used to configure this Filter. The set of arguments for Filter. options Resource options controlling this resource's behavior.
Filter.reference(String urn)
Creates a typed reference to an existing Filter resource.

Properties

action ↔ Output<String>
Action to be applied to the findings that maatch the filter. Possible values are NONE and SUPPRESS
latefinal
arn ↔ Output<String>
ARN of the Filter.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
description ↔ Output<String?>
Description
latefinal
filterCriterias ↔ Output<List<FilterFilterCriteria>>
Details on the filter criteria. Documented below.
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>
Name of the filter.
latefinal
reason ↔ Output<String?>
Reason for creating the filter
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
tags ↔ Output<Map<String, String>?>
Map of tags assigned to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration 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, {FilterState? state, CustomResourceOptions? options}) → Filter
Gets an existing Filter resource's state with the given name and id.