Class CfnFindingsFilter
The AWS::Macie::FindingsFilter
resource specifies a findings filter.
Inherited Members
Namespace: Amazon.CDK.AWS.Macie
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnFindingsFilter : CfnResource, IInspectable, ITaggableV2
Syntax (vb)
Public Class CfnFindingsFilter
Inherits CfnResource
Implements IInspectable, ITaggableV2
Remarks
In Amazon Macie , a findings filter , also referred to as a filter rule , is a set of custom criteria that specifies which findings to include or exclude from the results of a query for findings. The criteria can help you identify and focus on findings that have specific characteristics, such as severity, type, or the name of an affected AWS resource. You can also configure a findings filter to suppress (automatically archive) findings that match the filter's criteria. For more information, see Filtering findings in the Amazon Macie User Guide .
An AWS::Macie::Session
resource must exist for an AWS account before you can create an AWS::Macie::FindingsFilter
resource for the account. Use a DependsOn attribute to ensure that an AWS::Macie::Session
resource is created before other Macie resources are created for an account. For example, "DependsOn": "Session"
.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-findingsfilter.html
CloudformationResource: AWS::Macie::FindingsFilter
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Macie;
var cfnFindingsFilter = new CfnFindingsFilter(this, "MyCfnFindingsFilter", new CfnFindingsFilterProps {
FindingCriteria = new FindingCriteriaProperty {
Criterion = new Dictionary<string, object> {
{ "criterionKey", new CriterionAdditionalPropertiesProperty {
Eq = new [] { "eq" },
Gt = 123,
Gte = 123,
Lt = 123,
Lte = 123,
Neq = new [] { "neq" }
} }
}
},
Name = "name",
// the properties below are optional
Action = "action",
Description = "description",
Position = 123,
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnFindingsFilter(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnFindingsFilter(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnFindingsFilter(Construct, String, ICfnFindingsFilterProps) |
Properties
Action | The action to perform on findings that match the filter criteria ( |
AttrArn | The Amazon Resource Name (ARN) of the findings filter. |
AttrFindingsFilterListItems | |
AttrId | The unique identifier for the findings filter. |
CdkTagManager | Tag Manager which manages the tags for this resource. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Description | A custom description of the findings filter. |
FindingCriteria | The criteria to use to filter findings. |
Name | A custom name for the findings filter. |
Position | The position of the findings filter in the list of saved filter rules on the Amazon Macie console. |
Tags | An array of key-value pairs to apply to the findings filter. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnFindingsFilter(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnFindingsFilter(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnFindingsFilter(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnFindingsFilter(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnFindingsFilter(Construct, String, ICfnFindingsFilterProps)
public CfnFindingsFilter(Construct scope, string id, ICfnFindingsFilterProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnFindingsFilterProps
Resource properties.
Properties
Action
The action to perform on findings that match the filter criteria ( FindingCriteria
).
public virtual string Action { get; set; }
Property Value
System.String
Remarks
Valid values are:.
AttrArn
The Amazon Resource Name (ARN) of the findings filter.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrFindingsFilterListItems
public virtual IResolvable AttrFindingsFilterListItems { get; }
Property Value
Remarks
CloudformationAttribute: FindingsFilterListItems
AttrId
The unique identifier for the findings filter.
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
CdkTagManager
Tag Manager which manages the tags for this resource.
public virtual TagManager CdkTagManager { get; }
Property Value
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Description
A custom description of the findings filter.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
The description can contain 1-512 characters.
FindingCriteria
The criteria to use to filter findings.
public virtual object FindingCriteria { get; set; }
Property Value
System.Object
Name
A custom name for the findings filter.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
The name can contain 3-64 characters.
Position
The position of the findings filter in the list of saved filter rules on the Amazon Macie console.
public virtual Nullable<double> Position { get; set; }
Property Value
System.Nullable<System.Double>
Tags
An array of key-value pairs to apply to the findings filter.
public virtual ICfnTag[] Tags { get; set; }
Property Value
ICfnTag[]
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>