software.amazon.awscdk.services.iot

Class CfnSecurityProfile

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.iot.CfnSecurityProfile

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.890Z")
 @Stability(value=Stable)
public class CfnSecurityProfile
extends CfnResource
implements IInspectable

A CloudFormation `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

Nested Classes

Modifier and Type	Class and Description
static interface	CfnSecurityProfile.AlertTargetProperty A structure containing the alert target ARN and the role ARN.
static interface	CfnSecurityProfile.BehaviorCriteriaProperty The criteria by which the behavior is determined to be normal.
static interface	CfnSecurityProfile.BehaviorProperty A Device Defender security profile behavior.
static class	CfnSecurityProfile.Builder A fluent builder for CfnSecurityProfile.
static interface	CfnSecurityProfile.MachineLearningDetectionConfigProperty The `MachineLearningDetectionConfig` property type controls confidence of the machine learning model.
static interface	CfnSecurityProfile.MetricDimensionProperty The dimension of the metric.
static interface	CfnSecurityProfile.MetricToRetainProperty The metric you want to retain.
static interface	CfnSecurityProfile.MetricValueProperty The value to be compared with the `metric` .
static interface	CfnSecurityProfile.StatisticalThresholdProperty 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.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnSecurityProfile(software.constructs.Construct scope, String id) Create a new `AWS::IoT::SecurityProfile`.
	CfnSecurityProfile(software.constructs.Construct scope, String id, CfnSecurityProfileProps props) Create a new `AWS::IoT::SecurityProfile`.
protected	CfnSecurityProfile(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnSecurityProfile(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
Object	getAdditionalMetricsToRetainV2() A list of metrics whose data is retained (stored).
Object	getAlertTargets() Specifies the destinations to which alerts are sent.
String	getAttrSecurityProfileArn() The Amazon Resource Name (ARN) of the security profile.
Object	getBehaviors() Specifies the behaviors that, when violated by a device (thing), cause an alert.
protected Map<String,Object>	getCfnProperties()
String	getSecurityProfileDescription() A description of the security profile.
String	getSecurityProfileName() The name you gave to the security profile.
TagManager	getTags() Metadata that can be used to manage the security profile.
List<String>	getTargetArns() 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.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAdditionalMetricsToRetainV2(IResolvable value) A list of metrics whose data is retained (stored).
void	setAdditionalMetricsToRetainV2(List<Object> value) A list of metrics whose data is retained (stored).
void	setAlertTargets(IResolvable value) Specifies the destinations to which alerts are sent.
void	setAlertTargets(Map<String,Object> value) Specifies the destinations to which alerts are sent.
void	setBehaviors(IResolvable value) Specifies the behaviors that, when violated by a device (thing), cause an alert.
void	setBehaviors(List<Object> value) Specifies the behaviors that, when violated by a device (thing), cause an alert.
void	setSecurityProfileDescription(String value) 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.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnSecurityProfile

protected CfnSecurityProfile(software.amazon.jsii.JsiiObjectRef objRef)

CfnSecurityProfile

protected CfnSecurityProfile(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnSecurityProfile

@Stability(value=Stable)
public CfnSecurityProfile(@NotNull
                                                   software.constructs.Construct scope,
                                                   @NotNull
                                                   String id,
                                                   @Nullable
                                                   CfnSecurityProfileProps props)

Create a new `AWS::IoT::SecurityProfile`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties.

CfnSecurityProfile

@Stability(value=Stable)
public CfnSecurityProfile(@NotNull
                                                   software.constructs.Construct scope,
                                                   @NotNull
                                                   String id)

Create a new `AWS::IoT::SecurityProfile`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrSecurityProfileArn

@Stability(value=Stable)
 @NotNull
public String getAttrSecurityProfileArn()

The Amazon Resource Name (ARN) of the security profile.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

Metadata that can be used to manage the security profile.

getAdditionalMetricsToRetainV2

@Stability(value=Stable)
 @Nullable
public Object 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

@Stability(value=Stable)
public void setAdditionalMetricsToRetainV2(@Nullable
                                                                    IResolvable value)

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

@Stability(value=Stable)
public void setAdditionalMetricsToRetainV2(@Nullable
                                                                    List<Object> value)

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

@Stability(value=Stable)
 @Nullable
public Object 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

@Stability(value=Stable)
public void setAlertTargets(@Nullable
                                                     IResolvable value)

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

@Stability(value=Stable)
public void setAlertTargets(@Nullable
                                                     Map<String,Object> value)

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

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

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

setBehaviors

@Stability(value=Stable)
public void setBehaviors(@Nullable
                                                  IResolvable value)

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

setBehaviors

@Stability(value=Stable)
public void setBehaviors(@Nullable
                                                  List<Object> value)

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

getSecurityProfileDescription

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

A description of the security profile.

setSecurityProfileDescription

@Stability(value=Stable)
public void setSecurityProfileDescription(@Nullable
                                                                   String value)

A description of the security profile.

getSecurityProfileName

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

The name you gave to the security profile.

setSecurityProfileName

@Stability(value=Stable)
public void setSecurityProfileName(@Nullable
                                                            String value)

The name you gave to the security profile.

getTargetArns

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

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

setTargetArns

@Stability(value=Stable)
public void setTargetArns(@Nullable
                                                   List<String> value)

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