Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . iot ]

create-security-profile

Description

Creates a Device Defender security profile.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-security-profile
--security-profile-name <value>
[--security-profile-description <value>]
--behaviors <value>
[--alert-targets <value>]
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--security-profile-name (string)

The name you are giving to the security profile.

--security-profile-description (string)

A description of the security profile.

--behaviors (list)

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

JSON Syntax:

[
  {
    "name": "string",
    "metric": "string",
    "criteria": {
      "comparisonOperator": "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": long,
        "cidrs": ["string", ...],
        "ports": [integer, ...]
      },
      "durationSeconds": integer
    }
  }
  ...
]

--alert-targets (map)

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.

Shorthand Syntax:

  KeyName1=alertTargetArn=string,roleArn=string,KeyName2=alertTargetArn=string,roleArn=string

Where valid key names are:
  SNS

JSON Syntax:

{"SNS": {
      "alertTargetArn": "string",
      "roleArn": "string"
    }
  ...}

--tags (list)

Metadata which can be used to manage the security profile.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

securityProfileName -> (string)

The name you gave to the security profile.

securityProfileArn -> (string)

The ARN of the security profile.