Spec-Zone.ru › AWS CLI v2

[ aws . configservice ]

put-configuration-aggregator

Описание

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

accountIds которые передаются, будут заменены существующими учётными записями. Если вы хотите добавить дополнительные учётные записи в агрегатор, вызовите DescribeConfigurationAggregators, чтобы получить предыдущие учётные записи, а затем добавьте новые.

Примечание

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

Если ваш тип источника — организация, вы должны быть вошли в систему в учётной записи управления или зарегистрированным делегированным администратором, и все функции должны быть включены в вашей организации. Если вызывающей стороной является учётная запись управления, Config вызывает EnableAwsServiceAccess API для включения интеграции между Config и Организациями. Если вызывающей стороной является зарегистрированный делегированный администратор, Config вызывает ListDelegatedAdministrators API для проверки того, является ли вызывающая сторона действительным делегированным администратором.

Чтобы зарегистрировать делегированного администратора, см. Регистрация делегированного администратора в Руководстве разработчика Config.

Примечание

Теги добавляются при создании и не могут быть обновлены с помощью этой операции

PutConfigurationAggregator — это идемпотентный API. Последующие запросы не создадут дублируемый ресурс, если он уже был создан. Если в последующем запросе есть другие значения tags, Config проигнорирует эти различия и обработает его как идемпотентный запрос предыдущего. В этом случае tags не будет обновлён, даже если они отличаются.

Для обновления тегов после создания используйте TagResource и UntagResource.

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

Синтаксис

  put-configuration-aggregator
--configuration-aggregator-name <value>
[--account-aggregation-sources <value>]
[--organization-aggregation-source <value>]
[--tags <value>]
[--aggregator-filters <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-aggregator-name (строка)

Имя агрегатора конфигурации.

--account-aggregation-sources (список)

Список объектов AccountAggregationSource.

(структура)

Коллекция учётных записей и регионов.

AccountIds -> (список)

12-знаковый идентификатор учётной записи, которая агрегируется.

(строка)

AllAwsRegions -> (булево)

Если true, агрегируются существующие регионы Config и будущие регионы.

AwsRegions -> (список)

Регионы источника, которые агрегируются.

(строка)

Синтаксис сокращённого представления:

AccountIds=string,string,AllAwsRegions=boolean,AwsRegions=string,string ...

Синтаксис JSON:

[
  {
    "AccountIds": ["string", ...],
    "AllAwsRegions": true|false,
    "AwsRegions": ["string", ...]
  }
  ...
]

--organization-aggregation-source (структура)

Объект OrganizationAggregationSource.

RoleArn -> (строка)

ARN роли IAM, используемой для получения данных Amazon Web Services Организации, связанных с учётной записью агрегатора.

AwsRegions -> (список)

Регионы источника, которые агрегируются.

(строка)

AllAwsRegions -> (булево)

Если true, агрегируются существующие регионы Config и будущие регионы.

Синтаксис сокращённого представления:

RoleArn=string,AwsRegions=string,string,AllAwsRegions=boolean

Синтаксис JSON:

{
  "RoleArn": "string",
  "AwsRegions": ["string", ...],
  "AllAwsRegions": true|false
}

--tags (список)

Массив объектов тега.

(структура)

Теги ресурса. Метаданные, которые вы применяете к ресурсу, чтобы помочь в их категоризации и организации. Каждый тег состоит из ключа и необязательного значения, которые вы определяете. Длина ключа тега может составлять максимум 128 символов, а длина значения тега — максимум 256 символов.

Key -> (строка)

Одна часть пары «ключ-значение», составляющей тег. Ключ — это общее обозначение, которое действует как категория для более конкретных значений тегов.

Value -> (строка)

Необязательная часть пары «ключ-значение», составляющей тег. Значение выступает в качестве описателя в категории тега (ключ).

Синтаксис сокращённого представления:

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--aggregator-filters (структура)

Объект для фильтрации записывателей конфигурации в агрегаторе. Требуется либо ResourceType, либо ServicePrincipal.

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

Объект для фильтрации записывателей конфигурации на основе типов ресурсов, включённых в область записи.

Type -> (строка)

Тип фильтра типа ресурса, который нужно применить. INCLUDE указывает, что список типов ресурсов в поле Value будет агрегирован, и другие типы ресурсов не будут отфильтрованы.

Value -> (список)

Список типов ресурсов через запятую для фильтрации агрегированных записывателей конфигурации.

(строка)

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

Объект для фильтрации записывателей конфигурации, связанных с услугой, в агрегаторе на основе связанной Amazon Web Services услуги.

Type -> (строка)

Тип фильтра принципала службы, который нужно применить. INCLUDE указывает, что список принципалов служб в поле Value будет агрегирован, и другие принципалы служб не будут отфильтрованы.

Value -> (список)

Список принципалов служб для связанных Amazon Web Services служб через запятую для фильтрации агрегированных записывателей конфигурации, связанных с услугой.

(строка)

Синтаксис сокращённого представления:

ResourceType={Type=string,Value=[string,string]},ServicePrincipal={Type=string,Value=[string,string]}

Синтаксис JSON:

{
  "ResourceType": {
    "Type": "INCLUDE",
    "Value": ["string", ...]
  },
  "ServicePrincipal": {
    "Type": "INCLUDE",
    "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
  • текст
  • таблица
  • 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.

Вывод

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

Возвращает объект ConfigurationAggregator.

ConfigurationAggregatorName -> (строка)

Имя агрегатора.

ConfigurationAggregatorArn -> (строка)

Amazon Resource Name (ARN) агрегатора.

AccountAggregationSources -> (список)

Предоставляет список учетных записей и регионов источников для агрегирования.

(структура)

Коллекция учетных записей и регионов.

AccountIds -> (список)

12-знаковый идентификатор учетной записи, подлежащей агрегированию.

(строка)

AllAwsRegions -> (булево)

Если значение true, агрегируются существующие регионы Config и будущие регионы.

AwsRegions -> (список)

Регионы-источники, подлежащие агрегированию.

(строка)

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

Предоставляет организацию и список регионов для агрегирования.

RoleArn -> (строка)

ARN роли IAM, используемой для получения данных Amazon Web Services Organization, связанных с учетной записью агрегатора.

AwsRegions -> (список)

Регионы-источники, подлежащие агрегированию.

(строка)

AllAwsRegions -> (булево)

Если значение true, агрегируются существующие регионы Config и будущие регионы.

CreationTime -> (временная метка)

Временная метка создания агрегатора конфигурации.

LastUpdatedTime -> (временная метка)

Время последнего обновления.

CreatedBy -> (строка)

Сервис Amazon Web Services, создавший агрегатор конфигурации.

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

Объект для фильтрации данных, которые вы указываете для агрегатора.

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

Объект для фильтрации записей конфигурационных рекордеров на основе типов ресурсов, включённых в диапазон записи.

Type -> (строка)

Тип фильтра по типам ресурсов. INCLUDE указывает, что список типов ресурсов в поле Value будет агрегирован, и другие типы ресурсов не будут отфильтрованы.

Value -> (список)

Список типов ресурсов через запятую для фильтрации агрегированных записей конфигурационных рекордеров.

(строка)

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

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

Type -> (строка)

Тип фильтра по принципалам сервиса. INCLUDE указывает, что список принципалов сервиса в поле Value будет агрегирован, и другие принципалы сервиса не будут отфильтрованы.

Value -> (список)

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

(строка)

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

Spec-Zone.ru

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