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.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:17.992Z")
 @Stability(value=Stable)
public interface CfnSecurityProfileProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::IoT::SecurityProfile`.

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
                 .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())
                 .metric("metric")
                 .metricDimension(MetricDimensionProperty.builder()
                         .dimensionName("dimensionName")
                         // the properties below are optional
                         .operator("operator")
                         .build())
                 .suppressAlerts(false)
                 .build()))
         .securityProfileDescription("securityProfileDescription")
         .securityProfileName("securityProfileName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .targetArns(List.of("targetArns"))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnSecurityProfileProps.Builder	builder()
default Object	getAdditionalMetricsToRetainV2() `AWS::IoT::SecurityProfile.AdditionalMetricsToRetainV2`.
default Object	getAlertTargets() `AWS::IoT::SecurityProfile.AlertTargets`.
default Object	getBehaviors() `AWS::IoT::SecurityProfile.Behaviors`.
default String	getSecurityProfileDescription() `AWS::IoT::SecurityProfile.SecurityProfileDescription`.
default String	getSecurityProfileName() `AWS::IoT::SecurityProfile.SecurityProfileName`.
default List<CfnTag>	getTags() `AWS::IoT::SecurityProfile.Tags`.
default List<String>	getTargetArns() `AWS::IoT::SecurityProfile.TargetArns`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAdditionalMetricsToRetainV2

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

`AWS::IoT::SecurityProfile.AdditionalMetricsToRetainV2`.

getAlertTargets

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

`AWS::IoT::SecurityProfile.AlertTargets`.

getBehaviors

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

`AWS::IoT::SecurityProfile.Behaviors`.

getSecurityProfileDescription

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

`AWS::IoT::SecurityProfile.SecurityProfileDescription`.

getSecurityProfileName

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

`AWS::IoT::SecurityProfile.SecurityProfileName`.

getTags

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

`AWS::IoT::SecurityProfile.Tags`.

getTargetArns

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

`AWS::IoT::SecurityProfile.TargetArns`.

builder

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

Returns:

a CfnSecurityProfileProps.Builder of CfnSecurityProfileProps