Class CfnFilter
A CloudFormation AWS::GuardDuty::Filter
.
Inherited Members
Namespace: Amazon.CDK.AWS.GuardDuty
Assembly: Amazon.CDK.AWS.GuardDuty.dll
Syntax (csharp)
public class CfnFilter : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnFilter
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::GuardDuty::Filter
resource specifies a new filter defined by the provided findingCriteria
.
CloudformationResource: AWS::GuardDuty::Filter
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-filter.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.GuardDuty;
var criterion;
var cfnFilter = new CfnFilter(this, "MyCfnFilter", new CfnFilterProps {
Action = "action",
Description = "description",
DetectorId = "detectorId",
FindingCriteria = new FindingCriteriaProperty {
Criterion = criterion,
ItemType = new ConditionProperty {
Eq = new [] { "eq" },
EqualTo = new [] { "equalTo" },
GreaterThan = 123,
GreaterThanOrEqual = 123,
Gt = 123,
Gte = 123,
LessThan = 123,
LessThanOrEqual = 123,
Lt = 123,
Lte = 123,
Neq = new [] { "neq" },
NotEquals = new [] { "notEquals" }
}
},
Name = "name",
Rank = 123,
// the properties below are optional
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnFilter(Construct, String, ICfnFilterProps) | Create a new |
CfnFilter(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnFilter(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
Action | Specifies the action that is to be applied to the findings that match the filter. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Description | The description of the filter. |
DetectorId | The ID of the detector belonging to the GuardDuty account that you want to create a filter for. |
FindingCriteria | Represents the criteria to be used in the filter for querying findings. |
Name | The name of the filter. |
Rank | Specifies the position of the filter in the list of current filters. |
Tags | The tags to be added to a new filter resource. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnFilter(Construct, String, ICfnFilterProps)
Create a new AWS::GuardDuty::Filter
.
public CfnFilter(Construct scope, string id, ICfnFilterProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnFilterProps
- resource properties.
CfnFilter(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnFilter(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnFilter(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnFilter(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
Action
Specifies the action that is to be applied to the findings that match the filter.
public virtual string Action { get; set; }
Property Value
System.String
Remarks
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
The description of the filter.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
Valid characters include alphanumeric characters, and special characters such as hyphen, period, colon, underscore, parentheses ( { }
, [ ]
, and ( )
), forward slash, horizontal tab, vertical tab, newline, form feed, return, and whitespace.
DetectorId
The ID of the detector belonging to the GuardDuty account that you want to create a filter for.
public virtual string DetectorId { get; set; }
Property Value
System.String
Remarks
FindingCriteria
Represents the criteria to be used in the filter for querying findings.
public virtual object FindingCriteria { get; set; }
Property Value
System.Object
Remarks
Name
The name of the filter.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
Valid characters include period (.), underscore (_), dash (-), and alphanumeric characters. A whitespace is considered to be an invalid character.
Rank
Specifies the position of the filter in the list of current filters.
public virtual double Rank { get; set; }
Property Value
System.Double
Remarks
Also specifies the order in which this filter is applied to the findings. The minimum value for this property is 1 and the maximum is 100.
By default, filters may not be created in the same order as they are ranked. To ensure that the filters are created in the expected order, you can use an optional attribute, DependsOn , with the following syntax: "DependsOn":[ "ObjectName" ]
.
Tags
The tags to be added to a new filter resource.
public virtual TagManager Tags { get; }
Property Value
Remarks
Each tag consists of a key and an optional value, both of which you define.
For more information, see Tag .
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>