Spec-Zone.ru › AWS CLI v2

[ aws . grafana ]

associate-license

Описание

Присваивает лицензию Grafana Enterprise рабочему пространству. Для обновления необходимо использовать ENTERPRISE для licenseType и передать действительный токен Grafana Labs для grafanaToken. Обновление до Grafana Enterprise влечёт дополнительные расходы. Для получения дополнительной информации см. Upgrade a workspace to Grafana Enterprise.

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

Синтаксис

  associate-license
[--grafana-token <value>]
--license-type <value>
--workspace-id <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]

Параметры

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

Токен от Grafana Labs, связывающий вашу учётную запись Amazon Web Services с учётной записью Grafana Labs. Дополнительную информацию см. в Link your account with Grafana Labs.

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

Тип лицензии, которую нужно присвоить рабочему пространству.

Примечание

Рабочие пространства Amazon Managed Grafana больше не поддерживают бесплатные пробные периоды Grafana Enterprise.

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

  • ENTERPRISE
  • ENTERPRISE_FREE_TRIAL

--workspace-id (строка)

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

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

Вывод

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

Структура, содержащая данные о рабочей области.

accountAccessType -> (строка)

Указывает, может ли рабочая область получать доступ к ресурсам Amazon Web Services только в данном аккаунте Amazon Web Services или также к ресурсам в других аккаунтах в той же организации. Если это ORGANIZATION , параметр workspaceOrganizationalUnits указывает, к каким организационным подразделениям рабочая область имеет доступ.

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

Структура, описывающая, использует ли рабочая область SAML, IAM Identity Center или оба метода для аутентификации пользователей.

providers -> (список)

Указывает, использует ли рабочая область SAML, IAM Identity Center или оба метода для аутентификации пользователей.

(строка)

samlConfigurationStatus -> (строка)

Указывает, полностью ли настроено средство аутентификации пользователей рабочей области.

created -> (временная метка)

Дата создания рабочей области.

dataSources -> (список)

Указывает источники данных Amazon Web Services, для которых были настроены роли IAM и разрешения, чтобы Amazon Managed Grafana мог читать данные из этих источников.

Этот список используется только в том случае, если рабочая область была создана через консоль Amazon Web Services, и permissionType равно SERVICE_MANAGED.

(строка)

description -> (строка)

Пользовательское описание рабочей области.

endpoint -> (строка)

URL, который пользователи могут использовать для доступа к консоли Grafana в рабочей области.

freeTrialConsumed -> (булево)

Указывает, полностью ли рабочая область использовала пробный период для Grafana Enterprise.

Примечание

Рабочие области Amazon Managed Grafana больше не поддерживают пробные периоды Grafana Enterprise.

freeTrialExpiration -> (временная метка)

Если рабочая область в настоящее время находится в пробном периоде для Grafana Enterprise, это значение указывает, когда этот пробный период закончится.

Примечание

Рабочие области Amazon Managed Grafana больше не поддерживают пробные периоды Grafana Enterprise.

grafanaToken -> (строка)

Токен, связывающий эту рабочую область с учетной записью Grafana Labs. Дополнительную информацию см. в разделе Свяжите свою учетную запись с Grafana Labs.

grafanaVersion -> (строка)

Версия Grafana, поддерживаемая в этой рабочей области.

id -> (строка)

Уникальный идентификатор этой рабочей области.

licenseExpiration -> (временная метка)

Если у этой рабочей области имеется полная лицензия Grafana Enterprise, приобретенная через Amazon Web Services Marketplace, это указывает, когда лицензия истекает и требует обновления. Приобретение опции Enterprise-плагинов через Amazon Managed Grafana не имеет срока действия. Она действительна до тех пор, пока лицензия не будет удалена.

licenseType -> (строка)

Указывает, имеет ли эта рабочая область полную лицензию Grafana Enterprise.

Примечание

Рабочие области Amazon Managed Grafana больше не поддерживают пробные периоды Grafana Enterprise.

modified -> (временная метка)

Последняя дата изменения рабочей области.

name -> (строка)

Название рабочей области.

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

Настройки конфигурации сетевого доступа к вашей рабочей области.

prefixListIds -> (список)

