Class CfnFindingsFilter
A CloudFormation AWS::Macie::FindingsFilter
.
Inherited Members
Namespace: Amazon.CDK.AWS.Macie
Assembly: Amazon.CDK.AWS.Macie.dll
Syntax (csharp)
public class CfnFindingsFilter : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnFindingsFilter
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::Macie::FindingsFilter
resource specifies a findings filter. 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"
.
CloudformationResource: AWS::Macie::FindingsFilter
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-findingsfilter.html
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
});
Synopsis
Constructors
CfnFindingsFilter(Construct, String, ICfnFindingsFilterProps) | Create a new |
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 |
Properties
Action | The action to perform on findings that match the filter criteria ( |
AttrArn | The Amazon Resource Name (ARN) of the findings filter. |
AttrId | The unique identifier for the findings filter. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Description | A custom description of the findings filter. The description can contain 1-512 characters. |
FindingCriteria | The criteria to use to filter findings. |
Name | A custom name for the findings filter. The name can contain 3-64 characters. |
Position | The position of the findings filter in the list of saved filters on the Amazon Macie console. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnFindingsFilter(Construct, String, ICfnFindingsFilterProps)
Create a new AWS::Macie::FindingsFilter
.
public CfnFindingsFilter(Construct scope, string id, ICfnFindingsFilterProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnFindingsFilterProps
- resource properties.
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
Properties
Action
The action to perform on findings that match the filter criteria ( FindingCriteria
). Valid values are:.
public virtual string Action { get; set; }
Property Value
System.String
Remarks
AttrArn
The Amazon Resource Name (ARN) of the findings filter.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrId
The unique identifier for the findings filter.
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
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. The description can contain 1-512 characters.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
Avoid including sensitive data in the description. Users of the account might be able to see the description, depending on the actions that they're allowed to perform in Amazon Macie .
FindingCriteria
The criteria to use to filter findings.
public virtual object FindingCriteria { get; set; }
Property Value
System.Object
Remarks
Name
A custom name for the findings filter. The name can contain 3-64 characters.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
Avoid including sensitive data in the name. Users of the account might be able to see the name, depending on the actions that they're allowed to perform in Amazon Macie .
Position
The position of the findings filter in the list of saved filters on the Amazon Macie console.
public virtual Nullable<double> Position { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to findings.
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>