Class CfnFindingsFilter

A CloudFormation AWS::Macie::FindingsFilter.

Inheritance

System.Object

Construct

CfnElement

CfnRefElement

CfnResource

CfnFindingsFilter

Implements

IConstruct

Constructs.IConstruct

IDependable

IInspectable

Inherited Members

CfnResource.IsCfnResource(IConstruct)

CfnResource.AddDeletionOverride(String)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(String, Object)

CfnResource.AddOverride(String, Object)

CfnResource.AddPropertyDeletionOverride(String)

CfnResource.AddPropertyOverride(String, Object)

CfnResource.ApplyRemovalPolicy(Nullable<RemovalPolicy>, IRemovalPolicyOptions)

CfnResource.GetAtt(String)

CfnResource.GetMetadata(String)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(Object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnRefElement.Ref

CfnElement.IsCfnElement(Object)

CfnElement.OverrideLogicalId(String)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Construct.IsConstruct(Object)

Construct.OnPrepare()

Construct.OnSynthesize(ISynthesisSession)

Construct.OnValidate()

Construct.Prepare()

Construct.Synthesize(ISynthesisSession)

Construct.Validate()

Construct.Node

Namespace: Amazon.CDK.AWS.Macie

Assembly: Amazon.CDK.AWS.Macie.dll

Syntax (csharp)

public class CfnFindingsFilter : CfnResource, IConstruct, IConstruct, IDependable, IInspectable

Syntax (vb)

Public Class CfnFindingsFilter
    Inherits CfnResource
    Implements IConstruct, IConstruct, IDependable, IInspectable

Remarks

The AWS::Macie::FindingsFilter resource represents an individual findings filter that you create and save to view, analyze, and manage findings. A findings filter is a set of criteria that specifies which findings to include in the results of a query for findings. A findings filter can also perform specific actions on findings that meet the filter's criteria.

A Session must exist for the account before you can create a FindingsFilter . Use a DependsOn attribute to ensure that the Session is created before the other resources. 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 criterion;

CfnFindingsFilter cfnFindingsFilter = new CfnFindingsFilter(this, "MyCfnFindingsFilter", new CfnFindingsFilterProps {
    FindingCriteria = new FindingCriteriaProperty {
        Criterion = criterion
    },
    Name = "name",

    // the properties below are optional
    Action = "action",
    Description = "description",
    Position = 123
});

Synopsis

Constructors

CfnFindingsFilter(Construct, String, ICfnFindingsFilterProps)	Create a new `AWS::Macie::FindingsFilter`.
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 meet the filter criteria ( `FindingCriteria` ). Valid values are:.
AttrArn	The Amazon Resource Name (ARN) of the filter.
AttrFindingsFilterListItems	An array of `FindingsFilterListItem` objects, one for each findings filter that's associated with the account.
AttrId	The unique identifier for the filter.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties
Description	A custom description of the filter. The description can contain as many as 512 characters.
FindingCriteria	The criteria to use to filter findings.
Name	A custom name for the filter.
Position	The position of the 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 meet the filter criteria ( FindingCriteria ). Valid values are:.

public virtual string Action { get; set; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-findingsfilter.html#cfn-macie-findingsfilter-action

AttrArn

The Amazon Resource Name (ARN) of the filter.

public virtual string AttrArn { get; }

Property Value

System.String

Remarks

CloudformationAttribute: Arn

AttrFindingsFilterListItems

An array of FindingsFilterListItem objects, one for each findings filter that's associated with the account.

public virtual IResolvable AttrFindingsFilterListItems { get; }

Property Value

IResolvable

Remarks

CloudformationAttribute: FindingsFilterListItems

AttrId

The unique identifier for the 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

CfnResource.CfnProperties

Description

A custom description of the filter. The description can contain as many as 512 characters.

public virtual string Description { get; set; }

Property Value

System.String

Remarks

We strongly recommend that you avoid including any sensitive data in the description of a filter. Other users might be able to see the filter's description, depending on the actions that they're allowed to perform in Amazon Macie .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-findingsfilter.html#cfn-macie-findingsfilter-description

FindingCriteria

The criteria to use to filter findings.

public virtual object FindingCriteria { get; set; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-findingsfilter.html#cfn-macie-findingsfilter-findingcriteria

Name

A custom name for the filter.

public virtual string Name { get; set; }

Property Value

System.String

Remarks

The name must contain at least 3 characters and can contain as many as 64 characters.

We strongly recommend that you avoid including any sensitive data in the name of a filter. Other users might be able to see the filter's name, depending on the actions that they're allowed to perform in Amazon Macie .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-findingsfilter.html#cfn-macie-findingsfilter-name

Position

The position of the 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 the findings.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-macie-findingsfilter.html#cfn-macie-findingsfilter-position

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>

Overrides

CfnResource.RenderProperties(IDictionary<String, Object>)

Implements

IConstruct

Constructs.IConstruct

IDependable

IInspectable