Spec-Zone.ru › AWS CLI v2

[ aws . servicecatalog ]

create-product

Описание

Создает продукт.

Делегированный администратор имеет право вызывать эту команду.

Пользователь или роль, выполняющая эту операцию, должна иметь разрешение политики cloudformation:GetTemplate IAM. Это разрешение политики требуется при использовании источника шаблона ImportFromPhysicalId в разделе данных информации.

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

Сводка

  create-product
[--accept-language <value>]
--name <value>
--owner <value>
[--description <value>]
[--distributor <value>]
[--support-description <value>]
[--support-email <value>]
[--support-url <value>]
--product-type <value>
[--tags <value>]
[--provisioning-artifact-parameters <value>]
[--idempotency-token <value>]
[--source-connection <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]

Параметры

--accept-language (string)

Код языка.

  • jp - Японский
  • zh - Китайский

--name (string)

Имя продукта.

--owner (string)

Владелец продукта.

--description (string)

Описание продукта.

--distributor (string)

Дистрибьютор продукта.

--support-description (string)

Информация о поддержке продукта.

--support-email (string)

Контактный адрес электронной почты для поддержки продукта.

--support-url (string)

Контактный URL для поддержки продукта.

^https?:\/\// / - шаблон, используемый для проверки SupportUrl.

--product-type (string)

Тип продукта.

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

  • CLOUD_FORMATION_TEMPLATE
  • MARKETPLACE
  • TERRAFORM_OPEN_SOURCE
  • TERRAFORM_CLOUD
  • EXTERNAL

--tags (list)

Один или несколько тегов.

(структура)

Информация о теге. Тег представляет собой пару "ключ-значение". Теги распространяются на ресурсы, созданные при подготовке продукта.

Ключ -> (string)

Ключ тега.

Значение -> (string)

Значение для этого ключа.

Краткий синтаксис:

Key=string,Value=string ...

Синтаксис JSON:

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

--provisioning-artifact-parameters (structure)

Конфигурация артефакта подготовки.

Имя -> (string)

Имя артефакта подготовки (например, v1 v2beta). Пробелы не допускаются.

Описание -> (string)

Описание артефакта подготовки, включая его отличие от предыдущего артефакта подготовки.

Информация -> (map)

Укажите источник шаблона одним из следующих параметров, но не обоими. Принимаются ключи: [ LoadTemplateFromURL , ImportFromPhysicalId ]

URL-адрес шаблона CloudFormation в Amazon S3 или GitHub в формате JSON. Укажите URL-адрес в формате JSON следующим образом:

"LoadTemplateFromURL": "https://s3.amazonaws.com/cf-templates-ozkq9d3hgiq2-us-east-1/..."

ImportFromPhysicalId : физический идентификатор ресурса, содержащего шаблон. В настоящее время поддерживается только ARN стека CloudFormation. Укажите физический идентификатор в формате JSON следующим образом: ImportFromPhysicalId: “arn:aws:cloudformation:[us-east-1]:[accountId]:stack/[StackName]/[resourceId]

ключ -> (string)

значение -> (string)

Тип -> (string)

Тип артефакта подготовки.

  • CLOUD_FORMATION_TEMPLATE - шаблон CloudFormation
  • TERRAFORM_OPEN_SOURCE - файл конфигурации Terraform с открытым исходным кодом
  • TERRAFORM_CLOUD - файл конфигурации Terraform Cloud
  • EXTERNAL - внешний файл конфигурации

DisableTemplateValidation -> (boolean)

Если установлено значение true, Service Catalog прекращает проверку указанного артефакта подготовки, даже если он недействителен.

Service Catalog не поддерживает проверку шаблонов для типа продукта TERRAFORM_OS.

Краткий синтаксис:

Name=string,Description=string,Info={KeyName1=string,KeyName2=string},Type=string,DisableTemplateValidation=boolean

Синтаксис JSON:

