@Generated(value="jsii-pacmak/1.60.0 (build ebcefe6)", date="2022-06-22T23:27:51.659Z") public class CfnFindingsFilter extends CfnResource implements IInspectable
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"
.
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.*; Object criterion; CfnFindingsFilter cfnFindingsFilter = CfnFindingsFilter.Builder.create(this, "MyCfnFindingsFilter") .findingCriteria(FindingCriteriaProperty.builder() .criterion(criterion) .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.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 meet the filter criteria ( `FindingCriteria` ).
|
java.lang.String |
getAttrArn()
The Amazon Resource Name (ARN) of the 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 filter.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getDescription()
A custom description of the filter.
|
java.lang.Object |
getFindingCriteria()
The criteria to use to filter findings.
|
java.lang.String |
getName()
A custom name for the filter.
|
java.lang.Number |
getPosition()
The position of the 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 meet the filter criteria ( `FindingCriteria` ).
|
void |
setDescription(java.lang.String value)
A custom description of the 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 filter.
|
void |
setPosition(java.lang.Number value)
The position of the 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(CfnFindingsFilter.FindingCriteriaProperty value)
public void setFindingCriteria(IResolvable value)
public java.lang.String getName()
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 .
public void setName(java.lang.String value)
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 .
public java.lang.String getAction()
public void setAction(java.lang.String value)
public java.lang.String getDescription()
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 .
public void setDescription(java.lang.String value)
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 .
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 the 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 the findings.