Spec-Zone.ru › AWS CLI v2

[ aws . grafana ]

создание-рабочей-области

Описание

Создаёт рабочую область. В рабочей области вы можете создавать панели управления и визуализации Grafana для анализа метрик, журналов и трассировок. Вам не нужно создавать, упаковывать или развертывать какое-либо оборудование для запуска сервера Grafana.

Не используйте CreateWorkspace для изменения существующей рабочей области. Используйте вместо этого UpdateWorkspace .

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

Синтаксис

  create-workspace
--account-access-type <value>
--authentication-providers <value>
[--client-token <value>]
[--configuration <value>]
[--grafana-version <value>]
[--network-access-control <value>]
[--organization-role-name <value>]
--permission-type <value>
[--stack-set-name <value>]
[--tags <value>]
[--vpc-configuration <value>]
[--workspace-data-sources <value>]
[--workspace-description <value>]
[--workspace-name <value>]
[--workspace-notification-destinations <value>]
[--workspace-organizational-units <value>]
[--workspace-role-arn <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]

Параметры

--account-access-type (строка)

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

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

  • CURRENT_ACCOUNT
  • ORGANIZATION

--authentication-providers (список)

Указывает, использует ли эта рабочая область SAML 2.0, IAM Identity Center или оба для проверки подлинности пользователей для использования консоли Grafana в рамках рабочей области. Дополнительную информацию см. в разделе Проверка подлинности пользователей в Amazon Managed Grafana .

(строка)

Синтаксис:

"string" "string" ...

Where valid values are:
  AWS_SSO
  SAML

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

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

--configuration (строка)

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

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

Указывает версию Grafana, поддерживаемую в новой рабочей области. Если не указано, используется последняя версия (например, 10.4).

Чтобы получить список поддерживаемых версий, используйте операцию ListVersions.

--network-access-control (структура)

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

При настройке доступ к вашей рабочей области будут иметь только указанные IP-адреса и VPC-пункты конечных точек. Стандартная аутентификация и авторизация Grafana все равно будут необходимы.

Если эта настройка не выполнена или удалена, доступ к рабочей области будет разрешен для всех IP-адресов и VPC-пунктов конечных точек. Стандартная аутентификация и авторизация Grafana все равно будут необходимы.

prefixListIds -> (список)

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

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

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

(строка)

vpceIds -> (список)

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

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

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

Примечание

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

(строка)

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

prefixListIds=string,string,vpceIds=string,string

Синтаксис JSON:

{
  "prefixListIds": ["string", ...],
  "vpceIds": ["string", ...]
}

--organization-role-name (строка)

Имя существующей роли IAM, используемой с Организациями для доступа к данным источников и каналам уведомлений Amazon Web Services в других учетных записях организации.

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

При создании рабочей области через API Amazon Web Services, командную строку или Amazon Web Services CloudFormation вам необходимо управлять ролями IAM и предоставлять разрешения, необходимые рабочей области для использования источников данных и каналов уведомлений Amazon Web Services.

Также необходимо указать workspaceRoleArn для роли, которую вы будете управлять для использования рабочей области при доступе к этим источникам данных и каналам уведомлений.

Возможность для Amazon Managed Grafana создавать и обновлять роли IAM от имени пользователя поддерживается только в консоли Amazon Managed Grafana, где это значение может быть установлено на SERVICE_MANAGED.

Примечание

Используйте только тип разрешения CUSTOMER_MANAGED при создании рабочей области с помощью API, командной строки или Amazon Web Services CloudFormation.

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

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

  • CUSTOMER_MANAGED
  • SERVICE_MANAGED

--stack-set-name (строка)

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

--tags (отображение)

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

key -> (строка)

value -> (строка)

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--vpc-configuration (структура)

Параметры конфигурации для VPC Amazon, содержащей источники данных для подключения к вашей рабочей области Grafana.

Примечание

Подключение к частной VPC пока недоступно в регионе Азия-Тихий океан (Сеул) (ap-northeast-2).

securityGroupIds -> (список)

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

(строка)

subnetIds -> (список)

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

(строка)

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

securityGroupIds=string,string,subnetIds=string,string

Синтаксис JSON:

{
  "securityGroupIds": ["string", ...],
  "subnetIds": ["string", ...]
}

--workspace-data-sources (список)

Этот параметр предназначен только для внутреннего использования и не должен использоваться.

(строка)

Синтаксис:

"string" "string" ...

Where valid values are:
  AMAZON_OPENSEARCH_SERVICE
  CLOUDWATCH
  PROMETHEUS
  XRAY
  TIMESTREAM
  SITEWISE
  ATHENA
  REDSHIFT
  TWINMAKER

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

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

Шаблон: ^[\\p{L}\\p{Z}\\p{N}\\p{P}]{0,2048}$

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

Имя рабочей области. Оно не обязательно должно быть уникальным.

--workspace-notification-destinations (список)

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

(строка)

Синтаксис:

"string" "string" ...

Where valid values are:
  SNS

--workspace-organizational-units (список)

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

(строка)

Синтаксис:

"string" "string" ...

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

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

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

Вывод

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

Структура, содержащая данные о созданном рабочем пространстве.

accountAccessType -> (строка)

Указывает, может ли рабочее пространство получить доступ к ресурсам Amazon Web Services только в данной учетной записи 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 -> (boolean)

Указывает, полностью ли это рабочее пространство использовало бесплатный пробный период для 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 ``.

Дополнительную информацию об интерфейсных VPC-точках конечного доступа см. в Руководстве пользователя 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