CfnAutomationRuleV2PropsMixin
- class aws_cdk.mixins_preview.aws_securityhub.mixins.CfnAutomationRuleV2PropsMixin(props, *, strategy=None)
Bases:
MixinCreates a V2 automation rule.
This API is in public preview and subject to change.
- See:
- CloudformationResource:
AWS::SecurityHub::AutomationRuleV2
- Mixin:
true
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview import mixins from aws_cdk.mixins_preview.aws_securityhub import mixins as securityhub_mixins cfn_automation_rule_v2_props_mixin = securityhub_mixins.CfnAutomationRuleV2PropsMixin(securityhub_mixins.CfnAutomationRuleV2MixinProps( actions=[securityhub_mixins.CfnAutomationRuleV2PropsMixin.AutomationRulesActionV2Property( external_integration_configuration=securityhub_mixins.CfnAutomationRuleV2PropsMixin.ExternalIntegrationConfigurationProperty( connector_arn="connectorArn" ), finding_fields_update=securityhub_mixins.CfnAutomationRuleV2PropsMixin.AutomationRulesFindingFieldsUpdateV2Property( comment="comment", severity_id=123, status_id=123 ), type="type" )], criteria=securityhub_mixins.CfnAutomationRuleV2PropsMixin.CriteriaProperty( ocsf_finding_criteria=securityhub_mixins.CfnAutomationRuleV2PropsMixin.OcsfFindingFiltersProperty( composite_filters=[securityhub_mixins.CfnAutomationRuleV2PropsMixin.CompositeFilterProperty( boolean_filters=[securityhub_mixins.CfnAutomationRuleV2PropsMixin.OcsfBooleanFilterProperty( field_name="fieldName", filter=securityhub_mixins.CfnAutomationRuleV2PropsMixin.BooleanFilterProperty( value=False ) )], date_filters=[securityhub_mixins.CfnAutomationRuleV2PropsMixin.OcsfDateFilterProperty( field_name="fieldName", filter=securityhub_mixins.CfnAutomationRuleV2PropsMixin.DateFilterProperty( date_range=securityhub_mixins.CfnAutomationRuleV2PropsMixin.DateRangeProperty( unit="unit", value=123 ), end="end", start="start" ) )], map_filters=[securityhub_mixins.CfnAutomationRuleV2PropsMixin.OcsfMapFilterProperty( field_name="fieldName", filter=securityhub_mixins.CfnAutomationRuleV2PropsMixin.MapFilterProperty( comparison="comparison", key="key", value="value" ) )], number_filters=[securityhub_mixins.CfnAutomationRuleV2PropsMixin.OcsfNumberFilterProperty( field_name="fieldName", filter=securityhub_mixins.CfnAutomationRuleV2PropsMixin.NumberFilterProperty( eq=123, gte=123, lte=123 ) )], operator="operator", string_filters=[securityhub_mixins.CfnAutomationRuleV2PropsMixin.OcsfStringFilterProperty( field_name="fieldName", filter=securityhub_mixins.CfnAutomationRuleV2PropsMixin.StringFilterProperty( comparison="comparison", value="value" ) )] )], composite_operator="compositeOperator" ) ), description="description", rule_name="ruleName", rule_order=123, rule_status="ruleStatus", tags={ "tags_key": "tags" } ), strategy=mixins.PropertyMergeStrategy.OVERRIDE )
Create a mixin to apply properties to
AWS::SecurityHub::AutomationRuleV2.- Parameters:
props (
Union[CfnAutomationRuleV2MixinProps,Dict[str,Any]]) – L1 properties to apply.strategy (
Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE
Methods
- apply_to(construct)
Apply the mixin properties to the construct.
- Parameters:
construct (
IConstruct)- Return type:
- supports(construct)
Check if this mixin supports the given construct.
- Parameters:
construct (
IConstruct)- Return type:
bool
Attributes
- CFN_PROPERTY_KEYS = ['actions', 'criteria', 'description', 'ruleName', 'ruleOrder', 'ruleStatus', 'tags']
Static Methods
- classmethod is_mixin(x)
(experimental) Checks if
xis a Mixin.- Parameters:
x (
Any) – Any object.- Return type:
bool- Returns:
true if
xis an object created from a class which extendsMixin.- Stability:
experimental
AutomationRulesActionV2Property
- class CfnAutomationRuleV2PropsMixin.AutomationRulesActionV2Property(*, external_integration_configuration=None, finding_fields_update=None, type=None)
Bases:
objectAllows you to configure automated responses.
- Parameters:
external_integration_configuration (
Union[IResolvable,ExternalIntegrationConfigurationProperty,Dict[str,Any],None]) – The settings for integrating automation rule actions with external systems or service.finding_fields_update (
Union[IResolvable,AutomationRulesFindingFieldsUpdateV2Property,Dict[str,Any],None]) – Specifies that the automation rule action is an update to a finding field.type (
Optional[str]) – Specifies the type of action that Security Hub takes when a finding matches the defined criteria of a rule.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_securityhub import mixins as securityhub_mixins automation_rules_action_v2_property = securityhub_mixins.CfnAutomationRuleV2PropsMixin.AutomationRulesActionV2Property( external_integration_configuration=securityhub_mixins.CfnAutomationRuleV2PropsMixin.ExternalIntegrationConfigurationProperty( connector_arn="connectorArn" ), finding_fields_update=securityhub_mixins.CfnAutomationRuleV2PropsMixin.AutomationRulesFindingFieldsUpdateV2Property( comment="comment", severity_id=123, status_id=123 ), type="type" )
Attributes
- external_integration_configuration
The settings for integrating automation rule actions with external systems or service.
- finding_fields_update
Specifies that the automation rule action is an update to a finding field.
- type
Specifies the type of action that Security Hub takes when a finding matches the defined criteria of a rule.
AutomationRulesFindingFieldsUpdateV2Property
- class CfnAutomationRuleV2PropsMixin.AutomationRulesFindingFieldsUpdateV2Property(*, comment=None, severity_id=None, status_id=None)
Bases:
objectAllows you to define the structure for modifying specific fields in security findings.
- Parameters:
comment (
Optional[str]) – Notes or contextual information for findings that are modified by the automation rule.severity_id (
Union[int,float,None]) – The severity level to be assigned to findings that match the automation rule criteria.status_id (
Union[int,float,None]) – The status to be applied to findings that match automation rule criteria.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_securityhub import mixins as securityhub_mixins automation_rules_finding_fields_update_v2_property = securityhub_mixins.CfnAutomationRuleV2PropsMixin.AutomationRulesFindingFieldsUpdateV2Property( comment="comment", severity_id=123, status_id=123 )
Attributes
- comment
Notes or contextual information for findings that are modified by the automation rule.
- severity_id
The severity level to be assigned to findings that match the automation rule criteria.
- status_id
The status to be applied to findings that match automation rule criteria.
BooleanFilterProperty
- class CfnAutomationRuleV2PropsMixin.BooleanFilterProperty(*, value=None)
Bases:
objectBoolean filter for querying findings.
- Parameters:
value (
Union[bool,IResolvable,None]) – The value of the boolean.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_securityhub import mixins as securityhub_mixins boolean_filter_property = securityhub_mixins.CfnAutomationRuleV2PropsMixin.BooleanFilterProperty( value=False )
Attributes
CompositeFilterProperty
- class CfnAutomationRuleV2PropsMixin.CompositeFilterProperty(*, boolean_filters=None, date_filters=None, map_filters=None, number_filters=None, operator=None, string_filters=None)
Bases:
objectEnables the creation of filtering criteria for security findings.
- Parameters:
boolean_filters (
Union[IResolvable,Sequence[Union[IResolvable,OcsfBooleanFilterProperty,Dict[str,Any]]],None]) – Enables filtering based on boolean field values.date_filters (
Union[IResolvable,Sequence[Union[IResolvable,OcsfDateFilterProperty,Dict[str,Any]]],None]) – Enables filtering based on date and timestamp fields.map_filters (
Union[IResolvable,Sequence[Union[IResolvable,OcsfMapFilterProperty,Dict[str,Any]]],None]) – Enables the creation of filtering criteria for security findings.number_filters (
Union[IResolvable,Sequence[Union[IResolvable,OcsfNumberFilterProperty,Dict[str,Any]]],None]) – Enables filtering based on numerical field values.operator (
Optional[str]) – The logical operator used to combine multiple filter conditions.string_filters (
Union[IResolvable,Sequence[Union[IResolvable,OcsfStringFilterProperty,Dict[str,Any]]],None]) – Enables filtering based on string field values.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_securityhub import mixins as securityhub_mixins composite_filter_property = securityhub_mixins.CfnAutomationRuleV2PropsMixin.CompositeFilterProperty( boolean_filters=[securityhub_mixins.CfnAutomationRuleV2PropsMixin.OcsfBooleanFilterProperty( field_name="fieldName", filter=securityhub_mixins.CfnAutomationRuleV2PropsMixin.BooleanFilterProperty( value=False ) )], date_filters=[securityhub_mixins.CfnAutomationRuleV2PropsMixin.OcsfDateFilterProperty( field_name="fieldName", filter=securityhub_mixins.CfnAutomationRuleV2PropsMixin.DateFilterProperty( date_range=securityhub_mixins.CfnAutomationRuleV2PropsMixin.DateRangeProperty( unit="unit", value=123 ), end="end", start="start" ) )], map_filters=[securityhub_mixins.CfnAutomationRuleV2PropsMixin.OcsfMapFilterProperty( field_name="fieldName", filter=securityhub_mixins.CfnAutomationRuleV2PropsMixin.MapFilterProperty( comparison="comparison", key="key", value="value" ) )], number_filters=[securityhub_mixins.CfnAutomationRuleV2PropsMixin.OcsfNumberFilterProperty( field_name="fieldName", filter=securityhub_mixins.CfnAutomationRuleV2PropsMixin.NumberFilterProperty( eq=123, gte=123, lte=123 ) )], operator="operator", string_filters=[securityhub_mixins.CfnAutomationRuleV2PropsMixin.OcsfStringFilterProperty( field_name="fieldName", filter=securityhub_mixins.CfnAutomationRuleV2PropsMixin.StringFilterProperty( comparison="comparison", value="value" ) )] )
Attributes
- boolean_filters
Enables filtering based on boolean field values.
- date_filters
Enables filtering based on date and timestamp fields.
- map_filters
Enables the creation of filtering criteria for security findings.
- number_filters
Enables filtering based on numerical field values.
- operator
The logical operator used to combine multiple filter conditions.
- string_filters
Enables filtering based on string field values.
CriteriaProperty
- class CfnAutomationRuleV2PropsMixin.CriteriaProperty(*, ocsf_finding_criteria=None)
Bases:
objectThe filtering type and configuration of the automation rule.
- Parameters:
ocsf_finding_criteria (
Union[IResolvable,OcsfFindingFiltersProperty,Dict[str,Any],None]) – The filtering conditions that align with OCSF standards.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_securityhub import mixins as securityhub_mixins criteria_property = securityhub_mixins.CfnAutomationRuleV2PropsMixin.CriteriaProperty( ocsf_finding_criteria=securityhub_mixins.CfnAutomationRuleV2PropsMixin.OcsfFindingFiltersProperty( composite_filters=[securityhub_mixins.CfnAutomationRuleV2PropsMixin.CompositeFilterProperty( boolean_filters=[securityhub_mixins.CfnAutomationRuleV2PropsMixin.OcsfBooleanFilterProperty( field_name="fieldName", filter=securityhub_mixins.CfnAutomationRuleV2PropsMixin.BooleanFilterProperty( value=False ) )], date_filters=[securityhub_mixins.CfnAutomationRuleV2PropsMixin.OcsfDateFilterProperty( field_name="fieldName", filter=securityhub_mixins.CfnAutomationRuleV2PropsMixin.DateFilterProperty( date_range=securityhub_mixins.CfnAutomationRuleV2PropsMixin.DateRangeProperty( unit="unit", value=123 ), end="end", start="start" ) )], map_filters=[securityhub_mixins.CfnAutomationRuleV2PropsMixin.OcsfMapFilterProperty( field_name="fieldName", filter=securityhub_mixins.CfnAutomationRuleV2PropsMixin.MapFilterProperty( comparison="comparison", key="key", value="value" ) )], number_filters=[securityhub_mixins.CfnAutomationRuleV2PropsMixin.OcsfNumberFilterProperty( field_name="fieldName", filter=securityhub_mixins.CfnAutomationRuleV2PropsMixin.NumberFilterProperty( eq=123, gte=123, lte=123 ) )], operator="operator", string_filters=[securityhub_mixins.CfnAutomationRuleV2PropsMixin.OcsfStringFilterProperty( field_name="fieldName", filter=securityhub_mixins.CfnAutomationRuleV2PropsMixin.StringFilterProperty( comparison="comparison", value="value" ) )] )], composite_operator="compositeOperator" ) )
Attributes
- ocsf_finding_criteria
The filtering conditions that align with OCSF standards.
DateFilterProperty
- class CfnAutomationRuleV2PropsMixin.DateFilterProperty(*, date_range=None, end=None, start=None)
Bases:
objectA date filter for querying findings.
- Parameters:
date_range (
Union[IResolvable,DateRangeProperty,Dict[str,Any],None]) – A date range for the date filter.end (
Optional[str]) – A timestamp that provides the end date for the date filter. For more information about the validation and formatting of timestamp fields in Security Hub , see Timestamps .start (
Optional[str]) –A timestamp that provides the start date for the date filter. For more information about the validation and formatting of timestamp fields in Security Hub , see Timestamps .
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_securityhub import mixins as securityhub_mixins date_filter_property = securityhub_mixins.CfnAutomationRuleV2PropsMixin.DateFilterProperty( date_range=securityhub_mixins.CfnAutomationRuleV2PropsMixin.DateRangeProperty( unit="unit", value=123 ), end="end", start="start" )
Attributes
- date_range
A date range for the date filter.
- end
A timestamp that provides the end date for the date filter.
For more information about the validation and formatting of timestamp fields in Security Hub , see Timestamps .
- start
A timestamp that provides the start date for the date filter.
For more information about the validation and formatting of timestamp fields in Security Hub , see Timestamps .
DateRangeProperty
- class CfnAutomationRuleV2PropsMixin.DateRangeProperty(*, unit=None, value=None)
Bases:
objectA date range for the date filter.
- Parameters:
unit (
Optional[str]) – A date range unit for the date filter.value (
Union[int,float,None]) – A date range value for the date filter.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_securityhub import mixins as securityhub_mixins date_range_property = securityhub_mixins.CfnAutomationRuleV2PropsMixin.DateRangeProperty( unit="unit", value=123 )
Attributes
- unit
A date range unit for the date filter.
- value
A date range value for the date filter.
ExternalIntegrationConfigurationProperty
- class CfnAutomationRuleV2PropsMixin.ExternalIntegrationConfigurationProperty(*, connector_arn=None)
Bases:
objectThe settings for integrating automation rule actions with external systems or service.
- Parameters:
connector_arn (
Optional[str]) – The ARN of the connector that establishes the integration.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_securityhub import mixins as securityhub_mixins external_integration_configuration_property = securityhub_mixins.CfnAutomationRuleV2PropsMixin.ExternalIntegrationConfigurationProperty( connector_arn="connectorArn" )
Attributes
- connector_arn
The ARN of the connector that establishes the integration.
MapFilterProperty
- class CfnAutomationRuleV2PropsMixin.MapFilterProperty(*, comparison=None, key=None, value=None)
Bases:
objectA map filter for filtering Security Hub findings.
Each map filter provides the field to check for, the value to check for, and the comparison operator.
- Parameters:
comparison (
Optional[str]) – The condition to apply to the key value when filtering Security Hub findings with a map filter. To search for values that have the filter value, use one of the following comparison operators: - To search for values that include the filter value, useCONTAINS. For example, for theResourceTagsfield, the filterDepartment CONTAINS Securitymatches findings that include the valueSecurityfor theDepartmenttag. In the same example, a finding with a value ofSecurity teamfor theDepartmenttag is a match. - To search for values that exactly match the filter value, useEQUALS. For example, for theResourceTagsfield, the filterDepartment EQUALS Securitymatches findings that have the valueSecurityfor theDepartmenttag.CONTAINSandEQUALSfilters on the same field are joined byOR. A finding matches if it matches any one of those filters. For example, the filtersDepartment CONTAINS Security OR Department CONTAINS Financematch a finding that includes eitherSecurity,Finance, or both values. To search for values that don’t have the filter value, use one of the following comparison operators: - To search for values that exclude the filter value, useNOT_CONTAINS. For example, for theResourceTagsfield, the filterDepartment NOT_CONTAINS Financematches findings that exclude the valueFinancefor theDepartmenttag. - To search for values other than the filter value, useNOT_EQUALS. For example, for theResourceTagsfield, the filterDepartment NOT_EQUALS Financematches findings that don’t have the valueFinancefor theDepartmenttag.NOT_CONTAINSandNOT_EQUALSfilters on the same field are joined byAND. A finding matches only if it matches all of those filters. For example, the filtersDepartment NOT_CONTAINS Security AND Department NOT_CONTAINS Financematch a finding that excludes both theSecurityandFinancevalues.CONTAINSfilters can only be used with otherCONTAINSfilters.NOT_CONTAINSfilters can only be used with otherNOT_CONTAINSfilters. You can’t have both aCONTAINSfilter and aNOT_CONTAINSfilter on the same field. Similarly, you can’t have both anEQUALSfilter and aNOT_EQUALSfilter on the same field. Combining filters in this way returns an error.CONTAINSandNOT_CONTAINSoperators can be used only with automation rules. For more information, see Automation rules in the Security Hub User Guide .key (
Optional[str]) – The key of the map filter. For example, forResourceTags,Keyidentifies the name of the tag. ForUserDefinedFields,Keyis the name of the field.value (
Optional[str]) – The value for the key in the map filter. Filter values are case sensitive. For example, one of the values for a tag calledDepartmentmight beSecurity. If you providesecurityas the filter value, then there’s no match.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_securityhub import mixins as securityhub_mixins map_filter_property = securityhub_mixins.CfnAutomationRuleV2PropsMixin.MapFilterProperty( comparison="comparison", key="key", value="value" )
Attributes
- comparison
The condition to apply to the key value when filtering Security Hub findings with a map filter.
To search for values that have the filter value, use one of the following comparison operators:
To search for values that include the filter value, use
CONTAINS. For example, for theResourceTagsfield, the filterDepartment CONTAINS Securitymatches findings that include the valueSecurityfor theDepartmenttag. In the same example, a finding with a value ofSecurity teamfor theDepartmenttag is a match.To search for values that exactly match the filter value, use
EQUALS. For example, for theResourceTagsfield, the filterDepartment EQUALS Securitymatches findings that have the valueSecurityfor theDepartmenttag.
CONTAINSandEQUALSfilters on the same field are joined byOR. A finding matches if it matches any one of those filters. For example, the filtersDepartment CONTAINS Security OR Department CONTAINS Financematch a finding that includes eitherSecurity,Finance, or both values.To search for values that don’t have the filter value, use one of the following comparison operators:
To search for values that exclude the filter value, use
NOT_CONTAINS. For example, for theResourceTagsfield, the filterDepartment NOT_CONTAINS Financematches findings that exclude the valueFinancefor theDepartmenttag.To search for values other than the filter value, use
NOT_EQUALS. For example, for theResourceTagsfield, the filterDepartment NOT_EQUALS Financematches findings that don’t have the valueFinancefor theDepartmenttag.
NOT_CONTAINSandNOT_EQUALSfilters on the same field are joined byAND. A finding matches only if it matches all of those filters. For example, the filtersDepartment NOT_CONTAINS Security AND Department NOT_CONTAINS Financematch a finding that excludes both theSecurityandFinancevalues.CONTAINSfilters can only be used with otherCONTAINSfilters.NOT_CONTAINSfilters can only be used with otherNOT_CONTAINSfilters.You can’t have both a
CONTAINSfilter and aNOT_CONTAINSfilter on the same field. Similarly, you can’t have both anEQUALSfilter and aNOT_EQUALSfilter on the same field. Combining filters in this way returns an error.CONTAINSandNOT_CONTAINSoperators can be used only with automation rules. For more information, see Automation rules in the Security Hub User Guide .
- key
The key of the map filter.
For example, for
ResourceTags,Keyidentifies the name of the tag. ForUserDefinedFields,Keyis the name of the field.
- value
The value for the key in the map filter.
Filter values are case sensitive. For example, one of the values for a tag called
Departmentmight beSecurity. If you providesecurityas the filter value, then there’s no match.
NumberFilterProperty
- class CfnAutomationRuleV2PropsMixin.NumberFilterProperty(*, eq=None, gte=None, lte=None)
Bases:
objectA number filter for querying findings.
- Parameters:
eq (
Union[int,float,None]) – The equal-to condition to be applied to a single field when querying for findings.gte (
Union[int,float,None]) – The greater-than-equal condition to be applied to a single field when querying for findings.lte (
Union[int,float,None]) – The less-than-equal condition to be applied to a single field when querying for findings.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_securityhub import mixins as securityhub_mixins number_filter_property = securityhub_mixins.CfnAutomationRuleV2PropsMixin.NumberFilterProperty( eq=123, gte=123, lte=123 )
Attributes
- eq
The equal-to condition to be applied to a single field when querying for findings.
- gte
The greater-than-equal condition to be applied to a single field when querying for findings.
- lte
The less-than-equal condition to be applied to a single field when querying for findings.
OcsfBooleanFilterProperty
- class CfnAutomationRuleV2PropsMixin.OcsfBooleanFilterProperty(*, field_name=None, filter=None)
Bases:
objectEnables filtering of security findings based on boolean field values in OCSF.
- Parameters:
field_name (
Optional[str]) – The name of the field.filter (
Union[IResolvable,BooleanFilterProperty,Dict[str,Any],None]) – Enables filtering of security findings based on boolean field values in OCSF.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_securityhub import mixins as securityhub_mixins ocsf_boolean_filter_property = securityhub_mixins.CfnAutomationRuleV2PropsMixin.OcsfBooleanFilterProperty( field_name="fieldName", filter=securityhub_mixins.CfnAutomationRuleV2PropsMixin.BooleanFilterProperty( value=False ) )
Attributes
- field_name
The name of the field.
- filter
Enables filtering of security findings based on boolean field values in OCSF.
OcsfDateFilterProperty
- class CfnAutomationRuleV2PropsMixin.OcsfDateFilterProperty(*, field_name=None, filter=None)
Bases:
objectEnables filtering of security findings based on date and timestamp fields in OCSF.
- Parameters:
field_name (
Optional[str]) – The name of the field.filter (
Union[IResolvable,DateFilterProperty,Dict[str,Any],None]) – Enables filtering of security findings based on date and timestamp fields in OCSF.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_securityhub import mixins as securityhub_mixins ocsf_date_filter_property = securityhub_mixins.CfnAutomationRuleV2PropsMixin.OcsfDateFilterProperty( field_name="fieldName", filter=securityhub_mixins.CfnAutomationRuleV2PropsMixin.DateFilterProperty( date_range=securityhub_mixins.CfnAutomationRuleV2PropsMixin.DateRangeProperty( unit="unit", value=123 ), end="end", start="start" ) )
Attributes
- field_name
The name of the field.
- filter
Enables filtering of security findings based on date and timestamp fields in OCSF.
OcsfFindingFiltersProperty
- class CfnAutomationRuleV2PropsMixin.OcsfFindingFiltersProperty(*, composite_filters=None, composite_operator=None)
Bases:
objectSpecifies the filtering criteria for security findings using OCSF.
- Parameters:
composite_filters (
Union[IResolvable,Sequence[Union[IResolvable,CompositeFilterProperty,Dict[str,Any]]],None]) – Enables the creation of complex filtering conditions by combining filter criteria.composite_operator (
Optional[str]) – The logical operators used to combine the filtering on multipleCompositeFilters.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_securityhub import mixins as securityhub_mixins ocsf_finding_filters_property = securityhub_mixins.CfnAutomationRuleV2PropsMixin.OcsfFindingFiltersProperty( composite_filters=[securityhub_mixins.CfnAutomationRuleV2PropsMixin.CompositeFilterProperty( boolean_filters=[securityhub_mixins.CfnAutomationRuleV2PropsMixin.OcsfBooleanFilterProperty( field_name="fieldName", filter=securityhub_mixins.CfnAutomationRuleV2PropsMixin.BooleanFilterProperty( value=False ) )], date_filters=[securityhub_mixins.CfnAutomationRuleV2PropsMixin.OcsfDateFilterProperty( field_name="fieldName", filter=securityhub_mixins.CfnAutomationRuleV2PropsMixin.DateFilterProperty( date_range=securityhub_mixins.CfnAutomationRuleV2PropsMixin.DateRangeProperty( unit="unit", value=123 ), end="end", start="start" ) )], map_filters=[securityhub_mixins.CfnAutomationRuleV2PropsMixin.OcsfMapFilterProperty( field_name="fieldName", filter=securityhub_mixins.CfnAutomationRuleV2PropsMixin.MapFilterProperty( comparison="comparison", key="key", value="value" ) )], number_filters=[securityhub_mixins.CfnAutomationRuleV2PropsMixin.OcsfNumberFilterProperty( field_name="fieldName", filter=securityhub_mixins.CfnAutomationRuleV2PropsMixin.NumberFilterProperty( eq=123, gte=123, lte=123 ) )], operator="operator", string_filters=[securityhub_mixins.CfnAutomationRuleV2PropsMixin.OcsfStringFilterProperty( field_name="fieldName", filter=securityhub_mixins.CfnAutomationRuleV2PropsMixin.StringFilterProperty( comparison="comparison", value="value" ) )] )], composite_operator="compositeOperator" )
Attributes
- composite_filters
Enables the creation of complex filtering conditions by combining filter criteria.
- composite_operator
The logical operators used to combine the filtering on multiple
CompositeFilters.
OcsfMapFilterProperty
- class CfnAutomationRuleV2PropsMixin.OcsfMapFilterProperty(*, field_name=None, filter=None)
Bases:
objectEnables filtering of security findings based on map field values in OCSF.
- Parameters:
field_name (
Optional[str]) – The name of the field.filter (
Union[IResolvable,MapFilterProperty,Dict[str,Any],None]) – Enables filtering of security findings based on map field values in OCSF.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_securityhub import mixins as securityhub_mixins ocsf_map_filter_property = securityhub_mixins.CfnAutomationRuleV2PropsMixin.OcsfMapFilterProperty( field_name="fieldName", filter=securityhub_mixins.CfnAutomationRuleV2PropsMixin.MapFilterProperty( comparison="comparison", key="key", value="value" ) )
Attributes
- field_name
The name of the field.
- filter
Enables filtering of security findings based on map field values in OCSF.
OcsfNumberFilterProperty
- class CfnAutomationRuleV2PropsMixin.OcsfNumberFilterProperty(*, field_name=None, filter=None)
Bases:
objectEnables filtering of security findings based on numerical field values in OCSF.
- Parameters:
field_name (
Optional[str]) – The name of the field.filter (
Union[IResolvable,NumberFilterProperty,Dict[str,Any],None]) – Enables filtering of security findings based on numerical field values in OCSF.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_securityhub import mixins as securityhub_mixins ocsf_number_filter_property = securityhub_mixins.CfnAutomationRuleV2PropsMixin.OcsfNumberFilterProperty( field_name="fieldName", filter=securityhub_mixins.CfnAutomationRuleV2PropsMixin.NumberFilterProperty( eq=123, gte=123, lte=123 ) )
Attributes
- field_name
The name of the field.
- filter
Enables filtering of security findings based on numerical field values in OCSF.
OcsfStringFilterProperty
- class CfnAutomationRuleV2PropsMixin.OcsfStringFilterProperty(*, field_name=None, filter=None)
Bases:
objectEnables filtering of security findings based on string field values in OCSF.
- Parameters:
field_name (
Optional[str]) – The name of the field.filter (
Union[IResolvable,StringFilterProperty,Dict[str,Any],None]) – Enables filtering of security findings based on string field values in OCSF.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_securityhub import mixins as securityhub_mixins ocsf_string_filter_property = securityhub_mixins.CfnAutomationRuleV2PropsMixin.OcsfStringFilterProperty( field_name="fieldName", filter=securityhub_mixins.CfnAutomationRuleV2PropsMixin.StringFilterProperty( comparison="comparison", value="value" ) )
Attributes
- field_name
The name of the field.
- filter
Enables filtering of security findings based on string field values in OCSF.
StringFilterProperty
- class CfnAutomationRuleV2PropsMixin.StringFilterProperty(*, comparison=None, value=None)
Bases:
objectA string filter for filtering Security Hub findings.
- Parameters:
comparison (
Optional[str]) –The condition to apply to a string value when filtering Security Hub findings. To search for values that have the filter value, use one of the following comparison operators: - To search for values that include the filter value, use
CONTAINS. For example, the filterTitle CONTAINS CloudFrontmatches findings that have aTitlethat includes the string CloudFront. - To search for values that exactly match the filter value, useEQUALS. For example, the filterAwsAccountId EQUALS 123456789012only matches findings that have an account ID of123456789012. - To search for values that start with the filter value, usePREFIX. For example, the filterResourceRegion PREFIX usmatches findings that have aResourceRegionthat starts withus. AResourceRegionthat starts with a different value, such asaf,ap, orca, doesn’t match.CONTAINS,EQUALS, andPREFIXfilters on the same field are joined byOR. A finding matches if it matches any one of those filters. For example, the filtersTitle CONTAINS CloudFront OR Title CONTAINS CloudWatchmatch a finding that includes eitherCloudFront,CloudWatch, or both strings in the title. To search for values that don’t have the filter value, use one of the following comparison operators: - To search for values that exclude the filter value, useNOT_CONTAINS. For example, the filterTitle NOT_CONTAINS CloudFrontmatches findings that have aTitlethat excludes the string CloudFront. - To search for values other than the filter value, useNOT_EQUALS. For example, the filterAwsAccountId NOT_EQUALS 123456789012only matches findings that have an account ID other than123456789012. - To search for values that don’t start with the filter value, usePREFIX_NOT_EQUALS. For example, the filterResourceRegion PREFIX_NOT_EQUALS usmatches findings with aResourceRegionthat starts with a value other thanus.NOT_CONTAINS,NOT_EQUALS, andPREFIX_NOT_EQUALSfilters on the same field are joined byAND. A finding matches only if it matches all of those filters. For example, the filtersTitle NOT_CONTAINS CloudFront AND Title NOT_CONTAINS CloudWatchmatch a finding that excludes bothCloudFrontandCloudWatchin the title. You can’t have both aCONTAINSfilter and aNOT_CONTAINSfilter on the same field. Similarly, you can’t provide both anEQUALSfilter and aNOT_EQUALSorPREFIX_NOT_EQUALSfilter on the same field. Combining filters in this way returns an error.CONTAINSfilters can only be used with otherCONTAINSfilters.NOT_CONTAINSfilters can only be used with otherNOT_CONTAINSfilters. You can combinePREFIXfilters withNOT_EQUALSorPREFIX_NOT_EQUALSfilters for the same field. Security Hub first processes thePREFIXfilters, and then theNOT_EQUALSorPREFIX_NOT_EQUALSfilters. For example, for the following filters, Security Hub first identifies findings that have resource types that start with eitherAwsIamorAwsEc2. It then excludes findings that have a resource type ofAwsIamPolicyand findings that have a resource type ofAwsEc2NetworkInterface. -ResourceType PREFIX AwsIam-ResourceType PREFIX AwsEc2-ResourceType NOT_EQUALS AwsIamPolicy-ResourceType NOT_EQUALS AwsEc2NetworkInterfaceCONTAINSandNOT_CONTAINSoperators can be used only with automation rules V1.CONTAINS_WORDoperator is only supported inGetFindingsV2,GetFindingStatisticsV2,GetResourcesV2, andGetResourceStatisticsV2APIs. For more information, see Automation rules in the Security Hub User Guide .value (
Optional[str]) – The string filter value. Filter values are case sensitive. For example, the product name for control-based findings isSecurity Hub. If you providesecurity hubas the filter value, there’s no match.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_securityhub import mixins as securityhub_mixins string_filter_property = securityhub_mixins.CfnAutomationRuleV2PropsMixin.StringFilterProperty( comparison="comparison", value="value" )
Attributes
- comparison
The condition to apply to a string value when filtering Security Hub findings.
To search for values that have the filter value, use one of the following comparison operators:
To search for values that include the filter value, use
CONTAINS. For example, the filterTitle CONTAINS CloudFrontmatches findings that have aTitlethat includes the string CloudFront.To search for values that exactly match the filter value, use
EQUALS. For example, the filterAwsAccountId EQUALS 123456789012only matches findings that have an account ID of123456789012.To search for values that start with the filter value, use
PREFIX. For example, the filterResourceRegion PREFIX usmatches findings that have aResourceRegionthat starts withus. AResourceRegionthat starts with a different value, such asaf,ap, orca, doesn’t match.
CONTAINS,EQUALS, andPREFIXfilters on the same field are joined byOR. A finding matches if it matches any one of those filters. For example, the filtersTitle CONTAINS CloudFront OR Title CONTAINS CloudWatchmatch a finding that includes eitherCloudFront,CloudWatch, or both strings in the title.To search for values that don’t have the filter value, use one of the following comparison operators:
To search for values that exclude the filter value, use
NOT_CONTAINS. For example, the filterTitle NOT_CONTAINS CloudFrontmatches findings that have aTitlethat excludes the string CloudFront.To search for values other than the filter value, use
NOT_EQUALS. For example, the filterAwsAccountId NOT_EQUALS 123456789012only matches findings that have an account ID other than123456789012.To search for values that don’t start with the filter value, use
PREFIX_NOT_EQUALS. For example, the filterResourceRegion PREFIX_NOT_EQUALS usmatches findings with aResourceRegionthat starts with a value other thanus.
NOT_CONTAINS,NOT_EQUALS, andPREFIX_NOT_EQUALSfilters on the same field are joined byAND. A finding matches only if it matches all of those filters. For example, the filtersTitle NOT_CONTAINS CloudFront AND Title NOT_CONTAINS CloudWatchmatch a finding that excludes bothCloudFrontandCloudWatchin the title.You can’t have both a
CONTAINSfilter and aNOT_CONTAINSfilter on the same field. Similarly, you can’t provide both anEQUALSfilter and aNOT_EQUALSorPREFIX_NOT_EQUALSfilter on the same field. Combining filters in this way returns an error.CONTAINSfilters can only be used with otherCONTAINSfilters.NOT_CONTAINSfilters can only be used with otherNOT_CONTAINSfilters.You can combine
PREFIXfilters withNOT_EQUALSorPREFIX_NOT_EQUALSfilters for the same field. Security Hub first processes thePREFIXfilters, and then theNOT_EQUALSorPREFIX_NOT_EQUALSfilters.For example, for the following filters, Security Hub first identifies findings that have resource types that start with either
AwsIamorAwsEc2. It then excludes findings that have a resource type ofAwsIamPolicyand findings that have a resource type ofAwsEc2NetworkInterface.ResourceType PREFIX AwsIamResourceType PREFIX AwsEc2ResourceType NOT_EQUALS AwsIamPolicyResourceType NOT_EQUALS AwsEc2NetworkInterface
CONTAINSandNOT_CONTAINSoperators can be used only with automation rules V1.CONTAINS_WORDoperator is only supported inGetFindingsV2,GetFindingStatisticsV2,GetResourcesV2, andGetResourceStatisticsV2APIs. For more information, see Automation rules in the Security Hub User Guide .
- value
The string filter value.
Filter values are case sensitive. For example, the product name for control-based findings is
Security Hub. If you providesecurity hubas the filter value, there’s no match.