Spec-Zone.ru › AWS CLI v2

[ aws . securityhub ]

start-configuration-policy-association

Описание

Связывает целевой аккаунт, организационную единицу или корень с указанной конфигурацией. Цель может быть связана с политикой конфигурации или с самостоятельным поведением. Только делегированный администратор Security Hub может вызвать эту операцию из домашнего региона.

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

Синтаксис

  start-configuration-policy-association
--configuration-policy-identifier <value>
--target <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-policy-identifier (строка)

Amazon Resource Name (ARN) политики конфигурации, универсальный уникальный идентификатор (UUID) политики конфигурации или значение SELF_MANAGED_SECURITY_HUB для самостоятельной конфигурации.

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

Идентификатор целевого аккаунта, организационной единицы или корня для связывания с указанной конфигурацией.

Примечание

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

AccountId -> (строка)

Идентификатор аккаунта Amazon Web Services целевого аккаунта.

OrganizationalUnitId -> (строка)

Идентификатор организационной единицы целевой организационной единицы.

RootId -> (строка)

Идентификатор корня организации.

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

AccountId=string,OrganizationalUnitId=string,RootId=string

Синтаксис JSON:

{
  "AccountId": "string",
  "OrganizationalUnitId": "string",
  "RootId": "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
  • 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 для получения дополнительной информации.

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

Пример 1: Связывание политики конфигурации

Следующий start-configuration-policy-association пример связывает указанную политику конфигурации с указанной организационной единицей. Конфигурация может быть связана с целевым аккаунтом, организационной единицей или корнем.

aws securityhub start-configuration-policy-association \
    --configuration-policy-identifier "arn:aws:securityhub:eu-central-1:123456789012:configuration-policy/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333" \
    --target '{"OrganizationalUnitId": "ou-6hi7-8j91kl2m"}'

Вывод:

{
    "ConfigurationPolicyId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
    "TargetId": "ou-6hi7-8j91kl2m",
    "TargetType": "ORGANIZATIONAL_UNIT",
    "AssociationType": "APPLIED",
    "UpdatedAt": "2023-11-29T17:40:52.468000+00:00",
    "AssociationStatus": "PENDING"
}

Для получения дополнительной информации см. Создание и связывание политик конфигурации Security Hub в Руководстве пользователя AWS Security Hub.

Пример 2: Связывание самостоятельной конфигурации

Следующий start-configuration-policy-association пример связывает самостоятельную конфигурацию с указанным аккаунтом.

aws securityhub start-configuration-policy-association \
    --configuration-policy-identifier "SELF_MANAGED_SECURITY_HUB" \
    --target '{"OrganizationalUnitId": "123456789012"}'

Вывод:

{
    "ConfigurationPolicyId": "SELF_MANAGED_SECURITY_HUB",
    "TargetId": "123456789012",
    "TargetType": "ACCOUNT",
    "AssociationType": "APPLIED",
    "UpdatedAt": "2023-11-29T17:40:52.468000+00:00",
    "AssociationStatus": "PENDING"
}

Для получения дополнительной информации см. Создание и связывание политик конфигурации Security Hub в Руководстве пользователя AWS Security Hub.

Вывод

ConfigurationPolicyId -> (строка)

UUID политики конфигурации.

TargetId -> (строка)

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

TargetType -> (строка)

Указывает, является ли целевой объект аккаунтом Amazon Web Services, организационной единицей или корнем организации.

AssociationType -> (строка)

Указывает, была ли связь между указанной целью и конфигурацией непосредственно применена делегированным администратором Security Hub или унаследована от родительской структуры.

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

Дата и время (UTC в формате ISO 8601), когда ассоциация политики конфигурации была последний раз обновлена.

AssociationStatus -> (строка)

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

AssociationStatusMessage -> (строка)

Объяснение для значения FAILED для AssociationStatus.

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

Spec-Zone.ru

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