You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing UpdateSecurityProfileRequest 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
      },
    },
  ],
  delete_behaviors: false,
  delete_alert_targets: false,
  delete_additional_metrics_to_retain: false,
  expected_version: 1,
}

Instance Attribute Summary collapse

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.

Returns:

#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.

Returns:

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

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

Returns:

#behaviors ⇒ Array<Types::Behavior>

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

Returns:

  • (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. If any additionalMetricsToRetain are defined in the current invocation, an exception occurs.

Returns:

  • (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. If any alertTargets are defined in the current invocation, an exception occurs.

Returns:

  • (Boolean) —

    If true, delete all alertTargets defined for this security profile.

#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) —

    If true, delete all behaviors defined for this security profile.

#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) —

    The expected version of the security profile.

#security_profile_description ⇒ String

A description of the security profile.

Returns:

  • (String) —

    A description of the security profile.

#security_profile_name ⇒ String

The name of the security profile you want to update.

Returns:

  • (String) —

    The name of the security profile you want to update.