Spec-Zone.ru › AWS CLI v2

[ aws . securitylake ]

создание-пользовательского-источника-логирования

Описание

Добавляет сторонний пользовательский источник в Amazon Security Lake из региона Amazon Web Services, где вы хотите создать пользовательский источник. Security Lake может собирать журналы и события из сторонних пользовательских источников. После создания соответствующей роли IAM для вызова обходчика Glue используйте этот API для добавления имени пользовательского источника в Security Lake. Данная операция создает раздел в ведре Amazon S3 для Security Lake в качестве целевого расположения для файлов журналов из пользовательского источника. Кроме того, эта операция также создает связанную таблицу Glue и обходчик Glue.

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

Синтаксис

  create-custom-log-source
--configuration <value>
[--event-classes <value>]
--source-name <value>
[--source-version <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]

Параметры

--configuration (структура)

Настройка, используемая для стороннего пользовательского источника.

crawlerConfiguration -> (структура)

Настройка, используемая для обходчика Glue для стороннего пользовательского источника.

roleArn -> (строка)

Идентификатор ресурса Amazon (ARN) роли управления доступом и идентификацией (IAM) для использования обходчиком Glue. Рекомендуемые политики IAM:

  • Управляемая политика AWSGlueServiceRole
  • Пользовательская политика, предоставляющая доступ к вашему Amazon S3 Data Lake

providerIdentity -> (структура)

Идентификатор поставщика журналов для стороннего пользовательского источника.

externalId -> (строка)

Внешний идентификатор, используемый для установления доверительных отношений с идентификатором Amazon Web Services.

principal -> (строка)

Принципал идентификатора Amazon Web Services.

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

crawlerConfiguration={roleArn=string},providerIdentity={externalId=string,principal=string}

Синтаксис JSON:

{
  "crawlerConfiguration": {
    "roleArn": "string"
  },
  "providerIdentity": {
    "externalId": "string",
    "principal": "string"
  }
}

--event-classes (список)

Классы событий Open Cybersecurity Schema Framework (OCSF), которые описывают тип данных, которые пользовательский источник будет отправлять в Security Lake. Список поддерживаемых классов событий см. в руководстве пользователя Amazon Security Lake.

(строка)

Синтаксис:

"string" "string" ...

--source-name (строка)

Укажите имя стороннего пользовательского источника. Оно должно быть уникальным в данном регионе. sourceName, которое вы вводите здесь, используется в имени LogProviderRole, которое следует соглашению AmazonSecurityLake-Provider-{name of the custom source}-{region}. Вы должны использовать имя CustomLogSource, которое короче или равно 20 символам. Это гарантирует, что имя LogProviderRole не превышает 64 символа.

--source-version (строка)

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

--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
  • текст
  • таблица
  • 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.

Для добавления пользовательского источника как источника Amazon Security Lake

Следующий create-custom-logsource пример добавляет пользовательский источник как источник Security Lake в указанной учетной записи поставщика журналов и указанном регионе.

aws securitylake create-custom-log-source \
    --source-name "VPC_FLOW" \
    --event-classes '["DNS_ACTIVITY", "NETWORK_ACTIVITY"]' \
    --configuration '{"crawlerConfiguration": {"roleArn": "arn:aws:glue:eu-west-2:123456789012:crawler/E1WG1ZNPRXT0D4"},"providerIdentity": {"principal": "029189416600","externalId": "123456789012"}}' --region "us-east-1"

Вывод:

{
    "customLogSource": {
        "attributes": {
            "crawlerArn": "arn:aws:glue:eu-west-2:123456789012:crawler/E1WG1ZNPRXT0D4",
            "databaseArn": "arn:aws:glue:eu-west-2:123456789012:database/E1WG1ZNPRXT0D4",
            "tableArn": "arn:aws:glue:eu-west-2:123456789012:table/E1WG1ZNPRXT0D4"
        },
        "provider": {
            "location": "amzn-s3-demo-bucket--usw2-az1--x-s3",
            "roleArn": "arn:aws:iam::123456789012:role/AmazonSecurityLake-Provider-testCustom2-eu-west-2"
        },
        "sourceName": "testCustom2"
        "sourceVersion": "2.0"
    }
}

Для получения дополнительной информации см. Добавление пользовательского источника в руководстве пользователя Amazon Security Lake.

Вывод

source -> (структура)

Сторонний пользовательский источник, который был создан.

attributes -> (структура)

Атрибуты стороннего пользовательского источника.

crawlerArn -> (строка)

ARN обходчика Glue.

databaseArn -> (строка)

ARN базы данных Glue, где записываются результаты, например: arn:aws:daylight:us-east-1::database/sometable/*.

tableArn -> (строка)

ARN таблицы Glue.

provider -> (структура)

Подробности поставщика журналов для стороннего пользовательского источника.

location -> (строка)

Расположение раздела в ведре Amazon S3 для Security Lake.

roleArn -> (строка)

ARN роли IAM, которая будет использоваться сущностью для помещения журналов в раздел вашего пользовательского источника. Security Lake применит соответствующие политики доступа к этой роли, но вы должны сначала вручную создать политику доверия для этой роли. Имя роли IAM должно начинаться с текста ‘Security Lake’. Роль IAM должна доверять logProviderAccountId для принятия роли.

sourceName -> (строка)

Имя стороннего пользовательского источника. Оно должно быть уникальным в данном регионе.

sourceVersion -> (строка)

Версия стороннего пользовательского источника. Она должна быть уникальной в данном регионе.

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

Spec-Zone.ru

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