create-security-profile
Описание
Создаёт профиль безопасности Device Defender.
Требуется разрешение на доступ к действию CreateSecurityProfile.
См. также: Документация AWS API
Синтаксис
create-security-profile
--security-profile-name <value>
[--security-profile-description <value>]
[--behaviors <value>]
[--alert-targets <value>]
[--additional-metrics-to-retain <value>]
[--additional-metrics-to-retain-v2 <value>]
[--tags <value>]
[--metrics-export-config <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
Параметры
--security-profile-name (строка)
--security-profile-description (строка)
--behaviors (список)
Указывает поведение, нарушение которого устройством (thing) приводит к срабатыванию оповещения.
(структура)
Поведение профиля безопасности Device Defender.
name -> (строка)
metric -> (строка)
metricDimension -> (структура)
Измерение для параметра в вашем поведении. Например, используя измерение TOPIC_FILTER, вы можете сузить область параметра до MQTT-тем, где имя соответствует заданному шаблону в измерении. Это нельзя использовать с настраиваемыми параметрами.
dimensionName -> (строка)
operator -> (строка)
dimensionValues измерения. Например, для типа измерения TOPIC_FILTER, оператор IN означает, что сообщение будет учитываться только в том случае, если его тема совпадает с одним из фильтров тем. С оператором NOT_IN сообщение будет учитываться только в том случае, если оно не соответствует ни одному из фильтров тем. Оператор является необязательным: если он не указан (null), он интерпретируется как IN.criteria -> (структура)
Критерии, определяющие, соответствует ли поведение устройства нормальному поведению относительно metric.
Примечание
В консоли IoT вы можете выбрать получение оповещения через Amazon SNS, когда IoT Device Defender обнаруживает аномальное поведение устройства.comparisonOperator -> (строка)
Оператор, соотносящий измеряемый параметр (metric) с критериями (содержащими value или statisticalThreshold). Допустимые операторы:
-
string-list:in-setиnot-in-set -
number-list:in-setиnot-in-set -
ip-address-list:in-cidr-setиnot-in-cidr-set -
number:less-than,less-than-equals,greater-than, иgreater-than-equals
value -> (структура)
Значение для сравнения с metric.
count -> (целое)
comparisonOperator требует числового значения, используйте это для указания этого числового значения для сравнения с metric.cidrs -> (список)
Если comparisonOperator требует набора CIDR, используйте это для указания этого набора для сравнения с metric.
(строка)
ports -> (список)
Если comparisonOperator требует набора портов, используйте это для указания этого набора для сравнения с metric.
(целое)
number -> (двойное)
numbers -> (список)
Числовые значения параметра.
(двойное)
strings -> (список)
Строковые значения параметра.
(строка)
durationSeconds -> (целое)
NUM_MESSAGES_SENT). Для сравнения параметров statisticalThreshhold измерения со всех устройств накапливаются в течение этого интервала времени перед использованием для расчета процентилей, а затем измерения с отдельного устройства также накапливаются в течение этого интервала времени перед присвоением процентильного ранга. Нельзя использовать с типами данных параметров в формате списка.consecutiveDatapointsToAlarm -> (целое)
consecutiveDatapointsToClear -> (целое)
statisticalThreshold -> (структура)
Статистический ранг (процентиль), указывающий пороговое значение, по которому поведение считается соответствующим или нарушающим.
statistic -> (строка)
durationSeconds) со всех устройств, отправляющих отчеты в вашей учетной записи, и вычисляются статистические ранги. Затем измерения устройства собираются в течение того же периода. Если накопленные измерения устройства превышают или опустились ниже (comparisonOperator) значения, связанного с указанным процентилем, устройство считается соответствующим поведению, в противном случае происходит нарушение.mlDetectionConfig -> (структура)
Настройка ML Detect
confidenceLevel -> (строка)
Low, Medium или High.suppressAlerts -> (логическое)
exportMetric -> (логическое)
Синтаксис JSON:
[
{
"name": "string",
"metric": "string",
"metricDimension": {
"dimensionName": "string",
"operator": "IN"|"NOT_IN"
},
"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"|"in-set"|"not-in-set",
"value": {
"count": long,
"cidrs": ["string", ...],
"ports": [integer, ...],
"number": double,
"numbers": [double, ...],
"strings": ["string", ...]
},
"durationSeconds": integer,
"consecutiveDatapointsToAlarm": integer,
"consecutiveDatapointsToClear": integer,
"statisticalThreshold": {
"statistic": "string"
},
"mlDetectionConfig": {
"confidenceLevel": "LOW"|"MEDIUM"|"HIGH"
}
},
"suppressAlerts": true|false,
"exportMetric": true|false
}
...
]
--alert-targets (массив)
Указывает назначения, в которые отправляются оповещения. (Оповещения всегда отправляются в консоль). Оповещения генерируются, когда устройство (thing) нарушает поведение.
key -> (строка)
value -> (структура)
Структура, содержащая ARN целевого объекта оповещения и ARN роли.
alertTargetArn -> (строка)
roleArn -> (строка)
Упрощенный синтаксис:
KeyName1=alertTargetArn=string,roleArn=string,KeyName2=alertTargetArn=string,roleArn=string
Where valid key names are:
SNS
Синтаксис JSON:
{"SNS": {
"alertTargetArn": "string",
"roleArn": "string"
}
...}
--additional-metrics-to-retain (список)
Список метрик, данные которых сохраняются. По умолчанию данные сохраняются для любого параметра, используемого в behaviors профиля, но также сохраняются для любого параметра, указанного здесь. Может использоваться с настраиваемыми параметрами; не может использоваться с измерениями.
(строка)
Синтаксис:
"string" "string" ...
--additional-metrics-to-retain-v2 (список)
Список метрик, данные которых сохраняются. По умолчанию данные сохраняются для любого параметра, используемого в behaviors профиля, но также сохраняются для любого параметра, указанного здесь. Может использоваться с настраиваемыми параметрами; не может использоваться с измерениями.
(структура)
Параметр, который вы хотите сохранить. Измерения необязательны.
metric -> (строка)
metricDimension -> (структура)
Измерение параметра. Это нельзя использовать с настраиваемыми параметрами.
dimensionName -> (строка)
operator -> (строка)
dimensionValues измерения. Например, для типа измерения TOPIC_FILTER, оператор IN означает, что сообщение будет учитываться только в том случае, если его тема совпадает с одним из фильтров тем. С оператором NOT_IN сообщение будет учитываться только в том случае, если оно не соответствует ни одному из фильтров тем. Оператор является необязательным: если он не указан (null), он интерпретируется как IN.exportMetric -> (логическое)
MetricToRetain, при значении true.Упрощенный синтаксис:
metric=string,metricDimension={dimensionName=string,operator=string},exportMetric=boolean ...
Синтаксис JSON:
[
{
"metric": "string",
"metricDimension": {
"dimensionName": "string",
"operator": "IN"|"NOT_IN"
},
"exportMetric": true|false
}
...
]
--tags (список)
Метаданные, которые могут быть использованы для управления профилем безопасности.
(структура)
Набор пар ключ-значение, которые используются для управления ресурсом.
Key -> (строка)
Value -> (строка)
Упрощенный синтаксис:
Key=string,Value=string ...
Синтаксис JSON:
[
{
"Key": "string",
"Value": "string"
}
...
]
--metrics-export-config (структура)
Указывает MQTT-тему и ARN роли, необходимые для экспорта параметров.
mqttTopic -> (строка)
roleArn -> (строка)
Упрощенный синтаксис:
mqttTopic=string,roleArn=string
Синтаксис JSON:
{
"mqttTopic": "string",
"roleArn": "string"
}
--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, предоставленные JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного JSON, так как строка будет взята буквально. Это может не быть указано вместе с --cli-input-yaml.
--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса API. При отсутствии значения или значении input выводит пример JSON-ввода, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, при предоставлении yaml-input выводит пример YAML-ввода, который можно использовать с --cli-input-yaml. При предоставлении значения output он проверяет ввод команд и возвращает пример JSON-вывода для этой команды. Сгенерированный JSON-скелет не стабилен между версиями AWS CLI, и нет гарантии обратной совместимости в сгенерированном JSON-скелете.
Общие параметры
--debug (boolean)
Включить отладку.
--endpoint-url (string)
Переопределить стандартный URL команды заданным URL.
--no-verify-ssl (boolean)
По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.
--no-paginate (boolean)
Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI сделает только один вызов для первой страницы результатов.
--output (string)
Стиль форматирования вывода команды.
- json
- text
- table
- yaml
- yaml-stream
--query (string)
Запрос JMESPath для фильтрации данных ответа.
--profile (string)
Использование определенного профиля из файла аутентификации.
--region (string)
Регион для использования. Переопределяет настройки конфигурации/окружения.
--version (string)
Показать версию этого инструмента.
--color (string)
Включить/выключить цветной вывод.
- вкл
- выкл
- авто
--no-sign-request (boolean)
Не подписывать запросы. Кредиты не будут загружены, если этот аргумент предоставлен.
--ca-bundle (string)
Файл сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/окружения.
--cli-read-timeout (int)
Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет блокирующим и без таймаута. Значение по умолчанию составляет 60 секунд.
--cli-connect-timeout (int)
Максимальное время подключения сокета в секундах. Если значение равно 0, подключение сокета будет блокирующим и без таймаута. Значение по умолчанию составляет 60 секунд.
--cli-binary-format (string)
Стиль форматирования, используемый для двоичных блоков. По умолчанию используется формат base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как строка, закодированная в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое соответствует двоичному блоку, fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла напрямую, независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (boolean)
Отключить вывод страницы для вывода.
--cli-auto-prompt (boolean)
Автоматически запросить параметры входных данных CLI.
--no-cli-auto-prompt (boolean)
Отключить автоматическое запросы параметров входных данных CLI.
Примеры
Примечание
Для использования следующих примеров, у вас должна быть установлена и настроена AWS CLI. Более подробную информацию см. в руководстве «Начало работы» в руководстве пользователя AWS CLI.
Если не указано иное, все примеры используют правила цитирования типа Unix. Эти примеры потребуется адаптировать к правилам цитирования вашей терминальной оболочки. Более подробно см. раздел «Использование кавычек со строками» в руководстве пользователя AWS CLI.
Для создания профиля безопасности
Следующий create-security-profile пример создает профиль безопасности, который проверяет, превышен ли предел сотовой пропускной способности или произошло более 10 авторизационных ошибок в течение пяти минут.
aws iot create-security-profile \
--security-profile-name PossibleIssue \
--security-profile-description "Check to see if authorization fails 10 times in 5 minutes or if cellular bandwidth exceeds 128" \
--behaviors "[{\"name\":\"CellularBandwidth\",\"metric\":\"aws:message-byte-size\",\"criteria\":{\"comparisonOperator\":\"greater-than\",\"value\":{\"count\":128},\"consecutiveDatapointsToAlarm\":1,\"consecutiveDatapointsToClear\":1}},{\"name\":\"Authorization\",\"metric\":\"aws:num-authorization-failures\",\"criteria\":{\"comparisonOperator\":\"less-than\",\"value\":{\"count\":10},\"durationSeconds\":300,\"consecutiveDatapointsToAlarm\":1,\"consecutiveDatapointsToClear\":1}}]"
Вывод:
{
"securityProfileName": "PossibleIssue",
"securityProfileArn": "arn:aws:iot:us-west-2:123456789012:securityprofile/PossibleIssue"
}
Для получения дополнительной информации см. раздел «Команды обнаружения» в руководстве разработчика AWS IoT.
Вывод
securityProfileName -> (строка)
securityProfileArn -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.