Spec-Zone.ru › AWS CLI v2

[ aws . cloudtrail ]

create-trail

Описание

Создаёт трейл, определяющий настройки для доставки данных журналов в ведро Amazon S3.

См. также: Документацию API AWS

Синтаксис

  create-trail
--name <value>
--s3-bucket-name <value>
[--s3-key-prefix <value>]
[--sns-topic-name <value>]
[--include-global-service-events | --no-include-global-service-events]
[--is-multi-region-trail | --no-is-multi-region-trail]
[--enable-log-file-validation | --no-enable-log-file-validation]
[--cloud-watch-logs-log-group-arn <value>]
[--cloud-watch-logs-role-arn <value>]
[--kms-key-id <value>]
[--is-organization-trail | --no-is-organization-trail]
[--tags-list <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 (строка)

Указывает имя трейла. Имя должно соответствовать следующим требованиям:

  • Содержать только ASCII буквы (a-z, A-Z), цифры (0-9), точки (.), подчёркивания (_) или дефисы (-)
  • Начинаться с буквы или цифры и заканчиваться буквой или цифрой
  • Содержать от 3 до 128 символов
  • Не содержать смежных точек, подчёркиваний или дефисов. Такие имена, как my-_namespace и my--namespace, недействительны.
  • Не быть в формате IP-адреса (например, 192.168.5.4)

--s3-bucket-name (строка)

Указывает имя ведра Amazon S3, предназначенного для публикации файлов журналов. Сведения о правилах именования ведёр см. в руководстве пользователя Amazon Simple Storage Service .

--s3-key-prefix (строка)

Указывает префикс ключа Amazon S3, идущий после имени ведра, назначенного для доставки файлов журналов. Дополнительная информация см. в разделе Нахождение файлов журнала CloudTrail . Максимальная длина составляет 200 символов.

--sns-topic-name (строка)

Указывает имя или ARN темы Amazon SNS, определённой для уведомления о доставке файлов журналов. Максимальная длина составляет 256 символов.

--include-global-service-events | --no-include-global-service-events (логическое значение)

Указывает, публикует ли трейл события от глобальных сервисов, таких как IAM, в файлы журналов.

--is-multi-region-trail | --no-is-multi-region-trail (логическое значение)

Указывает, создаётся ли трейл в текущем регионе или во всех регионах. По умолчанию значение ложно, что создаёт трейл только в регионе, где вы авторизованы. В качестве лучшей практики рассмотрите создание трейлов, регистрирующих события во всех регионах.

--enable-log-file-validation | --no-enable-log-file-validation (логическое значение)

Указывает, включена ли проверка целостности файла журнала. По умолчанию значение ложно.

Примечание

Когда вы отключаете проверку целостности файла журнала, цепочка файлов дайджестов разрывается через час. CloudTrail не создаёт файлы дайджестов для файлов журналов, которые были доставлены в период, когда проверка целостности файла журнала была отключена. Например, если вы включаете проверку целостности файла журнала в полдень 1 января, отключаете её в полдень 2 января и снова включаете её в полдень 10 января, файлы дайджестов не будут созданы для файлов журналов, доставленных с полудня 2 января до полудня 10 января. То же самое относится к любому случаю остановки записи журнала CloudTrail или удаления трейла.

--cloud-watch-logs-log-group-arn (строка)

Указывает имя группы журналов с использованием Amazon Resource Name (ARN), уникального идентификатора, представляющего группу журналов, в которую будут доставлены журналы CloudTrail. Вы должны использовать существующую в вашей учётной записи группу журналов.

Не требуется, если вы не указали CloudWatchLogsRoleArn.

--cloud-watch-logs-role-arn (строка)

Указывает роль для точки входа CloudWatch Logs для получения прав доступа для записи в группу журналов пользователя. Вы должны использовать существующую в вашей учётной записи роль.

--kms-key-id (строка)

Указывает идентификатор ключа KMS, используемый для шифрования журналов, доставляемых CloudTrail. Значение может быть именем псевдонима, опережаемым alias/, полностью указанным ARN псевдонима, полностью указанным ARN ключа или глобально уникальным идентификатором.

CloudTrail также поддерживает ключи KMS во многих регионах. Дополнительную информацию о ключах во многих регионах см. в руководстве разработчика Key Management Service.

Примеры:

  • alias/MyAliasName
  • arn:aws:kms:us-east-2:123456789012:alias/MyAliasName
  • arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
  • 12345678-1234-1234-1234-123456789012

--is-organization-trail | --no-is-organization-trail (логическое значение)

Указывает, создаётся ли трейл для всех учётных записей в организации в Organizations или только для текущей учётной записи Amazon Web Services. По умолчанию значение ложно, и оно не может быть истинным, если вызов не осуществляется от имени учётной записи Amazon Web Services, являющейся учётной записью управления или уполномоченной администраторской учётной записью для организации в Organizations.

--tags-list (список)

Список тегов.

(структура)

Пользовательская пара ключ-значение, связанная с ресурсом, таким как трейл CloudTrail, хранилище событий данных, панель мониторинга или канал.

Ключ -> (строка)

Ключ в паре ключ-значение. Ключ не должен превышать 128 символов Юникода. Ключ должен быть уникальным для ресурса, к которому он применяется.

Значение -> (строка)

Значение в паре ключ-значение тега. Значение не должно превышать 256 символов Юникода.

Сокращённый синтаксис:

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "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 V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, отображающегося в двоичном блоке, 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.

Примеры

Примечание

Для использования следующих примеров необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы в руководстве пользователя AWS CLI.

Если не указано иное, все примеры используют правила цитирования Unix-подобных систем. Эти примеры необходимо адаптировать к правилам цитирования вашей терминальной оболочки. См. Использование кавычек со строками в руководстве пользователя AWS CLI.

Для создания трейла

Следующий пример create-trail создаёт многорегиональный трейл под названием Trail1 и указывает ведро S3.

aws cloudtrail create-trail \
    --name Trail1 \
    --s3-bucket-name amzn-s3-demo-bucket \
    --is-multi-region-trail

Вывод:

{
    "IncludeGlobalServiceEvents": true,
    "Name": "Trail1",
    "TrailARN": "arn:aws:cloudtrail:us-west-2:123456789012:trail/Trail1",
    "LogFileValidationEnabled": false,
    "IsMultiRegionTrail": true,
    "S3BucketName": "amzn-s3-demo-bucket"
}

Вывод

Name -> (строка)

Указывает имя трейла.

S3BucketName -> (строка)

Указывает имя Amazon S3-бакета, назначенного для публикации журнальных файлов.

S3KeyPrefix -> (строка)

Указывает префикс ключа Amazon S3, который следует за именем бакета, назначенного для доставки журнальных файлов. Дополнительная информация доступна в разделе Нахождение файлов журналов CloudTrail.

SnsTopicName -> (строка)

Это поле больше не используется. Используйте SnsTopicARN.

SnsTopicARN -> (строка)

Указывает ARN темы Amazon SNS, которую CloudTrail использует для отправки уведомлений при доставке журнальных файлов. Формат ARN темы:

arn:aws:sns:us-east-2:123456789012:MyTopic

IncludeGlobalServiceEvents -> (логическое значение)

Указывает, публикует ли трейл события от глобальных служб, таких как IAM, в журнальные файлы.

IsMultiRegionTrail -> (логическое значение)

Указывает, существует ли трейл в одной Регионе или во всех Регионах.

TrailARN -> (строка)

Указывает ARN созданного трейла. Формат ARN трейла:

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

LogFileValidationEnabled -> (логическое значение)

Указывает, включена ли проверка целостности журнальных файлов.

CloudWatchLogsLogGroupArn -> (строка)

Указывает Amazon Resource Name (ARN) группы журналов, в которую будут доставляться журналы CloudTrail.

CloudWatchLogsRoleArn -> (строка)

Указывает роль для конечной точки CloudWatch Logs, которую необходимо принять для записи в группу журналов пользователя.

KmsKeyId -> (строка)

Указывает ID ключа KMS, который шифрует события, доставляемые CloudTrail. Значение представляет собой полностью указанный ARN ключа KMS в следующем формате.

arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012

IsOrganizationTrail -> (логическое значение)

Указывает, является ли трейл трейлом организации.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API