Class CfnSecurityProfile
- All Implemented Interfaces:
IConstruct
,IDependable
,IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
AWS::IoT::SecurityProfile
.
Use the AWS::IoT::SecurityProfile
resource to create a Device Defender security profile. For API reference, see CreateSecurityProfile and for general information, see Detect .
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.*; CfnSecurityProfile cfnSecurityProfile = CfnSecurityProfile.Builder.create(this, "MyCfnSecurityProfile") .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
Modifier and TypeClassDescriptionstatic interface
A structure containing the alert target ARN and the role ARN.static interface
The criteria by which the behavior is determined to be normal.static interface
A Device Defender security profile behavior.static final class
A fluent builder forCfnSecurityProfile
.static interface
TheMachineLearningDetectionConfig
property type controls confidence of the machine learning model.static interface
The dimension of the metric.static interface
The metric you want to retain.static interface
The value to be compared with themetric
.static interface
A statistical ranking (percentile) that indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionCfnSecurityProfile
(Construct scope, String id) Create a newAWS::IoT::SecurityProfile
.CfnSecurityProfile
(Construct scope, String id, CfnSecurityProfileProps props) Create a newAWS::IoT::SecurityProfile
.protected
CfnSecurityProfile
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnSecurityProfile
(software.amazon.jsii.JsiiObjectRef objRef) -
Method Summary
Modifier and TypeMethodDescriptionA list of metrics whose data is retained (stored).Specifies the destinations to which alerts are sent.The Amazon Resource Name (ARN) of the security profile.Specifies the behaviors that, when violated by a device (thing), cause an alert.A description of the security profile.The name you gave to the security profile.getTags()
Metadata that can be used to manage the security profile.The ARN of the target (thing group) to which the security profile is attached.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setAdditionalMetricsToRetainV2
(List<Object> value) A list of metrics whose data is retained (stored).void
A list of metrics whose data is retained (stored).void
setAlertTargets
(Map<String, Object> value) Specifies the destinations to which alerts are sent.void
setAlertTargets
(IResolvable value) Specifies the destinations to which alerts are sent.void
setBehaviors
(List<Object> value) Specifies the behaviors that, when violated by a device (thing), cause an alert.void
setBehaviors
(IResolvable value) Specifies the behaviors that, when violated by a device (thing), cause an alert.void
A description of the security profile.void
setSecurityProfileName
(String value) The name you gave to the security profile.void
setTargetArns
(List<String> value) The ARN of the target (thing group) to which the security profile is attached.Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnSecurityProfile
protected CfnSecurityProfile(software.amazon.jsii.JsiiObjectRef objRef) -
CfnSecurityProfile
protected CfnSecurityProfile(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnSecurityProfile
@Stability(Stable) public CfnSecurityProfile(@NotNull Construct scope, @NotNull String id, @Nullable CfnSecurityProfileProps props) Create a newAWS::IoT::SecurityProfile
.- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
props
-- resource properties.
-
CfnSecurityProfile
Create a newAWS::IoT::SecurityProfile
.- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
-- tree inspector to collect and process attributes.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrSecurityProfileArn
The Amazon Resource Name (ARN) of the security profile. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Metadata that can be used to manage the security profile. -
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. -
setAdditionalMetricsToRetainV2
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. -
setAdditionalMetricsToRetainV2
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. -
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.
-
setAlertTargets
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.
-
setAlertTargets
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.
-
getBehaviors
Specifies the behaviors that, when violated by a device (thing), cause an alert. -
setBehaviors
Specifies the behaviors that, when violated by a device (thing), cause an alert. -
setBehaviors
Specifies the behaviors that, when violated by a device (thing), cause an alert. -
getSecurityProfileDescription
A description of the security profile. -
setSecurityProfileDescription
A description of the security profile. -
getSecurityProfileName
The name you gave to the security profile. -
setSecurityProfileName
The name you gave to the security profile. -
getTargetArns
The ARN of the target (thing group) to which the security profile is attached. -
setTargetArns
The ARN of the target (thing group) to which the security profile is attached.
-