Class CfnSecurityProfile
A CloudFormation AWS::IoT::SecurityProfile
.
Inherited Members
Namespace: Amazon.CDK.AWS.IoT
Assembly: Amazon.CDK.AWS.IoT.dll
Syntax (csharp)
public class CfnSecurityProfile : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnSecurityProfile
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Use the AWS::IoT::SecurityProfile
resource to create a Device Defender security profile. For API reference, see CreateSecurityProfile and for general information, see Detect .
CloudformationResource: AWS::IoT::SecurityProfile
Link: 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 cfnSecurityProfile = new CfnSecurityProfile(this, "MyCfnSecurityProfile", new CfnSecurityProfileProps {
AdditionalMetricsToRetainV2 = new [] { new MetricToRetainProperty {
Metric = "metric",
// the properties below are optional
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" }
}
},
Metric = "metric",
MetricDimension = new MetricDimensionProperty {
DimensionName = "dimensionName",
// the properties below are optional
Operator = "operator"
},
SuppressAlerts = false
} },
SecurityProfileDescription = "securityProfileDescription",
SecurityProfileName = "securityProfileName",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
TargetArns = new [] { "targetArns" }
});
Synopsis
Constructors
CfnSecurityProfile(Construct, String, ICfnSecurityProfileProps) | Create a new |
CfnSecurityProfile(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnSecurityProfile(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AdditionalMetricsToRetainV2 | A list of metrics whose data is retained (stored). |
AlertTargets | Specifies the destinations to which alerts are sent. |
AttrSecurityProfileArn | The Amazon Resource Name (ARN) of the security profile. |
Behaviors | Specifies the behaviors that, when violated by a device (thing), cause an alert. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnSecurityProfile(Construct, String, ICfnSecurityProfileProps)
Create a new AWS::IoT::SecurityProfile
.
public CfnSecurityProfile(Construct scope, string id, ICfnSecurityProfileProps props = null)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnSecurityProfileProps
- resource properties.
CfnSecurityProfile(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnSecurityProfile(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnSecurityProfile(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnSecurityProfile(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AdditionalMetricsToRetainV2
A list of metrics whose data is retained (stored).
public virtual object AdditionalMetricsToRetainV2 { get; set; }
Property Value
System.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.
AlertTargets
Specifies the destinations to which alerts are sent.
public virtual object AlertTargets { get; set; }
Property Value
System.Object
Remarks
(Alerts are always sent to the console.) Alerts are generated when a device (thing) violates a behavior.
AttrSecurityProfileArn
The Amazon Resource Name (ARN) of the security profile.
public virtual string AttrSecurityProfileArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: SecurityProfileArn
Behaviors
Specifies the behaviors that, when violated by a device (thing), cause an alert.
public virtual object Behaviors { get; set; }
Property Value
System.Object
Remarks
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
SecurityProfileDescription
A description of the security profile.
public virtual string SecurityProfileDescription { get; set; }
Property Value
System.String
Remarks
SecurityProfileName
The name you gave to the security profile.
public virtual string SecurityProfileName { get; set; }
Property Value
System.String
Remarks
Tags
Metadata that can be used to manage the security profile.
public virtual TagManager Tags { get; }
Property Value
Remarks
TargetArns
The ARN of the target (thing group) to which the security profile is attached.
public virtual string[] TargetArns { get; set; }
Property Value
System.String[]
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>