{
  "Name": "string",
  "Description": "string",
  "Info": {"string": "string"
    ...},
  "Type": "CLOUD_FORMATION_TEMPLATE"|"MARKETPLACE_AMI"|"MARKETPLACE_CAR"|"TERRAFORM_OPEN_SOURCE"|"TERRAFORM_CLOUD"|"EXTERNAL",
  "DisableTemplateValidation": true|false
}

--idempotency-token (string)

Уникальный идентификатор, который вы предоставляете для обеспечения идемпотентности. Если несколько запросов отличаются только токеном идемпотентности, один и тот же ответ возвращается для каждого повторяющегося запроса.

--source-connection (structure)

Задает сведения о подключении для созданного продукта и синхронизирует продукт с артефактом источника подключения. Это автоматически управляет артефактами продукта на основе изменений в источнике. Параметр SourceConnection состоит из следующих подполей.

  • Type
  • ConnectionParamters

Тип -> (string)

Единственный поддерживаемый тип SourceConnection - Codestar.

ConnectionParameters -> (structure)

Сведения о подключении на основе Type подключения.

CodeStar -> (structure)

Предоставляет ConnectionType.

ConnectionArn -> (string)

ARN CodeStar, который представляет собой соединение между Service Catalog и внешним репозиторием.

Репозиторий -> (string)

Конкретный репозиторий, в котором находится артефакт продукта для синхронизации, отформатированный как «Учетная запись/Репо».

Ветка -> (string)

Конкретная ветка, в которой находится артефакт.

ArtifactPath -> (string)

Абсолютный путь, где находится артефакт в репозитории и ветке, отформатированный как «папка/файл.json».

Краткий синтаксис:

Type=string,ConnectionParameters={CodeStar={ConnectionArn=string,Repository=string,Branch=string,ArtifactPath=string}}

Синтаксис JSON:

{
  "Type": "CODESTAR",
  "ConnectionParameters": {
    "CodeStar": {
      "ConnectionArn": "string",
      "Repository": "string",
      "Branch": "string",
      "ArtifactPath": "string"
    }
  }
}

--cli-input-json | --cli-input-yaml (string) Считывает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, предоставленному --generate-cli-skeleton. Если в командной строке предоставлены другие аргументы, эти значения переопределят значения, предоставленные в формате JSON. Невозможно передавать произвольные двоичные значения, используя значение, предоставленное в формате JSON, поскольку строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (string) Выводит скелет JSON в стандартный вывод без отправки запроса API. Если значение не предоставлено или предоставлено значение input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено значение yaml-input, будет выведен пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, он проверяет входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный скелет JSON не является стабильным между версиями AWS CLI, и гарантии обратной совместимости в сгенерированном скелете JSON отсутствуют.

Глобальные параметры

--debug (boolean)

Включить ведение журнала отладки.

--endpoint-url (string)

Переопределить URL-адрес команды по умолчанию данным URL-адресом.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при взаимодействии со службами AWS. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение по умолчанию для проверки SSL-сертификатов.

--no-paginate (boolean)

Отключить автоматическое разбиение на страницы. Если автоматическое разбиение на страницы отключено, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования вывода команды.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

Запрос JMESPath для использования при фильтрации данных ответа.

--profile (string)

Использовать определенный профиль из файла учетных данных.

--region (string)

Регион для использования. Переопределяет параметры конфигурации/среды.

--version (string)

Отобразить версию этого инструмента.

--color (string)

Включить/отключить цветной вывод.

  • on
  • off
  • auto

--no-sign-request (boolean)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (string)

Пакет сертификатов CA для использования при проверке SSL-сертификатов. Переопределяет параметры конфигурации/среды.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено равным 0, чтение сокета будет блокироваться и не произойдет таймаут. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено равным 0, подключение сокета будет блокироваться и не произойдет таймаут. Значение по умолчанию — 60 секунд.

--cli-binary-format (string)

Стиль форматирования, который будет использоваться для двоичных больших объектов. Формат по умолчанию — 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 (boolean)

Отключить пейджер cli для вывода.

--cli-auto-prompt (boolean)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (boolean)

