Package software.amazon.awscdk.services.iot

Class CfnSecurityProfile

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.iot.CfnSecurityProfile
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:57.601Z") @Stability(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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String 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 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(Stable) public CfnSecurityProfile(@NotNull 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 Details

    • inspect

      @Stability(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(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(Stable) @NotNull public String getAttrSecurityProfileArn()
      The Amazon Resource Name (ARN) of the security profile.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Metadata that can be used to manage the security profile.

    • getAdditionalMetricsToRetainV2

      @Stability(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(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(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(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(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(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(Stable) @Nullable public Object getBehaviors()
      Specifies the behaviors that, when violated by a device (thing), cause an alert.

    • setBehaviors

      @Stability(Stable) public void setBehaviors(@Nullable IResolvable value)
      Specifies the behaviors that, when violated by a device (thing), cause an alert.

    • setBehaviors

      @Stability(Stable) public void setBehaviors(@Nullable List<Object> value)
      Specifies the behaviors that, when violated by a device (thing), cause an alert.

    • getSecurityProfileDescription

      @Stability(Stable) @Nullable public String getSecurityProfileDescription()
      A description of the security profile.

    • setSecurityProfileDescription

      @Stability(Stable) public void setSecurityProfileDescription(@Nullable String value)
      A description of the security profile.

    • getSecurityProfileName

      @Stability(Stable) @Nullable public String getSecurityProfileName()
      The name you gave to the security profile.

    • setSecurityProfileName

      @Stability(Stable) public void setSecurityProfileName(@Nullable String value)
      The name you gave to the security profile.

    • getTargetArns

      @Stability(Stable) @Nullable public List<String> getTargetArns()
      The ARN of the target (thing group) to which the security profile is attached.

    • setTargetArns

      @Stability(Stable) public void setTargetArns(@Nullable List<String> value)
      The ARN of the target (thing group) to which the security profile is attached.