Class: Aws::IoT::Types::CreateSecurityProfileRequest

Inherits:

Struct

• Object
• Struct
• Aws::IoT::Types::CreateSecurityProfileRequest

Includes:

Structure

Defined in:

lib/aws-sdk-iot/types.rb

Overview

Note:

When making an API call, you may pass CreateSecurityProfileRequest data as a hash:

{
  security_profile_name: "SecurityProfileName", # required
  security_profile_description: "SecurityProfileDescription",
  behaviors: [ # required
    {
      name: "BehaviorName", # required
      metric: "BehaviorMetric",
      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,
      },
    },
  ],
  alert_targets: {
    "SNS" => {
      alert_target_arn: "AlertTargetArn", # required
      role_arn: "RoleArn", # required
    },
  },
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
}

Instance Attribute Summary

• #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 which can be used to manage the security profile.

Instance Attribute Details

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

Returns:

• (Hash<String,Types::AlertTarget>)

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

class CreateSecurityProfileRequest < Struct.new(
  :security_profile_name,
  :security_profile_description,
  :behaviors,
  :alert_targets,
  :tags)
  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 2512

class CreateSecurityProfileRequest < Struct.new(
  :security_profile_name,
  :security_profile_description,
  :behaviors,
  :alert_targets,
  :tags)
  include Aws::Structure
end

#security_profile_description ⇒ String

A description of the security profile.

Returns:

• (String)

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

class CreateSecurityProfileRequest < Struct.new(
  :security_profile_name,
  :security_profile_description,
  :behaviors,
  :alert_targets,
  :tags)
  include Aws::Structure
end

#security_profile_name ⇒ String

The name you are giving to the security profile.

Returns:

• (String)

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

class CreateSecurityProfileRequest < Struct.new(
  :security_profile_name,
  :security_profile_description,
  :behaviors,
  :alert_targets,
  :tags)
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

Metadata which can be used to manage the security profile.

Returns:

• (Array<Types::Tag>)

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

class CreateSecurityProfileRequest < Struct.new(
  :security_profile_name,
  :security_profile_description,
  :behaviors,
  :alert_targets,
  :tags)
  include Aws::Structure
end