Отключить автоматический запрос параметров ввода CLI.

Примеры

Примечание

Чтобы использовать следующие примеры, у вас должен быть установлен и настроен AWS CLI. См. Руководство по началу работы в Руководстве пользователя AWS CLI для получения дополнительной информации.

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

Чтобы создать продукт

В следующем примере create-product создается продукт с использованием файла JSON для передачи параметров.

aws servicecatalog create-product \
    --cli-input-json file://create-product-input.json

Содержимое create-product-input.json:

{
    "AcceptLanguage": "en",
    "Name": "test-product",
    "Owner": "test-owner",
    "Description": "test-description",
    "Distributor": "test-distributor",
    "SupportDescription": "test-support",
    "SupportEmail": "test@amazon.com",
    "SupportUrl": "https://aws.amazon.com",
    "ProductType": "CLOUD_FORMATION_TEMPLATE",
    "Tags": [
        {
            "Key": "region",
            "Value": "us-east-1"
        }
    ],
    "ProvisioningArtifactParameters": {
        "Name": "test-version-name",
        "Description": "test-version-description",
        "Info": {
            "LoadTemplateFromURL": "https://s3-us-west-1.amazonaws.com/cloudformation-templates-us-west-1/my-cfn-template.template"
        },
        "Type": "CLOUD_FORMATION_TEMPLATE"
    }
}

Вывод:

{
    "Tags": [
        {
            "Key": "region",
            "Value": "us-east-1"
        }
    ],
    "ProductViewDetail": {
        "CreatedTime": 1576025036.0,
        "ProductARN": "arn:aws:catalog:us-west-2:1234568542028:product/prod-3p5abcdef3oyk",
        "Status": "CREATED",
        "ProductViewSummary": {
            "Type": "CLOUD_FORMATION_TEMPLATE",
            "Distributor": "test-distributor",
            "SupportUrl": "https://aws.amazon.com",
            "SupportEmail": "test@amazon.com",
            "Id": "prodview-abcd42wvx45um",
            "SupportDescription": "test-support",
            "ShortDescription": "test-description",
            "Owner": "test-owner",
            "Name": "test-product2",
            "HasDefaultPath": false,
            "ProductId": "prod-3p5abcdef3oyk"
        }
    },
    "ProvisioningArtifactDetail": {
        "CreatedTime": 1576025036.0,
        "Active": true,
        "Id": "pa-pq3p5lil12a34",
        "Description": "test-version-description",
        "Name": "test-version-name",
        "Type": "CLOUD_FORMATION_TEMPLATE"
    }
}

Вывод

ProductViewDetail -> (structure)

Информация о представлении продукта.

ProductViewSummary -> (structure)

Краткая информация о представлении продукта.

Id -> (string)

Идентификатор представления продукта.

ProductId -> (string)

Идентификатор продукта.

Name -> (string)

Название продукта.

Owner -> (string)

Владелец продукта. Обратитесь к администратору продукта для получения информации о значении этого параметра.

ShortDescription -> (string)

Краткое описание продукта.

Type -> (string)

Тип продукта. Обратитесь к администратору продукта для получения информации о значении этого параметра. Если это значение MARKETPLACE , продукт был создан Amazon Web Services Marketplace.

Distributor -> (string)

Дистрибьютор продукта. Обратитесь к администратору продукта для получения информации о значении этого параметра.

HasDefaultPath -> (boolean)

Указывает, имеет ли продукт путь по умолчанию. Если у продукта нет пути по умолчанию, вызовите ListLaunchPaths, чтобы устранить неоднозначность между путями. В противном случае ListLaunchPaths не требуется, и выходные данные ProductViewSummary можно использовать непосредственно с DescribeProvisioningParameters .

SupportEmail -> (string)

Контактная информация по электронной почте для получения поддержки по этому продукту.

SupportDescription -> (string)

Описание поддержки для этого продукта.

SupportUrl -> (string)

Информация URL для получения поддержки по этому продукту.

Status -> (string)

