Class CfnSecurityProfileMixinProps

Properties for CfnSecurityProfilePropsMixin.

Inheritance

object

CfnSecurityProfileMixinProps

Implements

ICfnSecurityProfileMixinProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.IoT

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public class CfnSecurityProfileMixinProps : ICfnSecurityProfileMixinProps

Syntax (vb)

Public Class CfnSecurityProfileMixinProps Implements ICfnSecurityProfileMixinProps

Remarks

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.CfnPropertyMixins.AWS.IoT;

             var cfnSecurityProfileMixinProps = new CfnSecurityProfileMixinProps {
                 AdditionalMetricsToRetainV2 = new [] { new MetricToRetainProperty {
                     ExportMetric = false,
                     Metric = "metric",
                     MetricDimension = new MetricDimensionProperty {
                         DimensionName = "dimensionName",
                         Operator = "operator"
                     }
                 } },
                 AlertTargets = new Dictionary<string, object> {
                     { "alertTargetsKey", new AlertTargetProperty {
                         AlertTargetArn = "alertTargetArn",
                         RoleArn = "roleArn"
                     } }
                 },
                 Behaviors = new [] { new BehaviorProperty {
                     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",
                         Operator = "operator"
                     },
                     Name = "name",
                     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

Constructors

CfnSecurityProfileMixinProps()

Properties for CfnSecurityProfilePropsMixin.

Properties

AdditionalMetricsToRetainV2	A list of metrics whose data is retained (stored).
AlertTargets	Specifies the destinations to which alerts are sent.
Behaviors	Specifies the behaviors that, when violated by a device (thing), cause an alert.
MetricsExportConfig	Specifies the MQTT topic and role ARN required for metric export.
SecurityProfileDescription	A description of the security profile.
SecurityProfileName	The name you gave to the security profile.
Tags	Metadata that can be used to manage the security profile.
TargetArns	The ARN of the target (thing group) to which the security profile is attached.

Constructors

CfnSecurityProfileMixinProps()

Properties for CfnSecurityProfilePropsMixin.

public CfnSecurityProfileMixinProps()

Remarks

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.CfnPropertyMixins.AWS.IoT;

             var cfnSecurityProfileMixinProps = new CfnSecurityProfileMixinProps {
                 AdditionalMetricsToRetainV2 = new [] { new MetricToRetainProperty {
                     ExportMetric = false,
                     Metric = "metric",
                     MetricDimension = new MetricDimensionProperty {
                         DimensionName = "dimensionName",
                         Operator = "operator"
                     }
                 } },
                 AlertTargets = new Dictionary<string, object> {
                     { "alertTargetsKey", new AlertTargetProperty {
                         AlertTargetArn = "alertTargetArn",
                         RoleArn = "roleArn"
                     } }
                 },
                 Behaviors = new [] { new BehaviorProperty {
                     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",
                         Operator = "operator"
                     },
                     Name = "name",
                     SuppressAlerts = false
                 } },
                 MetricsExportConfig = new MetricsExportConfigProperty {
                     MqttTopic = "mqttTopic",
                     RoleArn = "roleArn"
                 },
                 SecurityProfileDescription = "securityProfileDescription",
                 SecurityProfileName = "securityProfileName",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 TargetArns = new [] { "targetArns" }
             };

Properties

AdditionalMetricsToRetainV2

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

public object? AdditionalMetricsToRetainV2 { get; set; }

Property Value

object

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.

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

Type union: either IResolvable or (either IResolvable or CfnSecurityProfilePropsMixin.IMetricToRetainProperty)[]

AlertTargets

Specifies the destinations to which alerts are sent.

public object? AlertTargets { get; set; }

Property Value

object

Remarks

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

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

Type union: either IResolvable or Dictionary<string, either IResolvable or CfnSecurityProfilePropsMixin.IAlertTargetProperty>

Behaviors

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

public object? Behaviors { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or (either IResolvable or CfnSecurityProfilePropsMixin.IBehaviorProperty)[]

MetricsExportConfig

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

public object? MetricsExportConfig { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnSecurityProfilePropsMixin.IMetricsExportConfigProperty

SecurityProfileDescription

A description of the security profile.

public string? SecurityProfileDescription { get; set; }

Property Value

string

Remarks

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

SecurityProfileName

The name you gave to the security profile.

public string? SecurityProfileName { get; set; }

Property Value

string

Remarks

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

TargetArns

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

public string[]? TargetArns { get; set; }