register-type

Описание

Регистрирует расширение в службе CloudFormation. Регистрация расширения делает его доступным для использования в шаблонах CloudFormation в вашей учетной записи Amazon Web Services и включает:

• Проверку схемы расширения.
• Определение обработчиков, если таковые указаны для расширения.
• Доступ к расширению в вашей учетной записи.

Дополнительную информацию о разработке расширений и их подготовке к регистрации см. в руководстве CloudFormation Command Line Interface (CLI) User Guide, раздел «Создание типов ресурсов с помощью CloudFormation CLI».

Одновременно можно зарегистрировать не более 50 версий расширений ресурсов. Это ограничение действует на каждую учетную запись и регион. Используйте DeregisterType для дерегистрации определённых версий расширений при необходимости.

После инициирования запроса регистрации с помощью RegisterType вы можете использовать DescribeTypeRegistration для отслеживания хода запроса регистрации.

После регистрации частного расширения в вашей учетной записи и регионе используйте SetTypeConfiguration для указания свойств конфигурации расширения. Дополнительную информацию см. в руководстве CloudFormation User Guide, раздел «Редактирование данных конфигурации расширений в вашей учетной записи».

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

Синтаксис

  register-type
[--type <value>]
--type-name <value>
--schema-handler-package <value>
[--logging-config <value>]
[--execution-role-arn <value>]
[--client-request-token <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 (строка)

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

--schema-handler-package (строка)

--logging-config (структура)

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

LogRoleArn=string,LogGroupName=string

Синтаксис JSON:

{
  "LogRoleArn": "string",
  "LogGroupName": "string"
}

--execution-role-arn (строка)

--client-request-token (строка)

--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-stream

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

Примеры

Для регистрации типа ресурса

Следующий пример register-type регистрирует указанный тип ресурса как частный тип ресурса в учетной записи пользователя.

aws cloudformation register-type \
    --type-name My::Organization::ResourceName \
    --schema-handler-package s3://bucket_name/my-organization-resource_name.zip \
    --type RESOURCE

Вывод:

{
    "RegistrationToken": "f5525280-104e-4d35-bef5-8f1f1example"
}

Дополнительную информацию см. в разделе «Регистрация поставщиков ресурсов» в руководстве CloudFormation Command Line Interface User Guide for Type Development.

Вывод

RegistrationToken -> (строка)