Spec-Zone.ru › AWS CLI v2

[ aws . configservice ]

put-delivery-channel

Описание

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

Вы можете использовать эту операцию для создания нового канала доставки или для обновления Amazon S3-бакета и Amazon SNS-темы существующего канала доставки.

Дополнительную информацию см. в разделе ` Работа с каналом доставки https://docs.aws.amazon.com/config/latest/developerguide/manage-delivery-channel.html`__ в руководстве разработчика Config.

Примечание

Один канал доставки на учётную запись в регионе

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

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

Синтаксис

  put-delivery-channel
--delivery-channel <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]

Параметры

--delivery-channel (структура)

Объект для канала доставки. Канал доставки отправляет уведомления и обновлённые состояния конфигурации.

name -> (строка)

Имя канала доставки. По умолчанию Config присваивает имя «default» при создании канала доставки. Чтобы изменить имя канала доставки, необходимо использовать действие DeleteDeliveryChannel для удаления текущего канала доставки, а затем использовать команду PutDeliveryChannel для создания канала доставки с желаемым именем.

s3BucketName -> (строка)

Имя Amazon S3-бакета, в который Config предоставляет снимки конфигурации и файлы истории конфигурации.

Если вы указываете бакет, принадлежащий другой учётной записи Amazon Web Services, этот бакет должен иметь политики, которые предоставляют Config права доступа. Дополнительную информацию см. в разделе Разрешения для Amazon S3-бакета в руководстве разработчика Config.

s3KeyPrefix -> (строка)

Префикс для указанного Amazon S3-бакета.

s3KmsKeyArn -> (строка)

Amazon Resource Name (ARN) ключа управления ключами (KMS) Key Management Service (KMS), используемого для шифрования объектов, предоставленных Config. Должен принадлежать тому же региону, что и целевой S3-баккет.

snsTopicARN -> (строка)

Amazon Resource Name (ARN) темы Amazon SNS, в которую Config отправляет уведомления об изменениях конфигурации.

Если вы выбираете тему из другой учётной записи, тема должна иметь политики, которые предоставляют Config права доступа. Дополнительную информацию см. в разделе Разрешения для Amazon SNS-темы в руководстве разработчика Config.

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

Параметры того, как часто Config предоставляет снимки конфигурации в Amazon S3-бакет.

deliveryFrequency -> (строка)

Частота, с которой Config предоставляет снимки конфигурации.

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

name=string,s3BucketName=string,s3KeyPrefix=string,s3KmsKeyArn=string,snsTopicARN=string,configSnapshotDeliveryProperties={deliveryFrequency=string}

Синтаксис JSON:

{
  "name": "string",
  "s3BucketName": "string",
  "s3KeyPrefix": "string",
  "s3KmsKeyArn": "string",
  "snsTopicARN": "string",
  "configSnapshotDeliveryProperties": {
    "deliveryFrequency": "One_Hour"|"Three_Hours"|"Six_Hours"|"Twelve_Hours"|"TwentyFour_Hours"
  }
}

--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
  • таблица
  • 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 в руководстве пользователя AWS CLI.

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

Для создания канала доставки

Следующая команда предоставляет настройки канала доставки в формате JSON:

aws configservice put-delivery-channel --delivery-channel file://deliveryChannel.json

Файл deliveryChannel.json указывает атрибуты канала доставки:

{
    "name": "default",
    "s3BucketName": "config-bucket-123456789012",
    "snsTopicARN": "arn:aws:sns:us-east-1:123456789012:config-topic",
    "configSnapshotDeliveryProperties": {
        "deliveryFrequency": "Twelve_Hours"
    }
}

В этом примере установлены следующие атрибуты:

  • name - Имя канала доставки. По умолчанию AWS Config присваивает имя default новому каналу доставки.

    Вы не можете обновить имя канала доставки с помощью команды put-delivery-channel. Для получения шагов по изменению имени см. Переименование канала доставки.

  • s3BucketName - Имя Amazon S3-бакета, в который AWS Config предоставляет снимки конфигурации и файлы истории конфигурации.

    Если вы указываете бакет, принадлежащий другой учётной записи AWS, этот бакет должен иметь политики, которые предоставляют AWS Config права доступа. Дополнительную информацию см. в разделе Разрешения для Amazon S3-бакета.

  • snsTopicARN - Amazon Resource Name (ARN) темы Amazon SNS, в которую AWS Config отправляет уведомления об изменениях конфигурации.

    Если вы выбираете тему из другой учётной записи, тема должна иметь политики, которые предоставляют AWS Config права доступа. Дополнительную информацию см. в разделе Разрешения для Amazon SNS-темы.

  • configSnapshotDeliveryProperties - Содержит атрибут deliveryFrequency, который задаёт, как часто AWS Config предоставляет снимки конфигурации и как часто он вызывает оценки для периодических правил Config.

Если команда выполнена успешно, AWS Config не возвращает выходных данных. Чтобы проверить настройки вашего канала доставки, выполните команду describe-delivery-channels.

Вывод

Нет

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

Spec-Zone.ru

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