Class CfnFilter
- All Implemented Interfaces:
IConstruct
,IDependable
,IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
AWS::GuardDuty::Filter
.
The AWS::GuardDuty::Filter
resource specifies a new filter defined by the provided findingCriteria
.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.guardduty.*; Object criterion; CfnFilter cfnFilter = CfnFilter.Builder.create(this, "MyCfnFilter") .action("action") .description("description") .detectorId("detectorId") .findingCriteria(FindingCriteriaProperty.builder() .criterion(criterion) .itemType(ConditionProperty.builder() .eq(List.of("eq")) .equalTo(List.of("equalTo")) .greaterThan(123) .greaterThanOrEqual(123) .gt(123) .gte(123) .lessThan(123) .lessThanOrEqual(123) .lt(123) .lte(123) .neq(List.of("neq")) .notEquals(List.of("notEquals")) .build()) .build()) .name("name") .rank(123) // the properties below are optional .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
A fluent builder forCfnFilter
.static interface
Specifies the condition to apply to a single field when filtering through GuardDuty findings.static interface
Represents a map of finding properties that match specified conditions and values when querying findings.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionSpecifies the action that is to be applied to the findings that match the filter.The description of the filter.The ID of the detector belonging to the GuardDuty account that you want to create a filter for.Represents the criteria to be used in the filter for querying findings.getName()
The name of the filter.getRank()
Specifies the position of the filter in the list of current filters.getTags()
The tags to be added to a new filter resource.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
Specifies the action that is to be applied to the findings that match the filter.void
setDescription
(String value) The description of the filter.void
setDetectorId
(String value) The ID of the detector belonging to the GuardDuty account that you want to create a filter for.void
setFindingCriteria
(IResolvable value) Represents the criteria to be used in the filter for querying findings.void
Represents the criteria to be used in the filter for querying findings.void
The name of the filter.void
Specifies the position of the filter in the list of current filters.Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnFilter
protected CfnFilter(software.amazon.jsii.JsiiObjectRef objRef) -
CfnFilter
protected CfnFilter(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnFilter
@Stability(Stable) public CfnFilter(@NotNull Construct scope, @NotNull String id, @NotNull CfnFilterProps props) Create a newAWS::GuardDuty::Filter
.- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
props
-- resource properties.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
-- tree inspector to collect and process attributes.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
The tags to be added to a new filter resource.Each tag consists of a key and an optional value, both of which you define.
For more information, see Tag .
-
getAction
Specifies the action that is to be applied to the findings that match the filter. -
setAction
Specifies the action that is to be applied to the findings that match the filter. -
getDescription
The description of the filter.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. -
setDescription
The description of the filter.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. -
getDetectorId
The ID of the detector belonging to the GuardDuty account that you want to create a filter for. -
setDetectorId
The ID of the detector belonging to the GuardDuty account that you want to create a filter for. -
getFindingCriteria
Represents the criteria to be used in the filter for querying findings. -
setFindingCriteria
Represents the criteria to be used in the filter for querying findings. -
setFindingCriteria
Represents the criteria to be used in the filter for querying findings. -
getName
The name of the filter.Valid characters include period (.), underscore (_), dash (-), and alphanumeric characters. A whitespace is considered to be an invalid character.
-
setName
The name of the filter.Valid characters include period (.), underscore (_), dash (-), and alphanumeric characters. A whitespace is considered to be an invalid character.
-
getRank
Specifies the position of the filter in the list of current filters.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" ]
. -
setRank
Specifies the position of the filter in the list of current filters.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" ]
.
-