Spec-Zone.ru › AWS CLI v2

[ aws . cloudtrail ]

update-trail

Описание

Обновляет параметры трейла, которые управляют тем, какие события вы регистрируете и как обрабатывать файлы журналов. Изменения в трейле не требуют остановки службы CloudTrail. Используйте этот параметр, чтобы назначить существующий бакет для доставки журналов. Если существующий бакет ранее был целевым для файлов журналов CloudTrail, для него существует политика IAM. UpdateTrail должен вызываться из региона, в котором был создан трейл; в противном случае возникает ошибка InvalidHomeRegionException.

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

Синтаксис

  update-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]
[--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 (строка)

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

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

Если Name представляет ARN трейла, он должен быть в следующем формате.

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

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

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

--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 (булево)

Указывает, применяется ли трейл только к текущему региону или ко всем регионам. По умолчанию — false. Если трейл существует только в текущем регионе, и это значение установлено в true, в других регионах будут созданы теневые трейлы (копии трейла). Если трейл существует во всех регионах, и это значение установлено в false, трейл останется в регионе, где он был создан, а его теневые копии в других регионах будут удалены. В качестве рекомендации рекомендуется использовать трейлы, которые регистрируют события во всех регионах.

--enable-log-file-validation | --no-enable-log-file-validation (булево)

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

Примечание

При отключении проверки целостности файла журнала цепочка файлов дайджестов разрывается через час. 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. По умолчанию — false, и не может быть true, если вызов не осуществляется от имени аккаунта Amazon Web Services, являющегося управляющим аккаунтом для организации в Organizations. Если трейл не является трейлом организации и это значение установлено в true, трейл будет создан во всех аккаунтах Amazon Web Services, принадлежащих организации. Если трейл является трейлом организации и это значение установлено в false, трейл останется в текущем аккаунте Amazon Web Services, но будет удален из всех аккаунтов-членов организации.

Примечание

Только управляющий аккаунт организации может преобразовать трейл организации в трейл не для организации или трейл не для организации в трейл организации.

--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
  • table
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Используйте определенный профиль из вашего файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/окружения.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включает/выключает цветной вывод.

  • on
  • off
  • auto

--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 User Guide.

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

Обновление трейла

Следующий update-trail пример обновляет трейл для использования существующего бакета для доставки журналов.

aws cloudtrail update-trail \
    --name Trail1 \
    --s3-bucket-name amzn-s3-demo-bucket

Вывод:

{
    "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, который следует за именем назначенного вами ведра для доставки файлов журналов. Дополнительная информация приведена в разделе Поиск файлов журналов IAM .

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 -> (строка)

Указывает идентификатор ключа 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