[ aws . cloudtrail ]
создать-панель-управления
Описание
Создаёт пользовательскую панель управления или панель «Важные моменты».
- Пользовательские панели управления - Пользовательские панели управления позволяют вам выполнять запросы к событиям в любом типе хранилища данных событий. Вы можете добавить до 10 виджетов на пользовательскую панель управления. Вы можете вручную обновить пользовательскую панель управления или задать расписание обновления.
- Панель «Важные моменты» - Вы можете создать панель «Важные моменты», чтобы увидеть сводку ключевых действий пользователей и использования API во всех ваших хранилищах данных событий. CloudTrail Lake управляет панелью «Важные моменты» и обновляет её каждые 6 часов. Чтобы создать панель «Важные моменты», необходимо установить и включить расписание обновления.
CloudTrail выполняет запросы для заполнения виджетов панели управления во время ручного или запланированного обновления. CloudTrail должен получить разрешения на выполнение операции StartQuery от вашего имени. Для предоставления разрешений выполните операцию PutResourcePolicy для добавления политики на основе ресурсов к каждому хранилищу данных событий. Дополнительную информацию см. в примере «Разрешение CloudTrail на выполнение запросов для заполнения панели управления» в руководстве пользователя CloudTrail.
Для задания расписания обновления CloudTrail должен получить разрешения на выполнение операции StartDashboardRefresh для обновления панели управления от вашего имени. Для предоставления разрешений выполните операцию PutResourcePolicy для добавления политики на основе ресурсов к панели управления. Дополнительную информацию см. в примере политики на основе ресурсов для панели управления в руководстве пользователя CloudTrail.
Дополнительную информацию о панелях управления см. в разделе «Панели управления CloudTrail Lake» в руководстве пользователя CloudTrail.
См. также: Документацию API AWS
Синтаксис
create-dashboard
--name <value>
[--refresh-schedule <value>]
[--tags-list <value>]
[--termination-protection-enabled | --no-termination-protection-enabled]
[--widgets <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 (строка)
Имя панели управления. Имя должно быть уникальным для вашей учётной записи.
Для создания панели «Важные моменты» имя должно быть AWSCloudTrail-Highlights .
--refresh-schedule (структура)
Настройка расписания обновления для панели управления.
Для создания панели «Важные моменты» необходимо задать расписание обновления и установить Status в ENABLED . Unit для расписания обновления должно быть HOURS , а Value должно быть 6 .
Частота -> (структура)
Частота обновления панели управления.
Единица измерения -> (строка)
Единица измерения для обновления.
Для пользовательских панелей управления единицей измерения может быть HOURS или DAYS .
Для панели «Важные моменты» единица измерения должна быть Unit .
Значение -> (целое число)
Значение для расписания обновления.
Для пользовательских панелей управления следующие значения допустимы, когда единица измерения - HOURS : 1 , 6 , 12 , 24
Для пользовательских панелей управления единственно допустимое значение, когда единица измерения - DAYS , это 1 .
Для панели «Важные моменты» значение должно быть 6 .
Статус -> (строка)
ENABLED, чтобы включить расписание обновления, или в DISABLED, чтобы выключить его.Время -> (строка)
Короткая форма:
Frequency={Unit=string,Value=integer},Status=string,TimeOfDay=string
Формат JSON:
{
"Frequency": {
"Unit": "HOURS"|"DAYS",
"Value": integer
},
"Status": "ENABLED"|"DISABLED",
"TimeOfDay": "string"
}
--tags-list (список)
Список тегов.
(структура)
Пользовательская пара «ключ-значение», связанная с ресурсом, таким как трасса CloudTrail, хранилище данных событий, панель управления или канал.
Ключ -> (строка)
Значение -> (строка)
Короткая форма:
Key=string,Value=string ...
Формат JSON:
[
{
"Key": "string",
"Value": "string"
}
...
]
--termination-protection-enabled | --no-termination-protection-enabled (логическое значение)
--widgets (список)
Массив виджетов для пользовательской панели управления. Пользовательская панель управления может содержать максимум десять виджетов.
Для панели «Важные моменты» указывать виджеты не нужно.
(структура)
Содержит информацию о виджете на панели управления CloudTrail Lake.
Запрос -> (строка)
Запрос для виджета. Для виджетов пользовательских панелей управления вы можете выполнять запросы к нескольким хранилищам данных событий, при условии, что все хранилища данных событий существуют в вашей учётной записи.
Примечание
Когда запрос использует? с eventTime , ? должен быть заключён в одинарные кавычки следующим образом: '?' .Параметры запроса -> (список)
Дополнительные параметры запроса. Допустимы следующие параметры запроса: $StartTime$ , $EndTime$ и $Period$ .
(строка)
Свойства представления -> (мапа)
Свойства представления для виджета. Дополнительную информацию о свойствах представления см. в разделе «Свойства представления виджетов» в руководстве пользователя CloudTrail.
ключ -> (строка)
значение -> (строка)
Короткая форма:
QueryStatement=string,QueryParameters=string,string,ViewProperties={KeyName1=string,KeyName2=string} ...
Формат JSON:
[
{
"QueryStatement": "string",
"QueryParameters": ["string", ...],
"ViewProperties": {"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 команды на указанный.
--no-verify-ssl (логическое значение)
По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого подключения SSL AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет поведение по умолчанию, которое заключается в проверке сертификатов SSL.
--no-paginate (логическое значение)
Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.
--output (строка)
Стиль форматирования вывода команды.
- json
- текст
- таблица
- 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 V1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, отображающего двоичный блок, fileb:// всегда будет обрабатываться как двоичный и будет использоваться содержимое файла непосредственно, независимо от настроек cli-binary-format. При использовании file://, содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (логическое значение)
Отключить кли-пэйджер для вывода.
--cli-auto-prompt (логическое значение)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (логическое значение)
Отключить автоматическое запросы параметров ввода CLI.
Вывод
DashboardArn -> (строка)
Имя -> (строка)
Тип -> (строка)
Виджеты -> (список)
Массив виджетов для панели.
(структура)
Виджет на панели CloudTrail Lake.
QueryAlias -> (строка)
QueryStatement -> (строка)
QueryParameters -> (список)
Параметры запроса для виджета.
(строка)
ViewProperties -> (карта)
Свойства отображения для виджета. Дополнительную информацию о свойствах отображения см. в разделе «Свойства отображения для виджетов» в Руководстве пользователя CloudTrail.
ключ -> (строка)
значение -> (строка)
TagsList -> (список)
Список тегов.
(структура)
Пользовательская пара «ключ-значение», связанная с ресурсом, таким как трейл CloudTrail, хранилище данных событий, панель или канал.
Ключ -> (строка)
Значение -> (строка)
RefreshSchedule -> (структура)
Расписание обновления для панели, если оно настроено.
Частота -> (структура)
Частота обновления панели.
Единица измерения -> (строка)
Единица измерения для обновления.
Для пользовательских панелей единица измерения может быть HOURS или DAYS .
Для панели Highlights единица измерения должна быть Unit и равна HOURS .
Значение -> (целое число)
Значение для расписания обновления.
Для пользовательских панелей следующие значения допустимы, когда единица измерения равна HOURS : 1 , 6 , 12 , 24
Для пользовательских панелей единственное допустимое значение, когда единица измерения равна DAYS , — 1 .
Для панели Highlights значение должно быть Value и равно 6 .
Статус -> (строка)
ENABLED, чтобы включить расписание обновления, или в DISABLED, чтобы выключить расписание обновления.Время суток -> (строка)
TerminationProtectionEnabled -> (булево)
© Copyright 2025, Amazon Web Services. Created using Sphinx.