Spec-Zone.ru › AWS CLI v2

[ aws . securitylake ]

update-subscriber

Описание

Обновляет существующую подписку для указанного идентификатора учётной записи Amazon Security Lake. Вы можете обновить подписчика, изменив источники, из которых подписчик потребляет данные.

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

Синтаксис

  update-subscriber
[--sources <value>]
[--subscriber-description <value>]
--subscriber-id <value>
[--subscriber-identity <value>]
[--subscriber-name <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]

Параметры

--sources (список)

Поддерживаемые сервисы Amazon Web Services, из которых собираются журналы и события. Список поддерживаемых сервисов Amazon Web Services см. в руководстве пользователя Amazon Security Lake.

(структура помеченных объединений)

Поддерживаемые типы источников, из которых собираются журналы и события в Amazon Security Lake. Список поддерживаемых сервисов Amazon Web Services см. в руководстве пользователя Amazon Security Lake.

Примечание

Это структура помеченных объединений. Только один из следующих верхних ключей может быть установлен: awsLogSource, customLogSource.

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

Amazon Security Lake поддерживает сбор журналов и событий для нативно поддерживаемых сервисов Amazon Web Services. Дополнительную информацию см. в руководстве пользователя Amazon Security Lake.

sourceName -> (строка)

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

sourceVersion -> (строка)

Версия источника Amazon Web Services. Это значение должно быть уникальным в регионе.

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

Amazon Security Lake поддерживает типы пользовательских источников. Дополнительную информацию см. в руководстве пользователя Amazon Security Lake.

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

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

Краткая форма синтаксиса:

awsLogSource={sourceName=string,sourceVersion=string},customLogSource={attributes={crawlerArn=string,databaseArn=string,tableArn=string},provider={location=string,roleArn=string},sourceName=string,sourceVersion=string} ...

Синтаксис JSON:

[
  {
    "awsLogSource": {
      "sourceName": "ROUTE53"|"VPC_FLOW"|"SH_FINDINGS"|"CLOUD_TRAIL_MGMT"|"LAMBDA_EXECUTION"|"S3_DATA"|"EKS_AUDIT"|"WAF",
      "sourceVersion": "string"
    },
    "customLogSource": {
      "attributes": {
        "crawlerArn": "string",
        "databaseArn": "string",
        "tableArn": "string"
      },
      "provider": {
        "location": "string",
        "roleArn": "string"
      },
      "sourceName": "string",
      "sourceVersion": "string"
    }
  }
  ...
]

--subscriber-description (строка)

Описание подписчика учётной записи Security Lake.

--subscriber-id (строка)

Значение, созданное Security Lake, уникально идентифицирующее вашу подписку.

--subscriber-identity (структура)

Идентичность Amazon Web Services, используемая для доступа к данным.

externalId -> (строка)

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

principal -> (строка)

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

Краткая форма синтаксиса:

externalId=string,principal=string

Синтаксис JSON:

{
  "externalId": "string",
  "principal": "string"
}

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

Имя подписчика учётной записи Security Lake.

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

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (булево)

Отключить автоматическое запросы параметров ввода CLI.

Примеры

Примечание

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

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

Обновление подписчика Amazon Security Lake.

Следующий update-subscriber пример обновляет источники доступа к данным Security Lake для конкретного подписчика Security Lake.

aws securitylake update-subscriber \
    --subscriber-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

Вывод:

