Package software.amazon.awscdk.services.iot

Interface CfnSecurityProfileProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSecurityProfileProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:03.010Z")
@Stability(Stable)
public interface CfnSecurityProfileProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnSecurityProfile.

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.iot.*;
 CfnSecurityProfileProps cfnSecurityProfileProps = CfnSecurityProfileProps.builder()
         .additionalMetricsToRetainV2(List.of(MetricToRetainProperty.builder()
                 .metric("metric")
                 // the properties below are optional
                 .exportMetric(false)
                 .metricDimension(MetricDimensionProperty.builder()
                         .dimensionName("dimensionName")
                         // the properties below are optional
                         .operator("operator")
                         .build())
                 .build()))
         .alertTargets(Map.of(
                 "alertTargetsKey", AlertTargetProperty.builder()
                         .alertTargetArn("alertTargetArn")
                         .roleArn("roleArn")
                         .build()))
         .behaviors(List.of(BehaviorProperty.builder()
                 .name("name")
                 // the properties below are optional
                 .criteria(BehaviorCriteriaProperty.builder()
                         .comparisonOperator("comparisonOperator")
                         .consecutiveDatapointsToAlarm(123)
                         .consecutiveDatapointsToClear(123)
                         .durationSeconds(123)
                         .mlDetectionConfig(MachineLearningDetectionConfigProperty.builder()
                                 .confidenceLevel("confidenceLevel")
                                 .build())
                         .statisticalThreshold(StatisticalThresholdProperty.builder()
                                 .statistic("statistic")
                                 .build())
                         .value(MetricValueProperty.builder()
                                 .cidrs(List.of("cidrs"))
                                 .count("count")
                                 .number(123)
                                 .numbers(List.of(123))
                                 .ports(List.of(123))
                                 .strings(List.of("strings"))
                                 .build())
                         .build())
                 .exportMetric(false)
                 .metric("metric")
                 .metricDimension(MetricDimensionProperty.builder()
                         .dimensionName("dimensionName")
                         // the properties below are optional
                         .operator("operator")
                         .build())
                 .suppressAlerts(false)
                 .build()))
         .metricsExportConfig(MetricsExportConfigProperty.builder()
                 .mqttTopic("mqttTopic")
                 .roleArn("roleArn")
                 .build())
         .securityProfileDescription("securityProfileDescription")
         .securityProfileName("securityProfileName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .targetArns(List.of("targetArns"))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnSecurityProfileProps.Builder	A builder for CfnSecurityProfileProps
static final class	CfnSecurityProfileProps.Jsii$Proxy	An implementation for CfnSecurityProfileProps

Method Summary

Modifier and Type	Method	Description
static CfnSecurityProfileProps.Builder	builder()
default Object	getAdditionalMetricsToRetainV2()	A list of metrics whose data is retained (stored).
default Object	getAlertTargets()	Specifies the destinations to which alerts are sent.
default Object	getBehaviors()	Specifies the behaviors that, when violated by a device (thing), cause an alert.
default Object	getMetricsExportConfig()	Specifies the MQTT topic and role ARN required for metric export.
default String	getSecurityProfileDescription()	A description of the security profile.
default String	getSecurityProfileName()	The name you gave to the security profile.
default List<CfnTag>	getTags()	Metadata that can be used to manage the security profile.
default List<String>	getTargetArns()	The ARN of the target (thing group) to which the security profile is attached.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAdditionalMetricsToRetainV2

@Stability(Stable)
@Nullable
default Object getAdditionalMetricsToRetainV2()

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.

See Also:

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

getAlertTargets

@Stability(Stable)
@Nullable
default Object getAlertTargets()

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.

See Also:

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

getBehaviors

@Stability(Stable)
@Nullable
default Object getBehaviors()

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

See Also:

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

getMetricsExportConfig

@Stability(Stable)
@Nullable
default Object getMetricsExportConfig()

Specifies the MQTT topic and role ARN required for metric export.

See Also:

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

getSecurityProfileDescription

@Stability(Stable)
@Nullable
default String getSecurityProfileDescription()

A description of the security profile.

See Also:

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

getSecurityProfileName

@Stability(Stable)
@Nullable
default String getSecurityProfileName()

The name you gave to the security profile.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

Metadata that can be used to manage the security profile.

See Also:

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

getTargetArns

@Stability(Stable)
@Nullable
default List<String> getTargetArns()

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

See Also:

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

builder

@Stability(Stable)
static CfnSecurityProfileProps.Builder builder()

Returns:

a CfnSecurityProfileProps.Builder of CfnSecurityProfileProps