CfnSecurityProfileProps

class aws_cdk.aws_iot.CfnSecurityProfileProps(*, additional_metrics_to_retain_v2=None, alert_targets=None, behaviors=None, security_profile_description=None, security_profile_name=None, tags=None, target_arns=None)

Bases: object

Properties for defining a CfnSecurityProfile.

Parameters
  • additional_metrics_to_retain_v2 (Union[IResolvable, Sequence[Union[IResolvable, MetricToRetainProperty, Dict[str, Any]]], None]) – A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile’s behaviors , but it’s also retained for any metric specified here. Can be used with custom metrics; can’t be used with dimensions.

  • alert_targets (Union[IResolvable, Mapping[str, Union[IResolvable, AlertTargetProperty, Dict[str, Any]]], None]) – Specifies the destinations to which alerts are sent. (Alerts are always sent to the console.) Alerts are generated when a device (thing) violates a behavior.

  • behaviors (Union[IResolvable, Sequence[Union[IResolvable, BehaviorProperty, Dict[str, Any]]], None]) – Specifies the behaviors that, when violated by a device (thing), cause an alert.

  • security_profile_description (Optional[str]) – A description of the security profile.

  • security_profile_name (Optional[str]) – The name you gave to the security profile.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Metadata that can be used to manage the security profile.

  • target_arns (Optional[Sequence[str]]) – The ARN of the target (thing group) to which the security profile is attached.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-securityprofile.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_iot as iot

cfn_security_profile_props = iot.CfnSecurityProfileProps(
    additional_metrics_to_retain_v2=[iot.CfnSecurityProfile.MetricToRetainProperty(
        metric="metric",

        # the properties below are optional
        metric_dimension=iot.CfnSecurityProfile.MetricDimensionProperty(
            dimension_name="dimensionName",

            # the properties below are optional
            operator="operator"
        )
    )],
    alert_targets={
        "alert_targets_key": iot.CfnSecurityProfile.AlertTargetProperty(
            alert_target_arn="alertTargetArn",
            role_arn="roleArn"
        )
    },
    behaviors=[iot.CfnSecurityProfile.BehaviorProperty(
        name="name",

        # the properties below are optional
        criteria=iot.CfnSecurityProfile.BehaviorCriteriaProperty(
            comparison_operator="comparisonOperator",
            consecutive_datapoints_to_alarm=123,
            consecutive_datapoints_to_clear=123,
            duration_seconds=123,
            ml_detection_config=iot.CfnSecurityProfile.MachineLearningDetectionConfigProperty(
                confidence_level="confidenceLevel"
            ),
            statistical_threshold=iot.CfnSecurityProfile.StatisticalThresholdProperty(
                statistic="statistic"
            ),
            value=iot.CfnSecurityProfile.MetricValueProperty(
                cidrs=["cidrs"],
                count="count",
                number=123,
                numbers=[123],
                ports=[123],
                strings=["strings"]
            )
        ),
        metric="metric",
        metric_dimension=iot.CfnSecurityProfile.MetricDimensionProperty(
            dimension_name="dimensionName",

            # the properties below are optional
            operator="operator"
        ),
        suppress_alerts=False
    )],
    security_profile_description="securityProfileDescription",
    security_profile_name="securityProfileName",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    target_arns=["targetArns"]
)

Attributes

additional_metrics_to_retain_v2

A list of metrics whose data is retained (stored).

By default, data is retained for any metric used in the profile’s behaviors , but it’s also retained for any metric specified here. Can be used with custom metrics; can’t be used with dimensions.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-securityprofile.html#cfn-iot-securityprofile-additionalmetricstoretainv2

Return type

Union[IResolvable, List[Union[IResolvable, MetricToRetainProperty]], None]

alert_targets

Specifies the destinations to which alerts are sent.

(Alerts are always sent to the console.) Alerts are generated when a device (thing) violates a behavior.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-securityprofile.html#cfn-iot-securityprofile-alerttargets

Return type

Union[IResolvable, Mapping[str, Union[IResolvable, AlertTargetProperty]], None]

behaviors

Specifies the behaviors that, when violated by a device (thing), cause an alert.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-securityprofile.html#cfn-iot-securityprofile-behaviors

Return type

Union[IResolvable, List[Union[IResolvable, BehaviorProperty]], None]

security_profile_description

A description of the security profile.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-securityprofile.html#cfn-iot-securityprofile-securityprofiledescription

Return type

Optional[str]

security_profile_name

The name you gave to the security profile.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-securityprofile.html#cfn-iot-securityprofile-securityprofilename

Return type

Optional[str]

tags

Metadata that can be used to manage the security profile.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-securityprofile.html#cfn-iot-securityprofile-tags

Return type

Optional[List[CfnTag]]

target_arns

The ARN of the target (thing group) to which the security profile is attached.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-securityprofile.html#cfn-iot-securityprofile-targetarns

Return type

Optional[List[str]]