{
    "subscriber": {
        "accessTypes": [
            "LAKEFORMATION"
        ],
        "createdAt": "2024-04-19T15:19:44.421803+00:00",
        "resourceShareArn": "arn:aws:ram:eu-west-2:123456789012:resource-share/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
        "resourceShareName": "LakeFormation-V3-TKJGBHCKTZ-123456789012",
        "sources": [
            {
                "awsLogSource": {
                    "sourceName": "LAMBDA_EXECUTION",
                    "sourceVersion": "1.0"
                }
            },
            {
                "awsLogSource": {
                    "sourceName": "EKS_AUDIT",
                    "sourceVersion": "2.0"
                }
            },
            {
                "awsLogSource": {
                    "sourceName": "ROUTE53",
                    "sourceVersion": "1.0"
                }
            },
            {
                "awsLogSource": {
                    "sourceName": "SH_FINDINGS",
                    "sourceVersion": "1.0"
                }
            },
            {
                "awsLogSource": {
                    "sourceName": "VPC_FLOW",
                    "sourceVersion": "1.0"
                }
            },
            {
                "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-E1WG1ZNPRXT0D4"
                    },
                    "sourceName": "testCustom2"
                }
            }
        ],
        "subscriberArn": "arn:aws:securitylake:eu-west-2:123456789012:subscriber/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
        "subscriberId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
        "subscriberIdentity": {
            "externalId": "123456789012",
            "principal": "123456789012"
        },
        "subscriberName": "test",
        "subscriberStatus": "ACTIVE",
        "updatedAt": "2024-07-18T20:47:37.098000+00:00"
    }
}

Дополнительную информацию см. в разделе «Управление подписчиками» в руководстве пользователя Amazon Security Lake.

Вывод

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

Обновленная информация о подписчике.

accessTypes -> (список)

Вы можете настроить уведомление подписчиков о новых объектах с помощью очереди Amazon Simple Queue Service (Amazon SQS) или посредством отправки сообщений на HTTPS-точку входа, предоставленную подписчиком.

Подписчики могут потреблять данные, напрямую запрашивая таблицы Lake Formation в вашем Amazon S3-бакете через такие сервисы, как Amazon Athena. Этот тип подписки определен как LAKEFORMATION.

(строка)

createdAt -> (отметка времени)

Дата и время создания подписчика.

resourceShareArn -> (строка)

Идентификатор ресурса Amazon (ARN), уникально определяющий общий ресурс Amazon Web Services RAM. Перед принятием приглашения на общий ресурс RAM вы можете просмотреть подробности об этом общем ресурсе.

Это поле доступно только для подписчиков Lake Formation, созданных после 8 марта 2023 года.

resourceShareName -> (строка)

Название общего ресурса.

roleArn -> (строка)

Идентификатор ресурса Amazon (ARN), указывающий роль подписчика.

s3BucketArn -> (строка)

ARN для Amazon S3-бакета.

sources -> (список)

Amazon Security Lake поддерживает сбор журналов и событий для нативно поддерживаемых служб Amazon Web Services. Дополнительную информацию см. в руководстве пользователя Amazon Security Lake.

(структура помеченного объединения)

Поддерживаемые типы источников, из которых собираются журналы и события в Amazon Security Lake. Список поддерживаемых служб Amazon Web Services см. в руководстве пользователя Amazon Security Lake.

Примечание

Это структура помеченного объединения. Можно установить только один из следующих ключей верхнего уровня: awsLogSource, customLogSource.

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

Amazon Security Lake поддерживает сбор журналов и событий для нативно поддерживаемых служб Amazon Web Services. Дополнительную информацию см. в руководстве пользователя Amazon Security Lake.

sourceName -> (строка)

Название источника Amazon Web Services. Должно быть уникальным в данном регионе.

sourceVersion -> (строка)

Версия источника Amazon Web Services. Должно быть уникальным в данном регионе.

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

Amazon Security Lake поддерживает типы пользовательских источников. Дополнительную информацию см. в руководстве пользователя Amazon Security Lake.

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

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

subscriberArn -> (строка)

ARN подписчика учетной записи Amazon Security Lake.

subscriberDescription -> (строка)

Описание подписчика учетной записи. Описание подписчика включает subscriberName , accountID , externalID и subscriberId .

subscriberEndpoint -> (строка)

Точка входа подписчика, в которую публикуются сообщения об исключениях.

subscriberId -> (строка)

Идентификатор подписчика учетной записи Amazon Security Lake.

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

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

externalId -> (строка)

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

principal -> (строка)

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

subscriberName -> (строка)

Имя вашей учетной записи Amazon Security Lake.

subscriberStatus -> (строка)

Статус подписчика учетной записи Amazon Security Lake.

updatedAt -> (отметка времени)

Дата и время последнего обновления подписчика.

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

Spec-Zone.ru

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