Spec-Zone.ru › AWS CLI v2

[ aws . cloudcontrol ]

create-resource

Описание

Создаёт указанный ресурс. Дополнительная информация доступна в руководстве пользователя API Cloud Control Amazon Web Services, раздел «Создание ресурса».

После отправки запроса на создание ресурса, можно отследить его выполнение, вызвав GetResourceRequestStatus с помощью RequestToken типа ProgressEvent, возвращённого CreateResource.

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

Синтаксис

  create-resource
--type-name <value>
[--type-version-id <value>]
[--role-arn <value>]
[--client-token <value>]
--desired-state <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-name (строка)

Имя типа ресурса.

--type-version-id (строка)

Для частных типов ресурсов, версия типа, используемая в данной операции с ресурсом. Если версия ресурса не указана, CloudFormation использует версию по умолчанию.

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

Amazon Resource Name (ARN) роли Identity and Access Management (IAM) для использования API Cloud Control при выполнении операции с ресурсом. Указанная роль должна иметь необходимые разрешения для данной операции. Необходимые разрешения для каждого обработчика событий определены в разделе «handlers» схемы определения типа ресурса.

Если роль не указана, Cloud Control API использует временную сессию, созданную с использованием ваших учетных данных Amazon Web Services.

Дополнительная информация доступна в руководстве пользователя API Cloud Control Amazon Web Services, раздел «Указание учетных данных».

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

Уникальный идентификатор для обеспечения идемпотентности запроса на создание ресурса. В качестве рекомендации, укажите этот токен для обеспечения идемпотентности, чтобы Amazon Web Services Cloud Control API мог чётко различать повторные запросы и новые запросы на создание ресурса. Возможно, потребуется повторить запрос на создание ресурса, чтобы убедиться, что он был успешно получен.

Токен клиента действителен в течение 36 часов после использования. По истечении этого срока, запрос на создание ресурса с тем же токеном клиента рассматривается как новый запрос.

Если токен клиента не указан, он генерируется для включения в запрос.

Дополнительная информация доступна в руководстве пользователя API Cloud Control Amazon Web Services, раздел «Обеспечение уникальности запросов на операции с ресурсами».

--desired-state (строка)

Структурированный формат данных, представляющий желаемое состояние ресурса, состоящий из свойств ресурса и их желаемых значений.

Примечание

Cloud Control API в настоящее время поддерживает JSON в качестве структурированного формата данных.

Укажите желаемое состояние как одно из следующих:

  • JSON-блок
  • Локальный путь, содержащий желаемое состояние в формате JSON

Дополнительная информация доступна в руководстве пользователя API Cloud Control Amazon Web Services, раздел «Составление желаемого состояния ресурса».

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

--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, раздел «Использование кавычек со строками».

Создание ресурса

Следующий пример создаёт ресурс AWS::Kinesis::Stream, названный ResourceExample, с периодом удержания 168 часов и количеством разделяющих сегментов (shard) 3.

aws cloudcontrol create-resource \
    --type-name AWS::Kinesis::Stream \
    --desired-state "{\"Name\": \"ResourceExample\",\"RetentionPeriodHours\":168, \"ShardCount\":3}"

Вывод:

{
    "ProgressEvent": {
        "EventTime": 1632506656.706,
        "TypeName": "AWS::Kinesis::Stream",
        "OperationStatus": "IN_PROGRESS",
        "Operation": "CREATE",
        "Identifier": "ResourceExample",
        "RequestToken": "20999d87-e304-4725-ad84-832dcbfd7fc5"
    }
}

Дополнительная информация доступна в руководстве пользователя API Cloud Control, раздел «Создание ресурса».

Вывод

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

Представляет текущий статус запроса на создание ресурса.

После отправки запроса на создание ресурса, можно отследить его выполнение, вызвав GetResourceRequestStatus с помощью RequestToken типа ProgressEvent, возвращённого CreateResource.

TypeName -> (строка)

Имя типа ресурса, используемого в операции.

Identifier -> (строка)

Основной идентификатор ресурса.

Примечание

В некоторых случаях идентификатор ресурса может быть доступен до того, как операция с ресурсом достигнет статуса SUCCESS .

RequestToken -> (строка)

Уникальный токен, представляющий запрос на операцию с ресурсом.

Используйте RequestToken с GetResourceRequestStatus, чтобы получить текущий статус запроса на операцию с ресурсом.

HooksRequestToken -> (строка)

Уникальный токен, представляющий операцию Hooks для запроса.

Operation -> (строка)

Тип операции с ресурсом.

OperationStatus -> (строка)

Текущий статус запроса на операцию с ресурсом.

  • PENDING : Операция с ресурсом ещё не началась.
  • IN_PROGRESS : Операция с ресурсом в процессе выполнения.
  • SUCCESS : Операция с ресурсом успешно завершена.
  • FAILED : Операция с ресурсом завершилась с ошибкой. Обратитесь к коду ошибки и сообщению об ошибке для получения дополнительной информации.
  • CANCEL_IN_PROGRESS : Операция с ресурсом в процессе отмены.
  • CANCEL_COMPLETE : Операция с ресурсом отменена.

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

Время инициации запроса на операцию с ресурсом.

ResourceModel -> (строка)

JSON-строка, содержащая модель ресурса, состоящая из каждого свойства ресурса и его текущего значения.

StatusMessage -> (строка)

Любое сообщение, объясняющее текущий статус.

ErrorCode -> (строка)

Для запросов со статусом FAILED, соответствующий код ошибки.

Для определений кодов ошибок обратитесь к кодам ошибок обработчика в «Руководстве пользователя командной строки интерфейса CloudFormation для разработки расширений».

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

Время следующего запроса статуса данного запроса на операцию с ресурсом.

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

Spec-Zone.ru

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