Spec-Zone.ru › AWS CLI v2

[ aws . cloudformation ]

set-type-configuration

Описание

Указывает данные конфигурации для зарегистрированного расширения CloudFormation в заданном аккаунте и регионе.

Чтобы просмотреть текущие данные конфигурации для расширения, обратитесь к элементу ConfigurationSchema команды DescribeType . Дополнительную информацию см. в разделе Редактирование данных конфигурации расширений в вашем аккаунте в руководстве CloudFormation User Guide.

Предупреждение

Настоятельно рекомендуется использовать динамические ссылки для ограничения определения конфигурации, содержащей конфиденциальные данные, такие как учетные данные сторонних поставщиков. Подробнее о динамических ссылках см. в разделе Указание значений, хранящихся в других сервисах, с помощью динамических ссылок в руководстве CloudFormation User Guide.

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

Синтаксис

  set-type-configuration
[--type-arn <value>]
--configuration <value>
[--configuration-alias <value>]
[--type-name <value>]
[--type <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]

Параметры

--type-arn (строка)

Amazon Resource Name (ARN) расширения в данном аккаунте и регионе.

Для общедоступных расширений это будет ARN, присвоенный при вызове операции ActivateType API в этом аккаунте и регионе. Для частных расширений это будет ARN, присвоенный при вызове операции RegisterType API в этом аккаунте и регионе.

Не включайте суффикс версии расширения в конце ARN. Вы можете установить конфигурацию для расширения, но не для конкретной версии расширения.

--configuration (строка)

Данные конфигурации расширения в этом аккаунте и регионе.

Данные конфигурации должны быть отформатированы как JSON и должны соответствовать схеме, возвращаемой элементом ConfigurationSchema ответа команды DescribeType . Дополнительную информацию см. в разделе Определение конфигурации расширения на уровне аккаунта в руководстве CloudFormation Command Line Interface (CLI) User Guide.

--configuration-alias (строка)

Псевдоним для ссылок на данные конфигурации этого расширения.

Условие: Указание псевдонима конфигурации обязательно при установке конфигурации для расширения типа ресурса.

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

Имя расширения.

Условие: Вы должны указать ConfigurationArn или Type и TypeName.

--type (строка)

Тип расширения.

Условие: Вы должны указать ConfigurationArn или Type и TypeName.

Возможные значения:

  • RESOURCE
  • MODULE
  • HOOK

--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 User Guide.

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

Чтобы настроить данные

Следующий set-type-configuration пример указывает данные конфигурации для зарегистрированного расширения CloudFormation в заданном аккаунте и регионе.

aws cloudformation set-type-configuration \
    --region us-west-2 \
    --type RESOURCE \
    --type-name Example::Test::Type \
    --configuration-alias default \
    --configuration "{\"CredentialKey\": \"testUserCredential\"}"

Вывод:

{
    "ConfigurationArn": "arn:aws:cloudformation:us-west-2:123456789012:type-configuration/resource/Example-Test-Type/default"
}

Дополнительную информацию см. в разделе Использование реестра AWS CloudFormation в руководстве AWS CloudFormation User Guide.

Вывод

ConfigurationArn -> (строка)

Amazon Resource Name (ARN) данных конфигурации в данном аккаунте и регионе.

Условие: Вы должны указать ConfigurationArn или Type и TypeName.

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

Spec-Zone.ru

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