Class: Aws::IoT::Types::UpdateSecurityProfileRequest

Inherits:

Struct

Object
Struct
Aws::IoT::Types::UpdateSecurityProfileRequest

show all

Includes:: Structure

Defined in:: lib/aws-sdk-iot/types.rb

Overview

Note:

When making an API call, you may pass UpdateSecurityProfileRequest data as a 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, in-set, not-in-set
        value: {
          count: 1,
          cidrs: ["Cidr"],
          ports: [1],
          number: 1.0,
          numbers: [1.0],
          strings: ["stringValue"],
        },
        duration_seconds: 1,
        consecutive_datapoints_to_alarm: 1,
        consecutive_datapoints_to_clear: 1,
        statistical_threshold: {
          statistic: "EvaluationStatistic",
        },
        ml_detection_config: {
          confidence_level: "LOW", # required, accepts LOW, MEDIUM, HIGH
        },
      },
      suppress_alerts: false,
    },
  ],
  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
      },
    },
  ],
  delete_behaviors: false,
  delete_alert_targets: false,
  delete_additional_metrics_to_retain: false,
  expected_version: 1,
}

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#additional_metrics_to_retain ⇒ Array<String>

*Please use UpdateSecurityProfileRequest$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>

Where the alerts are sent.
#behaviors ⇒ Array<Types::Behavior>

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

If true, delete all `additionalMetricsToRetain` defined for this security profile.
#delete_alert_targets ⇒ Boolean

If true, delete all `alertTargets` defined for this security profile.
#delete_behaviors ⇒ Boolean

If true, delete all `behaviors` defined for this security profile.
#expected_version ⇒ Integer

The expected version of the security profile.
#security_profile_description ⇒ String

A description of the security profile.
#security_profile_name ⇒ String

The name of the security profile you want to update.

Instance Attribute Details

#additional_metrics_to_retain ⇒ `Array<String>`

*Please use UpdateSecurityProfileRequest$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. Can be used with custom metrics; cannot be used with dimensions.

Returns:

(Array<String>)

# File 'lib/aws-sdk-iot/types.rb', line 20116

class UpdateSecurityProfileRequest < Struct.new(
  :security_profile_name,
  :security_profile_description,
  :behaviors,
  :alert_targets,
  :additional_metrics_to_retain,
  :additional_metrics_to_retain_v2,
  :delete_behaviors,
  :delete_alert_targets,
  :delete_additional_metrics_to_retain,
  :expected_version)
  SENSITIVE = []
  include Aws::Structure
end

#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. Can be used with custom metrics; cannot be used with dimensions.

Returns:

(Array<Types::MetricToRetain>)

# File 'lib/aws-sdk-iot/types.rb', line 20116

class UpdateSecurityProfileRequest < Struct.new(
  :security_profile_name,
  :security_profile_description,
  :behaviors,
  :alert_targets,
  :additional_metrics_to_retain,
  :additional_metrics_to_retain_v2,
  :delete_behaviors,
  :delete_alert_targets,
  :delete_additional_metrics_to_retain,
  :expected_version)
  SENSITIVE = []
  include Aws::Structure
end

#alert_targets ⇒ `Hash<String,Types::AlertTarget>`

Where the alerts are sent. (Alerts are always sent to the console.)

Returns:

(Hash<String,Types::AlertTarget>)

# File 'lib/aws-sdk-iot/types.rb', line 20116

class UpdateSecurityProfileRequest < Struct.new(
  :security_profile_name,
  :security_profile_description,
  :behaviors,
  :alert_targets,
  :additional_metrics_to_retain,
  :additional_metrics_to_retain_v2,
  :delete_behaviors,
  :delete_alert_targets,
  :delete_additional_metrics_to_retain,
  :expected_version)
  SENSITIVE = []
  include Aws::Structure
end

#behaviors ⇒ `Array<Types::Behavior>`

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

Returns:

(Array<Types::Behavior>)

# File 'lib/aws-sdk-iot/types.rb', line 20116

class UpdateSecurityProfileRequest < Struct.new(
  :security_profile_name,
  :security_profile_description,
  :behaviors,
  :alert_targets,
  :additional_metrics_to_retain,
  :additional_metrics_to_retain_v2,
  :delete_behaviors,
  :delete_alert_targets,
  :delete_additional_metrics_to_retain,
  :expected_version)
  SENSITIVE = []
  include Aws::Structure
end

#delete_additional_metrics_to_retain ⇒ `Boolean`

If true, delete all `additionalMetricsToRetain` defined for this security profile. If any `additionalMetricsToRetain` are defined in the current invocation, an exception occurs.

Returns:

(Boolean)

# File 'lib/aws-sdk-iot/types.rb', line 20116

