Interface ICfnSecurityProfileProps
Properties for defining a CfnSecurityProfile.
Namespace: Amazon.CDK.AWS.IoT
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnSecurityProfilePropsSyntax (vb)
Public Interface ICfnSecurityProfilePropsRemarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-securityprofile.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.IoT;
var cfnSecurityProfileProps = new CfnSecurityProfileProps {
AdditionalMetricsToRetainV2 = new [] { new MetricToRetainProperty {
Metric = "metric",
// the properties below are optional
ExportMetric = false,
MetricDimension = new MetricDimensionProperty {
DimensionName = "dimensionName",
// the properties below are optional
Operator = "operator"
}
} },
AlertTargets = new Dictionary<string, object> {
{ "alertTargetsKey", new AlertTargetProperty {
AlertTargetArn = "alertTargetArn",
RoleArn = "roleArn"
} }
},
Behaviors = new [] { new BehaviorProperty {
Name = "name",
// the properties below are optional
Criteria = new BehaviorCriteriaProperty {
ComparisonOperator = "comparisonOperator",
ConsecutiveDatapointsToAlarm = 123,
ConsecutiveDatapointsToClear = 123,
DurationSeconds = 123,
MlDetectionConfig = new MachineLearningDetectionConfigProperty {
ConfidenceLevel = "confidenceLevel"
},
StatisticalThreshold = new StatisticalThresholdProperty {
Statistic = "statistic"
},
Value = new MetricValueProperty {
Cidrs = new [] { "cidrs" },
Count = "count",
Number = 123,
Numbers = new [] { 123 },
Ports = new [] { 123 },
Strings = new [] { "strings" }
}
},
ExportMetric = false,
Metric = "metric",
MetricDimension = new MetricDimensionProperty {
DimensionName = "dimensionName",
// the properties below are optional
Operator = "operator"
},
SuppressAlerts = false
} },
MetricsExportConfig = new MetricsExportConfigProperty {
MqttTopic = "mqttTopic",
RoleArn = "roleArn"
},
SecurityProfileDescription = "securityProfileDescription",
SecurityProfileName = "securityProfileName",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
TargetArns = new [] { "targetArns" }
};Synopsis
Properties
| Additional |
A list of metrics whose data is retained (stored). |
| Alert |
Specifies the destinations to which alerts are sent. |
| Behaviors | Specifies the behaviors that, when violated by a device (thing), cause an alert. |
| Metrics |
Specifies the MQTT topic and role ARN required for metric export. |
| Security |
A description of the security profile. |
| Security |
The name you gave to the security profile. |
| Tags | Metadata that can be used to manage the security profile. |
| Target |
The ARN of the target (thing group) to which the security profile is attached. |
Properties
AdditionalMetricsToRetainV2
A list of metrics whose data is retained (stored).
virtual object AdditionalMetricsToRetainV2 { get; }Property Value
System.
Remarks
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.
AlertTargets
Specifies the destinations to which alerts are sent.
virtual object AlertTargets { get; }Property Value
System.
Remarks
(Alerts are always sent to the console.) Alerts are generated when a device (thing) violates a behavior.
Behaviors
Specifies the behaviors that, when violated by a device (thing), cause an alert.
virtual object Behaviors { get; }Property Value
System.
Remarks
MetricsExportConfig
Specifies the MQTT topic and role ARN required for metric export.
virtual object MetricsExportConfig { get; }Property Value
System.
Remarks
SecurityProfileDescription
A description of the security profile.
virtual string SecurityProfileDescription { get; }Property Value
System.
Remarks
SecurityProfileName
The name you gave to the security profile.
virtual string SecurityProfileName { get; }Property Value
System.
Remarks
Tags
Metadata that can be used to manage the security profile.
virtual ICfnTag[] Tags { get; }Property Value
ICfn
Remarks
TargetArns
The ARN of the target (thing group) to which the security profile is attached.
virtual string[] TargetArns { get; }Property Value
System.