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 Macie 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(Construct, string, ICfnFindingsFilterProps) | The |
Properties
Action | The action to perform on findings that match the filter criteria ( |
AttrArn | The Amazon Resource Name (ARN) of the findings filter. |
AttrFindingsFilterListItems | The |
AttrId | The unique identifier for the findings filter. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CdkTagManager | Tag Manager which manages the tags for this resource. |
CfnProperties | The |
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>) | The |
Constructors
CfnFindingsFilter(Construct, string, ICfnFindingsFilterProps)
The AWS::Macie::FindingsFilter
resource specifies a findings filter.
public CfnFindingsFilter(Construct scope, string id, ICfnFindingsFilterProps props)
Parameters
- scope Construct
Scope in which this resource is defined.
- id string
Construct identifier for this resource (unique in its scope).
- props ICfnFindingsFilterProps
Resource properties.
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 Macie 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
Properties
Action
The action to perform on findings that match the filter criteria ( FindingCriteria
).
public virtual string? Action { get; set; }
Property Value
Remarks
Valid values are:.
AttrArn
The Amazon Resource Name (ARN) of the findings filter.
public virtual string AttrArn { get; }
Property Value
Remarks
CloudformationAttribute: Arn
AttrFindingsFilterListItems
The AWS::Macie::FindingsFilter
resource specifies a findings filter.
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
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
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 Macie 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
CdkTagManager
Tag Manager which manages the tags for this resource.
public virtual TagManager CdkTagManager { get; }
Property Value
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 Macie 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
CfnProperties
The AWS::Macie::FindingsFilter
resource specifies a findings filter.
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
Overrides
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 Macie 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
Description
A custom description of the findings filter.
public virtual string? Description { get; set; }
Property Value
Remarks
The description can contain 1-512 characters.
FindingCriteria
The criteria to use to filter findings.
public virtual object FindingCriteria { get; set; }
Property Value
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 Macie 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
Name
A custom name for the findings filter.
public virtual string Name { get; set; }
Property Value
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 double? Position { get; set; }
Property Value
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 Macie 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
Tags
An array of key-value pairs to apply to the findings filter.
public virtual ICfnTag[]? Tags { get; set; }
Property Value
ICfnTag[]
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 Macie 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
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.
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 Macie 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
RenderProperties(IDictionary<string, object>)
The AWS::Macie::FindingsFilter
resource specifies a findings filter.
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props IDictionary<string, object>
Returns
Overrides
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 Macie 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