Статус продукта.

  • AVAILABLE - Продукт готов к использованию.
  • CREATING - Создание продукта началось; продукт не готов к использованию.
  • FAILED - Действие не выполнено.

ProductARN -> (string)

ARN продукта.

CreatedTime -> (timestamp)

Метка времени UTC времени создания.

SourceConnection -> (structure)

Ответ верхнего уровня ProductViewDetail , содержащий сведения о подключении продукта. Service Catalog возвращает это поле для API CreateProduct , UpdateProduct , DescribeProductAsAdmin и SearchProductAsAdmin . Этот ответ содержит те же поля, что и запрос ConnectionParameters , с добавлением ответа LastSync .

Type -> (string)

Единственный поддерживаемый тип SourceConnection - Codestar.

ConnectionParameters -> (structure)

Сведения о подключении на основе Type подключения.

CodeStar -> (structure)

Предоставляет ConnectionType детали.

ConnectionArn -> (string)

CodeStar ARN, который является соединением между Service Catalog и внешним репозиторием.

Repository -> (string)

Конкретный репозиторий, в котором находится артефакт продукта, подлежащий синхронизации, отформатированный как «Account/Repo».

Branch -> (string)

Конкретная ветка, в которой находится артефакт.

ArtifactPath -> (string)

Абсолютный путь, где находится артефакт в репозитории и ветке, отформатированный как «folder/file.json».

LastSync -> (structure)

Предоставляет сведения о синхронизации подключения продукта и содержит следующие подполя.

  • LastSyncTime
  • LastSyncStatus
  • LastSyncStatusMessage
  • LastSuccessfulSyncTime
  • LastSuccessfulSyncProvisioningArtifactID

LastSyncTime -> (timestamp)

Время последней попытки синхронизации из репозитория в продукт Service Catalog.

LastSyncStatus -> (string)

Текущий статус синхронизации. Ответы включают SUCCEEDED или FAILED .

LastSyncStatusMessage -> (string)

Сообщение о статусе синхронизации.

LastSuccessfulSyncTime -> (timestamp)

Время последней успешной синхронизации из артефакта исходного репозитория в продукт Service Catalog.

LastSuccessfulSyncProvisioningArtifactId -> (string)

ProvisioningArtifactID ProvisioningArtifact, созданного в результате последней успешной синхронизации.

ProvisioningArtifactDetail -> (structure)

Информация об артефакте подготовки.

Id -> (string)

Идентификатор артефакта подготовки.

Name -> (string)

Название артефакта подготовки.

Description -> (string)

Описание артефакта подготовки.

Type -> (string)

Тип артефакта подготовки.

  • CLOUD_FORMATION_TEMPLATE - Шаблон CloudFormation
  • TERRAFORM_OPEN_SOURCE - Файл конфигурации Terraform Open Source
  • TERRAFORM_CLOUD - Файл конфигурации Terraform Cloud
  • EXTERNAL - Внешний файл конфигурации

CreatedTime -> (timestamp)

Метка времени UTC времени создания.

Active -> (boolean)

Указывает, активна ли версия продукта.

Guidance -> (string)

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

SourceRevision -> (string)

Определяет редакцию внешнего артефакта, который использовался для автоматической синхронизации продукта Service Catalog и создания артефакта подготовки. Service Catalog включает этот параметр ответа в качестве поля высокого уровня для существующего типа ProvisioningArtifactDetail , который возвращается как часть ответа для API CreateProduct , UpdateProduct , DescribeProductAsAdmin , DescribeProvisioningArtifact , ListProvisioningArtifact и UpdateProvisioningArticat .

Это поле существует только для продуктов, синхронизированных с репозиторием.

Tags -> (list)

Информация о тегах, связанных с продуктом.

(structure)

Информация о теге. Тег — это пара ключ-значение. Теги распространяются на ресурсы, создаваемые при подготовке продукта.

Key -> (string)

Ключ тега.

Value -> (string)

Значение для этого ключа.

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

Spec-Zone.ru

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