Массив идентификаторов списков префиксов. Список префиксов — это список диапазонов CIDR IP-адресов. Указанные IP-адреса разрешено использовать для доступа к вашей рабочей области. Если список не включен в конфигурацию (передан пустой массив), то ни один IP-адрес не разрешен для доступа к рабочей области. Список префиксов создается с помощью консоли Amazon VPC.

Идентификаторы списков префиксов имеют формат ``pl-1a2b3c4d ``.

Дополнительную информацию о списках префиксов см. в разделе Группирование блоков CIDR с помощью управляемых списков префиксов в Руководстве пользователя Amazon Virtual Private Cloud.

(строка)

vpceIds -> (список)

Массив идентификаторов точек конечного доступа Amazon VPC для рабочей области. Можно создать точки конечного доступа VPC для доступа к рабочей области Amazon Managed Grafana изнутри VPC. Если указан NetworkAccessConfiguration, то разрешен доступ только для указанных здесь точек конечного доступа VPC. Если вы передаете пустой массив строк, то доступ VPC запрещен.

Идентификаторы точек конечного доступа VPC имеют формат ``vpce-1a2b3c4d ``.

Дополнительную информацию о создании точки конечного доступа интерфейса см. в разделе Точки конечного доступа интерфейса в Руководстве пользователя Amazon Managed Grafana .

Примечание

Здесь можно указывать только точки конечного доступа интерфейса VPC для рабочих областей Grafana (используя com.amazonaws.[region].grafana-workspace точку конечного доступа сервиса). Другие точки конечного доступа VPC игнорируются.

(строка)

notificationDestinations -> (список)

Каналы уведомлений Amazon Web Services, для которых Amazon Managed Grafana может автоматически создавать роли IAM и разрешения, чтобы Amazon Managed Grafana мог использовать эти каналы.

(строка)

organizationRoleName -> (строка)

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

organizationalUnits -> (список)

Указывает организационные подразделения, из которых эта рабочая область может использовать источники данных, если эта рабочая область находится в аккаунте, являющемся частью организации.

(строка)

permissionType -> (строка)

Если это SERVICE_MANAGED, и рабочая область была создана через консоль Amazon Managed Grafana, то Amazon Managed Grafana автоматически создает роли IAM и предоставляет разрешения, необходимые рабочей области для использования источников данных Amazon Web Services и каналов уведомлений.

Если это CUSTOMER_MANAGED, вы должны самостоятельно управлять этими ролями и разрешениями.

Если вы работаете с рабочей областью в аккаунте-члене организации, и этот аккаунт не является делегированным администратором, и вы хотите, чтобы рабочая область имела доступ к источникам данных в других аккаунтах Amazon Web Services в организации, этот параметр должен быть установлен на CUSTOMER_MANAGED.

Дополнительную информацию о преобразовании между управлением клиентом и сервисом см. в разделе Управление разрешениями для источников данных и каналов уведомлений. Дополнительную информацию о ролях и разрешениях, которые необходимо управлять для рабочих областей, управляемых клиентом, см. в разделе Разрешения и политики Amazon Managed Grafana для источников данных и каналов уведомлений Amazon Web Services.

stackSetName -> (строка)

Имя набора стеков CloudFormation, используемого для генерации ролей IAM для использования в этой рабочей области.

status -> (строка)

Текущий статус рабочей области.

tags -> (карта)

Список тегов, связанных с рабочей областью.

key -> (строка)

value -> (строка)

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

Настройка подключения к источникам данных в частной VPC (Amazon Virtual Private Cloud).

securityGroupIds -> (список)

Список идентификаторов групп безопасности Amazon EC2, присоединенных к Amazon VPC для подключения вашей рабочей области Grafana. Дубликаты запрещены.

(строка)

subnetIds -> (список)

Список идентификаторов подсетей Amazon EC2, созданных в Amazon VPC для подключения вашей рабочей области Grafana. Дубликаты запрещены.

(строка)

workspaceRoleArn -> (строка)

Роль IAM, предоставляющая разрешения на доступ к ресурсам Amazon Web Services, из которых рабочая область будет получать данные. Эта роль должна уже существовать.

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

Spec-Zone.ru

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