AWS::InspectorV2::Filter

Details about a filter.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::InspectorV2::Filter",
  "Properties" : {
      "Description" : String,
      "FilterAction" : String,
      "FilterCriteria" : FilterCriteria,
      "Name" : String,
      "Tags" : {Key: Value, ...}
    }
}

YAML

Type: AWS::InspectorV2::Filter
Properties:
  Description: String
  FilterAction: String
  FilterCriteria: 
    FilterCriteria
  Name: String
  Tags: 
    Key: Value

Properties

Description

A description of the filter.

Required: No

Type: String

Minimum: 1

Maximum: 512

Update requires: No interruption

FilterAction

The action that is to be applied to the findings that match the filter.

Required: Yes

Type: String

Allowed values: NONE | SUPPRESS

Update requires: No interruption

FilterCriteria

Details on the filter criteria associated with this filter.

Required: Yes

Type: FilterCriteria

Update requires: No interruption

Name

The name of the filter.

Required: Yes

Type: String

Minimum: 1

Maximum: 128

Update requires: No interruption

Tags

The tags attached to the filter.

Required: No

Type: Object of String

Pattern: ^.{2,127}$

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ARN of the filter. For example:

arn:aws:inspector2:us-east-1:012345678901:owner/012345678901/filter/c1c0fe5d28e39baa

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Arn

The Amazon Resource Number (ARN) associated with this filter.