@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)", date="2023-01-31T18:36:48.817Z") public class CfnFindingsFilter extends CfnResource implements IInspectable
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"
.
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.macie.*; CfnFindingsFilter cfnFindingsFilter = CfnFindingsFilter.Builder.create(this, "MyCfnFindingsFilter") .findingCriteria(FindingCriteriaProperty.builder() .criterion(Map.of( "criterionKey", CriterionAdditionalPropertiesProperty.builder() .eq(List.of("eq")) .gt(123) .gte(123) .lt(123) .lte(123) .neq(List.of("neq")) .build())) .build()) .name("name") // the properties below are optional .action("action") .description("description") .position(123) .build();
Modifier and Type | Class and Description |
---|---|
static class |
CfnFindingsFilter.Builder
A fluent builder for
CfnFindingsFilter . |
static interface |
CfnFindingsFilter.CriterionAdditionalPropertiesProperty
Example:
|
static interface |
CfnFindingsFilter.FindingCriteriaProperty
Specifies, as a map, one or more property-based conditions that filter the results of a query for findings.
|
static interface |
CfnFindingsFilter.FindingsFilterListItemProperty
Specifies the unique identifier and custom name of a findings filter.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnFindingsFilter(Construct scope,
java.lang.String id,
CfnFindingsFilterProps props)
Create a new `AWS::Macie::FindingsFilter`.
|
protected |
CfnFindingsFilter(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnFindingsFilter(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAction()
The action to perform on findings that match the filter criteria ( `FindingCriteria` ).
|
java.lang.String |
getAttrArn()
The Amazon Resource Name (ARN) of the findings filter.
|
IResolvable |
getAttrFindingsFilterListItems()
An array of `FindingsFilterListItem` objects, one for each findings filter that's associated with the account.
|
java.lang.String |
getAttrId()
The unique identifier for the findings filter.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getDescription()
A custom description of the findings filter.
|
java.lang.Object |
getFindingCriteria()
The criteria to use to filter findings.
|
java.lang.String |
getName()
A custom name for the findings filter.
|
java.lang.Number |
getPosition()
The position of the findings filter in the list of saved filters on the Amazon Macie console.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setAction(java.lang.String value)
The action to perform on findings that match the filter criteria ( `FindingCriteria` ).
|
void |
setDescription(java.lang.String value)
A custom description of the findings filter.
|
void |
setFindingCriteria(CfnFindingsFilter.FindingCriteriaProperty value)
The criteria to use to filter findings.
|
void |
setFindingCriteria(IResolvable value)
The criteria to use to filter findings.
|
void |
setName(java.lang.String value)
A custom name for the findings filter.
|
void |
setPosition(java.lang.Number value)
The position of the findings filter in the list of saved filters on the Amazon Macie console.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnFindingsFilter(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnFindingsFilter(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnFindingsFilter(Construct scope, java.lang.String id, CfnFindingsFilterProps props)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.props
- - resource properties. This parameter is required.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrArn()
public IResolvable getAttrFindingsFilterListItems()
public java.lang.String getAttrId()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.Object getFindingCriteria()
public void setFindingCriteria(IResolvable value)
public void setFindingCriteria(CfnFindingsFilter.FindingCriteriaProperty value)
public java.lang.String getName()
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 .
public void setName(java.lang.String value)
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 .
public java.lang.String getAction()
ARCHIVE
- Suppress (automatically archive) the findings.NOOP
- Don't perform any action on the findings.public void setAction(java.lang.String value)
ARCHIVE
- Suppress (automatically archive) the findings.NOOP
- Don't perform any action on the findings.public java.lang.String getDescription()
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 .
public void setDescription(java.lang.String value)
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 .
public java.lang.Number getPosition()
This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to findings.
public void setPosition(java.lang.Number value)
This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to findings.