[ aws . auditmanager ]
создание-рамки-оценки
Описание
Создает пользовательскую рамку в Audit Manager.
См. также: Документацию API AWS
Синтаксис
create-assessment-framework
--name <value>
[--description <value>]
[--compliance-type <value>]
--control-sets <value>
[--tags <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]
Параметры
--name (строка)
--description (строка)
--compliance-type (строка)
--control-sets (список)
Наборы контролей, связанные с рамкой.
(структура)
Сущность controlSet, представляющая набор контролей в Audit Manager. Она не содержит идентификатор набора контролей.
name -> (строка)
controls -> (список)
Список контролей в наборе контролей. Он не содержит идентификатор набора контролей.
(структура)
Атрибуты сущности контроля, уникально идентифицирующие существующий контроль, который необходимо добавить в рамку в Audit Manager.
id -> (строка)
Сокращенный синтаксис:
name=string,controls=[{id=string},{id=string}] ...
Синтаксис JSON:
[
{
"name": "string",
"controls": [
{
"id": "string"
}
...
]
}
...
]
--tags (карта)
Теги, связанные с рамкой.
key -> (строка)
value -> (строка)
Сокращенный синтаксис:
KeyName1=string,KeyName2=string
Синтаксис JSON:
{"string": "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 (логическое значение)
Включить отладочную запись.
--endpoint-url (строка)
Переопределить URL по умолчанию команды указанным URL.
--no-verify-ssl (логическое значение)
По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого подключения SSL AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет поведение проверки сертификатов SSL по умолчанию.
--no-paginate (логическое значение)
Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.
--output (строка)
Стиль форматирования для вывода команды.
- json
- text
- таблица
- yaml
- yaml-поток
--query (строка)
Запрос JMESPath для фильтрации данных ответа.
--profile (строка)
Использовать определенный профиль из файла учетных данных.
--region (строка)
Используемый регион. Переопределяет настройки конфигурации/среды.
--version (строка)
Отобразить версию этого инструмента.
--color (строка)
Включить/выключить цветной вывод.
- включено
- выключено
- авто
--no-sign-request (логическое значение)
Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент указан.
--ca-bundle (строка)
Файл с набором сертификатов CA для проверки сертификатов SSL. Переопределяет настройки конфигурации/среды.
--cli-read-timeout (целое число)
Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.
--cli-connect-timeout (целое число)
Максимальное время подключения сокета в секундах. Если значение равно 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.
--cli-binary-format (строка)
Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как закодированная строка base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI версии 1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого файла, сопоставляемого с двоичным блоком, fileb:// всегда будет рассматриваться как двоичный и будет использоваться содержимое файла напрямую независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть правильно отформатировано для настроенного cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (логическое значение)
Отключить вывод страницы CLI.
--cli-auto-prompt (логическое значение)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (логическое значение)
Отключить автоматическое запросы параметров ввода CLI.
Вывод
framework -> (структура)
Имя нового фреймворка, возвращённого API CreateAssessmentFramework.
arn -> (строка)
id -> (строка)
name -> (строка)
type -> (строка)
complianceType -> (строка)
description -> (строка)
logo -> (строка)
controlSources -> (строка)
controlSets -> (список)
Наборы контролей, связанные с фреймворком.
(структура)
Набор контролей в Audit Manager.
id -> (строка)
name -> (строка)
controls -> (список)
Список контролей в наборе контролей.
(структура)
Контроль в Audit Manager.
arn -> (строка)
id -> (строка)
type -> (строка)
name -> (строка)
description -> (строка)
testingInformation -> (строка)
actionPlanTitle -> (строка)
actionPlanInstructions -> (строка)
controlSources -> (строка)
controlMappingSources -> (список)
Источники сопоставления данных для контроля.
(структура)
Источник данных, определяющий, откуда Audit Manager собирает доказательства для контроля.
sourceId -> (строка)
sourceName -> (строка)
sourceDescription -> (строка)
sourceSetUpOption -> (строка)
sourceSetUpOption, Audit Manager автоматически определит и заполнит правильное значение, основываясь на sourceType, которое вы укажете.sourceType -> (строка)
Указывает тип источника данных, используемого для сбора доказательств.
- Источник может быть отдельным типом источника данных, например,
AWS_Cloudtrail,AWS_Config,AWS_Security_Hub,AWS_API_CallилиMANUAL. - Источник также может быть управляемой группой источников данных, например,
Core_ControlилиCommon_Control.
sourceKeyword -> (структура)
Ключевое слово, относящееся к источнику данных контроля.
Для ручных доказательств это ключевое слово указывает, является ли ручное доказательство файлом или текстом.
Для автоматических доказательств это ключевое слово идентифицирует определённое событие CloudTrail, правило Config, контроль Security Hub или имя API Amazon Web Services.
Дополнительную информацию о поддерживаемых ключевых словах, которые можно использовать при сопоставлении источника данных контроля, см. на следующих страницах в Руководстве пользователя Audit Manager :
- Поддерживаемые правила Config Audit Manager
- Поддерживаемые контролы Security Hub Audit Manager
- Поддерживаемые вызовы API Audit Manager
- Поддерживаемые имена событий CloudTrail Audit Manager
keywordInputType -> (строка)
Метод ввода ключевого слова.
-
SELECT_FROM_LISTиспользуется при сопоставлении источника данных для автоматических доказательств.- Если
keywordInputTypeравноSELECT_FROM_LIST, необходимо выбрать ключевое слово для сбора автоматических доказательств. Например, это может быть имя события CloudTrail, имя правила для Config, контроль Security Hub или имя вызова API Amazon Web Services.
- Если
-
UPLOAD_FILEиINPUT_TEXTиспользуются только при сопоставлении источника данных для ручных доказательств.- Если
keywordInputTypeравноUPLOAD_FILE, необходимо загрузить файл в качестве ручных доказательств. - Если
keywordInputTypeравноINPUT_TEXT, необходимо ввести текст в качестве ручных доказательств.
- Если
keywordValue -> (строка)
Значение ключевого слова, используемого при сопоставлении источника данных контроля. Например, это может быть имя события CloudTrail, имя правила для Config, контроль Security Hub или имя вызова API Amazon Web Services.
Если вы сопоставляете источник данных с правилом в Config, заданное вами keywordValue зависит от типа правила:
- Для управляемых правил вы можете использовать идентификатор правила в качестве
keywordValue. Идентификатор правила можно найти в списке управляемых правил Config. Для некоторых правил идентификатор правила отличается от имени правила. Например, у правилаrestricted-sshследующий идентификатор правила:INCOMING_SSH_DISABLED. Убедитесь, что вы используете идентификатор правила, а не имя правила. Пример ключевого слова для управляемых правил:- Имя управляемого правила: s3-bucket-acl-prohibited
keywordValue:S3_BUCKET_ACL_PROHIBITED
- Имя управляемого правила: s3-bucket-acl-prohibited
- Для настраиваемых правил вы формируете
keywordValue, добавляя префиксCustom_к имени правила. Этот префикс отличает настраиваемое правило от управляемого правила. Пример ключевого слова для настраиваемых правил:- Имя настраиваемого правила: my-custom-config-rule
keywordValue:Custom_my-custom-config-rule
- Имя настраиваемого правила: my-custom-config-rule
- Для правил, связанных с сервисом, вы формируете
keywordValue, добавляя префиксCustom_к имени правила. Кроме того, удалите суффикс ID, который появляется в конце имени правила. Примеры ключевых слов для правил, связанных с сервисом:- Имя правила, связанного с сервисом: CustomRuleForAccount-conformance-pack-szsm1uv0w
keywordValue:Custom_CustomRuleForAccount-conformance-pack - Имя правила, связанного с сервисом: OrgConfigRule-s3-bucket-versioning-enabled-dbgzf8ba
keywordValue:Custom_OrgConfigRule-s3-bucket-versioning-enabled
- Имя правила, связанного с сервисом: CustomRuleForAccount-conformance-pack-szsm1uv0w
Предупреждение
keywordValue чувствителен к регистру. Если вы введёте значение неправильно, Audit Manager может не распознать сопоставление источника данных. В результате вы, возможно, не сможете успешно собрать доказательства из этого источника данных, как предполагалось.
Учитывайте следующие требования в зависимости от используемого типа источника данных.
- Для Config:
- Для управляемых правил, убедитесь, что
keywordValue- это идентификатор правила вALL_CAPS_WITH_UNDERSCORES. Например,CLOUDWATCH_LOG_GROUP_ENCRYPTED. Для точности рекомендуется обратиться к списку поддерживаемых управляемых правил Config. - Для настраиваемых правил, убедитесь, что
keywordValueимеет префиксCustom_, за которым следует имя настраиваемого правила. Формат самого имени настраиваемого правила может различаться. Для точности рекомендуется посетить консоль Config, чтобы проверить имя своего настраиваемого правила.
- Для управляемых правил, убедитесь, что
- Для Security Hub: Формат различается для имён контролей Security Hub. Для точности рекомендуется обратиться к списку поддерживаемых контролей Security Hub.
- Для вызовов API Amazon Web Services: Убедитесь, что
keywordValueнаписан какserviceprefix_ActionName. Например,iam_ListGroups. Для точности рекомендуется обратиться к списку поддерживаемых вызовов API. - Для CloudTrail: Убедитесь, что
keywordValueнаписан какserviceprefix_ActionName. Например,cloudtrail_StartLogging. Для точности рекомендуется ознакомиться с префиксом службы Amazon Web Services и именами действий в Справочнике по авторизации сервисов.
sourceFrequency -> (строка)
troubleshootingText -> (строка)
createdAt -> (метка времени)
lastUpdatedAt -> (метка времени)
createdBy -> (строка)
lastUpdatedBy -> (строка)
tags -> (отображение)
Теги, связанные с контролем.
key -> (строка)
value -> (строка)
state -> (строка)
END_OF_SUPPORT применимо только к стандартным контролям. Это состояние указывает, что стандартный контроль по-прежнему можно использовать для сбора доказательств, но Audit Manager больше не обновляет или не поддерживает этот контроль.createdAt -> (метка времени)
lastUpdatedAt -> (метка времени)
createdBy -> (строка)
lastUpdatedBy -> (строка)
tags -> (отображение)
Теги, связанные с фреймворком.
key -> (строка)
value -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.