You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::IoT::Types::CreateSecurityProfileRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::IoT::Types::CreateSecurityProfileRequest
- Defined in:
- (unknown)
Overview
When passing CreateSecurityProfileRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
security_profile_name: "SecurityProfileName", # required
security_profile_description: "SecurityProfileDescription",
behaviors: [
{
name: "BehaviorName", # required
metric: "BehaviorMetric",
metric_dimension: {
dimension_name: "DimensionName", # required
operator: "IN", # accepts IN, NOT_IN
},
criteria: {
comparison_operator: "less-than", # accepts less-than, less-than-equals, greater-than, greater-than-equals, in-cidr-set, not-in-cidr-set, in-port-set, not-in-port-set
value: {
count: 1,
cidrs: ["Cidr"],
ports: [1],
},
duration_seconds: 1,
consecutive_datapoints_to_alarm: 1,
consecutive_datapoints_to_clear: 1,
statistical_threshold: {
statistic: "EvaluationStatistic",
},
},
},
],
alert_targets: {
"SNS" => {
alert_target_arn: "AlertTargetArn", # required
role_arn: "RoleArn", # required
},
},
additional_metrics_to_retain: ["BehaviorMetric"],
additional_metrics_to_retain_v2: [
{
metric: "BehaviorMetric", # required
metric_dimension: {
dimension_name: "DimensionName", # required
operator: "IN", # accepts IN, NOT_IN
},
},
],
tags: [
{
key: "TagKey", # required
value: "TagValue",
},
],
}
Instance Attribute Summary collapse
-
#additional_metrics_to_retain ⇒ Array<String>
Please use CreateSecurityProfileRequest$additionalMetricsToRetainV2 instead..
-
#additional_metrics_to_retain_v2 ⇒ Array<Types::MetricToRetain>
A list of metrics whose data is retained (stored).
-
#alert_targets ⇒ Hash<String,Types::AlertTarget>
Specifies the destinations to which alerts are sent.
-
#behaviors ⇒ Array<Types::Behavior>
Specifies the behaviors that, when violated by a device (thing), cause an alert.
-
#security_profile_description ⇒ String
A description of the security profile.
-
#security_profile_name ⇒ String
The name you are giving to the security profile.
-
#tags ⇒ Array<Types::Tag>
Metadata that can be used to manage the security profile.
Instance Attribute Details
#additional_metrics_to_retain ⇒ Array<String>
Please use CreateSecurityProfileRequest$additionalMetricsToRetainV2 instead.
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 is
also retained for any metric specified here.
#additional_metrics_to_retain_v2 ⇒ Array<Types::MetricToRetain>
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 is
also retained for any metric specified here.
#alert_targets ⇒ Hash<String,Types::AlertTarget>
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.
#behaviors ⇒ Array<Types::Behavior>
Specifies the behaviors that, when violated by a device (thing), cause an alert.
#security_profile_description ⇒ String
A description of the security profile.
#security_profile_name ⇒ String
The name you are giving to the security profile.
#tags ⇒ Array<Types::Tag>
Metadata that can be used to manage the security profile.