Package software.amazon.awscdk.services.inspectorv2

Class CfnFilter

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.inspectorv2.CfnFilter

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.110.0 (build 336b265)",
           date="2025-04-22T23:08:14.573Z")
@Stability(Stable)
public class CfnFilter
extends CfnResource
implements IInspectable

Details about a filter.

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.inspectorv2.*;
 CfnFilter cfnFilter = CfnFilter.Builder.create(this, "MyCfnFilter")
         .filterAction("filterAction")
         .filterCriteria(FilterCriteriaProperty.builder()
                 .awsAccountId(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .componentId(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .componentType(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .ec2InstanceImageId(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .ec2InstanceSubnetId(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .ec2InstanceVpcId(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .ecrImageArchitecture(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .ecrImageHash(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .ecrImagePushedAt(List.of(DateFilterProperty.builder()
                         .endInclusive(123)
                         .startInclusive(123)
                         .build()))
                 .ecrImageRegistry(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .ecrImageRepositoryName(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .ecrImageTags(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .findingArn(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .findingStatus(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .findingType(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .firstObservedAt(List.of(DateFilterProperty.builder()
                         .endInclusive(123)
                         .startInclusive(123)
                         .build()))
                 .inspectorScore(List.of(NumberFilterProperty.builder()
                         .lowerInclusive(123)
                         .upperInclusive(123)
                         .build()))
                 .lastObservedAt(List.of(DateFilterProperty.builder()
                         .endInclusive(123)
                         .startInclusive(123)
                         .build()))
                 .networkProtocol(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .portRange(List.of(PortRangeFilterProperty.builder()
                         .beginInclusive(123)
                         .endInclusive(123)
                         .build()))
                 .relatedVulnerabilities(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .resourceId(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .resourceTags(List.of(MapFilterProperty.builder()
                         .comparison("comparison")
                         // the properties below are optional
                         .key("key")
                         .value("value")
                         .build()))
                 .resourceType(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .severity(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .title(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .updatedAt(List.of(DateFilterProperty.builder()
                         .endInclusive(123)
                         .startInclusive(123)
                         .build()))
                 .vendorSeverity(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .vulnerabilityId(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .vulnerabilitySource(List.of(StringFilterProperty.builder()
                         .comparison("comparison")
                         .value("value")
                         .build()))
                 .vulnerablePackages(List.of(PackageFilterProperty.builder()
                         .architecture(StringFilterProperty.builder()
                                 .comparison("comparison")
                                 .value("value")
                                 .build())
                         .epoch(NumberFilterProperty.builder()
                                 .lowerInclusive(123)
                                 .upperInclusive(123)
                                 .build())
                         .name(StringFilterProperty.builder()
                                 .comparison("comparison")
                                 .value("value")
                                 .build())
                         .release(StringFilterProperty.builder()
                                 .comparison("comparison")
                                 .value("value")
                                 .build())
                         .sourceLayerHash(StringFilterProperty.builder()
                                 .comparison("comparison")
                                 .value("value")
                                 .build())
                         .version(StringFilterProperty.builder()
                                 .comparison("comparison")
                                 .value("value")
                                 .build())
                         .build()))
                 .build())
         .name("name")
         // the properties below are optional
         .description("description")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-inspectorv2-filter.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnFilter.Builder	A fluent builder for CfnFilter.
static interface	CfnFilter.DateFilterProperty	Contains details on the time range used to filter findings.
static interface	CfnFilter.FilterCriteriaProperty	Details on the criteria used to define the filter.
static interface	CfnFilter.MapFilterProperty	An object that describes details of a map filter.
static interface	CfnFilter.NumberFilterProperty	An object that describes the details of a number filter.
static interface	CfnFilter.PackageFilterProperty	Contains information on the details of a package filter.
static interface	CfnFilter.PortRangeFilterProperty	An object that describes the details of a port range filter.
static interface	CfnFilter.StringFilterProperty	An object that describes the details of a string filter.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnFilter(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnFilter(software.amazon.jsii.JsiiObjectRef objRef)
	CfnFilter(software.constructs.Construct scope, String id, CfnFilterProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrArn()	The Amazon Resource Number (ARN) associated with this filter.
protected Map<String,Object>	getCfnProperties()
String	getDescription()	A description of the filter.
String	getFilterAction()	The action that is to be applied to the findings that match the filter.
Object	getFilterCriteria()	Details on the filter criteria associated with this filter.
String	getName()	The name of the filter.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value)	A description of the filter.
void	setFilterAction(String value)	The action that is to be applied to the findings that match the filter.
void	setFilterCriteria(IResolvable value)	Details on the filter criteria associated with this filter.
void	setFilterCriteria(CfnFilter.FilterCriteriaProperty value)	Details on the filter criteria associated with this filter.
void	setName(String value)	The name of the filter.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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

@Stability(Stable)
public static final String 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
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnFilterProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(Stable)
@NotNull
public String getAttrArn()

The Amazon Resource Number (ARN) associated with this filter.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getFilterAction

@Stability(Stable)
@NotNull
public String getFilterAction()

The action that is to be applied to the findings that match the filter.

setFilterAction

@Stability(Stable)
public void setFilterAction(@NotNull
 String value)

The action that is to be applied to the findings that match the filter.

getFilterCriteria

@Stability(Stable)
@NotNull
public Object getFilterCriteria()

Details on the filter criteria associated with this filter.

setFilterCriteria

@Stability(Stable)
public void setFilterCriteria(@NotNull
 IResolvable value)

Details on the filter criteria associated with this filter.

setFilterCriteria

@Stability(Stable)
public void setFilterCriteria(@NotNull
 CfnFilter.FilterCriteriaProperty value)

Details on the filter criteria associated with this filter.

getName

@Stability(Stable)
@NotNull
public String getName()

The name of the filter.

setName

@Stability(Stable)
public void setName(@NotNull
 String value)

The name of the filter.

getDescription

@Stability(Stable)
@Nullable
public String getDescription()

A description of the filter.

setDescription

@Stability(Stable)
public void setDescription(@Nullable
 String value)

A description of the filter.