class UpdateSecurityProfileRequest < Struct.new(
  :security_profile_name,
  :security_profile_description,
  :behaviors,
  :alert_targets,
  :additional_metrics_to_retain,
  :additional_metrics_to_retain_v2,
  :delete_behaviors,
  :delete_alert_targets,
  :delete_additional_metrics_to_retain,
  :expected_version)
  SENSITIVE = []
  include Aws::Structure
end

#delete_alert_targets ⇒ `Boolean`

If true, delete all `alertTargets` defined for this security profile. If any `alertTargets` are defined in the current invocation, an exception occurs.

Returns:

(Boolean)

# File 'lib/aws-sdk-iot/types.rb', line 20116

class UpdateSecurityProfileRequest < Struct.new(
  :security_profile_name,
  :security_profile_description,
  :behaviors,
  :alert_targets,
  :additional_metrics_to_retain,
  :additional_metrics_to_retain_v2,
  :delete_behaviors,
  :delete_alert_targets,
  :delete_additional_metrics_to_retain,
  :expected_version)
  SENSITIVE = []
  include Aws::Structure
end

#delete_behaviors ⇒ `Boolean`

If true, delete all `behaviors` defined for this security profile. If any `behaviors` are defined in the current invocation, an exception occurs.

Returns:

(Boolean)

# File 'lib/aws-sdk-iot/types.rb', line 20116

class UpdateSecurityProfileRequest < Struct.new(
  :security_profile_name,
  :security_profile_description,
  :behaviors,
  :alert_targets,
  :additional_metrics_to_retain,
  :additional_metrics_to_retain_v2,
  :delete_behaviors,
  :delete_alert_targets,
  :delete_additional_metrics_to_retain,
  :expected_version)
  SENSITIVE = []
  include Aws::Structure
end

#expected_version ⇒ `Integer`

The expected version of the security profile. A new version is generated whenever the security profile is updated. If you specify a value that is different from the actual version, a `VersionConflictException` is thrown.

Returns:

(Integer)

# File 'lib/aws-sdk-iot/types.rb', line 20116

class UpdateSecurityProfileRequest < Struct.new(
  :security_profile_name,
  :security_profile_description,
  :behaviors,
  :alert_targets,
  :additional_metrics_to_retain,
  :additional_metrics_to_retain_v2,
  :delete_behaviors,
  :delete_alert_targets,
  :delete_additional_metrics_to_retain,
  :expected_version)
  SENSITIVE = []
  include Aws::Structure
end

#security_profile_description ⇒ `String`

A description of the security profile.

Returns:

(String)

# File 'lib/aws-sdk-iot/types.rb', line 20116

class UpdateSecurityProfileRequest < Struct.new(
  :security_profile_name,
  :security_profile_description,
  :behaviors,
  :alert_targets,
  :additional_metrics_to_retain,
  :additional_metrics_to_retain_v2,
  :delete_behaviors,
  :delete_alert_targets,
  :delete_additional_metrics_to_retain,
  :expected_version)
  SENSITIVE = []
  include Aws::Structure
end

#security_profile_name ⇒ `String`

The name of the security profile you want to update.

Returns:

(String)

# File 'lib/aws-sdk-iot/types.rb', line 20116

class UpdateSecurityProfileRequest < Struct.new(
  :security_profile_name,
  :security_profile_description,
  :behaviors,
  :alert_targets,
  :additional_metrics_to_retain,
  :additional_metrics_to_retain_v2,
  :delete_behaviors,
  :delete_alert_targets,
  :delete_additional_metrics_to_retain,
  :expected_version)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::IoT::Types::UpdateSecurityProfileRequest

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#additional_metrics_to_retain ⇒ Array<String>

#additional_metrics_to_retain_v2 ⇒ Array<Types::MetricToRetain>

#alert_targets ⇒ Hash<String,Types::AlertTarget>

#behaviors ⇒ Array<Types::Behavior>

#delete_additional_metrics_to_retain ⇒ Boolean

#delete_alert_targets ⇒ Boolean

#delete_behaviors ⇒ Boolean

#expected_version ⇒ Integer

#security_profile_description ⇒ String

#security_profile_name ⇒ String

#additional_metrics_to_retain ⇒ `Array<String>`

#additional_metrics_to_retain_v2 ⇒ `Array<Types::MetricToRetain>`

#alert_targets ⇒ `Hash<String,Types::AlertTarget>`

#behaviors ⇒ `Array<Types::Behavior>`

#delete_additional_metrics_to_retain ⇒ `Boolean`

#delete_alert_targets ⇒ `Boolean`

#delete_behaviors ⇒ `Boolean`

#expected_version ⇒ `Integer`

#security_profile_description ⇒ `String`

#security_profile_name ⇒ `String`