create-group

Описание

Создаёт группу ресурсов с указанным именем и описанием. Вы можете необязательно включить запрос ресурсов или конфигурацию службы. Более подробная информация о построении запроса ресурсов доступна в разделе «Построение запросов и групп в Resource Groups» руководства пользователя Resource Groups. Более подробная информация о группах, связанных со службой, и конфигурациях служб, доступна в разделе «Конфигурации служб для Resource Groups».

Минимальные разрешения

Для выполнения этой команды необходимо иметь следующие разрешения:

resource-groups:CreateGroup

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

Синтаксис

  create-group
--name <value>
[--description <value>]
[--resource-query <value>]
[--tags <value>]
[--configuration <value>]
[--criticality <value>]
[--owner <value>]
[--display-name <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]

Параметры

--name (строка)

Имя группы, являющееся идентификатором группы в других операциях. Изменить имя группы после её создания нельзя. Имя группы ресурсов может состоять из букв, цифр, дефисов, точек и нижних подчеркиваний. Имя не может начинаться с AWS , aws или других возможных вариантов регистров; эти имена зарезервированы. Имя группы ресурсов должно быть уникальным в каждой области Amazon Web Services в вашей учётной записи Amazon Web Services.

--description (строка)

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

--resource-query (структура)

Запрос ресурсов, определяющий, какие ресурсы Amazon Web Services являются членами этой группы. Более подробная информация о запросах ресурсов доступна в разделе «Создание группы на основе тегов» в Resource Groups .

Примечание

Группа ресурсов может содержать либо ResourceQuery, либо Configuration, но не оба.

Тип -> (строка)

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

*CLOUDFORMATION_STACK_1_0: * Указывает, что вы хотите, чтобы группа содержала членов стека CloudFormation. Query содержит элемент StackIdentifier с Amazon Resource Name (ARN) для стека CloudFormation.
*TAG_FILTERS_1_0: * Указывает, что вы хотите, чтобы группа включала ресурсы, имеющие теги, соответствующие запросу.

Запрос -> (строка)

Запрос, определяющий группу или поиск. Содержимое зависит от значения элемента Type.

ResourceTypeFilters – Применимо ко всем ResourceQuery объектам типа Type. Этот элемент содержит один из двух следующих пунктов:
- Значение AWS::AllSupported. Это приводит к тому, что запрос ResourceQuery соответствует ресурсам любого типа ресурсов, которые также соответствуют запросу.
- Список (массив JSON) идентификаторов типов ресурсов, ограничивающий запрос только ресурсами указанных типов. Полный список типов ресурсов, которые можно использовать в значении массива для ResourceTypeFilters, см. в разделе «Ресурсы, которые можно использовать с Resource Groups и редактором тегов» в руководстве пользователя Resource Groups.

Пример: "ResourceTypeFilters": ["AWS::AllSupported"] или "ResourceTypeFilters": ["AWS::EC2::Instance", "AWS::S3::Bucket"]

TagFilters – Применимо только если Type = TAG_FILTERS_1_0. Query содержит JSON-строку, представляющую набор простых фильтров тегов. JSON-строка использует синтаксис, аналогичный операции ``GetResources``, но использует только поля ``ResourceTypeFilters`` и ``TagFilters``. Если вы укажете более одного ключа тега, в запросе будут возвращены только ресурсы, соответствующие всем ключам тегов и, по крайней мере, одному значению каждого указанного ключа тега. Если вы укажете более одного значения для ключа тега, ресурс соответствует фильтру, если он имеет значение ключа тега, соответствующее любому из указанных значений. Например, рассмотрим следующий пример запроса для ресурсов, имеющих два тега, Stage и Version, с двумя значениями каждый: [{"Stage":["Test","Deploy"]},{"Version":["1","2"]}]. Результаты этого запроса ресурсов могут включать следующее.
- Инстанс Amazon EC2, у которого есть следующие два тега: {"Stage":"Deploy"} и {"Version":"2"}
- Ведро S3, у которого есть следующие два тега: {"Stage":"Test"} и {"Version":"1"}

Результаты запроса ресурсов не будут включать следующие пункты в результатах, однако.

Инстанс Amazon EC2, у которого есть только следующий тег: {"Stage":"Deploy"}. У инстанса нет всех указанных ключей тегов в фильтре, поэтому он исключается из результатов.
База данных RDS, у которой есть следующие два тега: {"Stage":"Archived"} и {"Version":"4"}. У базы данных есть все ключи тегов, но ни один из этих ключей не имеет связанного значения, соответствующего, по крайней мере, одному из указанных значений в фильтре.

Пример: "TagFilters": [ { "Key": "Stage", "Values": [ "Gamma", "Beta" ] }

StackIdentifier – Применимо только если Type = CLOUDFORMATION_STACK_1_0. Значением этого параметра является Amazon Resource Name (ARN) стека CloudFormation, ресурсы которого вы хотите включить в группу.

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

Type=string,Query=string

JSON-синтаксис:

{
  "Type": "TAG_FILTERS_1_0"|"CLOUDFORMATION_STACK_1_0",
  "Query": "string"
}

--tags (карта)

Теги, которые необходимо добавить к группе. Тег — это строка ключ-значение.

ключ -> (строка)

значение -> (строка)

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

KeyName1=string,KeyName2=string

JSON-синтаксис:

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

--configuration (список)

Конфигурация связывает группу ресурсов с сервисом Amazon Web Services и определяет, как сервис может взаимодействовать с ресурсами в группе. Конфигурация представляет собой массив элементов GroupConfigurationItem. Подробности синтаксиса конфигураций служб см. в разделе «Конфигурации служб для Resource Groups».

Примечание

Группа ресурсов может содержать либо Configuration, либо ResourceQuery, но не оба.

(структура)

Элемент конфигурации группы. Конфигурация службы группы может иметь один или несколько элементов. Подробности синтаксиса конфигурации службы группы см. в разделе «Конфигурации служб для групп ресурсов».

Тип -> (строка)

Указывает тип элемента конфигурации группы. Каждый элемент должен иметь уникальное значение для type. Список типов, которые можно указать для элемента конфигурации, см. в разделе «Поддерживаемые типы ресурсов и параметры».

Параметры -> (список)

Набор параметров для этого элемента конфигурации группы. Список параметров, которые можно использовать с каждым типом элемента конфигурации, см. в разделе «Поддерживаемые типы ресурсов и параметры».

(структура)

Параметр для элемента конфигурации группы. Подробности синтаксиса конфигурации службы группы см. в разделе «Конфигурации служб для групп ресурсов».

Имя -> (строка)

Имя параметра конфигурации группы. Список параметров, которые можно использовать с каждым типом элемента конфигурации, см. в разделе «Поддерживаемые типы ресурсов и параметры».

Значения -> (список)

Значение или значения, которые необходимо использовать для указанного параметра. Список значений, которые можно использовать с каждым параметром, см. в разделе «Поддерживаемые типы ресурсов и параметры».

(строка)

JSON-синтаксис:

[
  {
    "Type": "string",
    "Parameters": [
      {
        "Name": "string",
        "Values": ["string", ...]
      }
      ...
    ]
  }
  ...
]

--criticality (целое число)

Критический ранг группы приложений по шкале от 1 до 10, где ранг 1 — наиболее важный, а ранг 10 — наименее важный.

--owner (строка)

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

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

Название группы приложений, которое можно изменить в любое время.

--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 версии 1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, которое соответствует двоичному блоку 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.

Пример 1: Создание группы ресурсов на основе тегов

Следующий create-group пример создает группу ресурсов Amazon EC2 на основе тегов в текущем регионе. Он основан на запросе ресурсов, помеченных тегом с ключом Name и значением WebServers. Имя группы — tbq-WebServer. Запрос находится в отдельном файле JSON, который передается команде.

aws resource-groups create-group \
    --name tbq-WebServer \
    --resource-query file://query.json

Содержимое query.json:

{
    "Type": "TAG_FILTERS_1_0",
    "Query": "{\"ResourceTypeFilters\":[\"AWS::EC2::Instance\"],\"TagFilters\":[{\"Key\":\"Name\", \"Values\":[\"WebServers\"]}]}"
}

Вывод:

{
    "Group": {
        "GroupArn": "arn:aws:resource-groups:us-west-2:123456789012:group/tbq-WebServer",
        "Name": "tbq-WebServer"
    },
    "ResourceQuery": {
        "Type": "TAG_FILTERS_1_0",
        "Query": "{\"ResourceTypeFilters\":[\"AWS::EC2::Instance\"],\"TagFilters\":[{\"Key\":\"Name\", \"Values\":[\"WebServers\"]}]}"
    }
}

Пример 2: Создание группы ресурсов на основе стека CloudFormation

Следующий create-group пример создает группу ресурсов AWS CloudFormation на основе стека с именем sampleCFNstackgroup. Запрос включает все ресурсы в указанном стеке CloudFormation, которые поддерживаются AWS Resource Groups.

aws resource-groups create-group \
    --name cbq-CFNstackgroup \
    --resource-query file://query.json

Содержимое query.json:

{
    "Type": "CLOUDFORMATION_STACK_1_0",
    "Query": "{\"ResourceTypeFilters\":[\"AWS::AllSupported\"],\"StackIdentifier\":\"arn:aws:cloudformation:us-west-2:123456789012:stack/MyCFNStack/1415z9z0-z39z-11z8-97z5-500z212zz6fz\"}"
}

Вывод:

{
    "Group": {
        "GroupArn": "arn:aws:resource-groups:us-west-2:123456789012:group/cbq-CFNstackgroup",
        "Name": "cbq-CFNstackgroup"
    },
    "ResourceQuery": {
        "Type": "CLOUDFORMATION_STACK_1_0",
        "Query": "{\"ResourceTypeFilters\":[\"AWS::AllSupported\"],\"StackIdentifier\":\"arn:aws:cloudformation:us-east-2:123456789012:stack/MyCFNStack/1415z9z0-z39z-11z8-97z5-500z212zz6fz\"}"}'
    }
}

Дополнительную информацию см. в разделе Создание групп в Руководстве пользователя AWS Resource Groups.

Вывод

Группа -> (структура)

Описание группы ресурсов.

GroupArn -> (строка)

Amazon Resource Name (ARN) группы ресурсов.

Имя -> (строка)

Имя группы ресурсов.

Описание -> (строка)

Описание группы ресурсов.

Важность -> (целое число)

Уровень важности группы приложений в масштабе от 1 до 10, где 1 — наивысшая важность, а 10 — наименьшая.

Владелец -> (строка)

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

Имя отображения -> (строка)

Название группы приложений, которое можно изменить в любое время.

Тег приложения -> (карта)

Тег, определяющий членство в группе приложений. Этот тег поддерживается только для групп приложений.

ключ -> (строка)

значение -> (строка)

Запрос к ресурсам -> (структура)

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

Тип -> (строка)

Тип запроса. Может принимать одно из двух значений:

*CLOUDFORMATION_STACK_1_0: * Указывает, что группа должна содержать членов стека CloudFormation. Query содержит элемент StackIdentifier с Amazon Resource Name (ARN) стека CloudFormation.
*TAG_FILTERS_1_0: * Указывает, что группа должна включать ресурсы, имеющие теги, соответствующие запросу.

Запрос -> (строка)

Запрос, определяющий группу или поиск. Содержимое зависит от значения элемента Type.

ResourceTypeFilters — применяется ко всем объектам ResourceQuery типов Type . Этот элемент содержит один из следующих двух пунктов:
- Значение AWS::AllSupported . Это заставляет запрос к ресурсам соответствовать ресурсам любого типа ресурса, которые также соответствуют запросу.
- Список (массив JSON) идентификаторов типов ресурсов, которые ограничивают запрос только ресурсами указанных типов. Полный список типов ресурсов, которые можно использовать в значении массива для ResourceTypeFilters , см. в разделе Ресурсы, которые можно использовать с Ресурсными группами и Редактором тегов в Руководстве пользователя по Ресурсным группам.

Пример: "ResourceTypeFilters": ["AWS::AllSupported"] или "ResourceTypeFilters": ["AWS::EC2::Instance", "AWS::S3::Bucket"]

TagFilters — применяется только если Type = TAG_FILTERS_1_0 . Query содержит JSON-строку, представляющую набор простых фильтров тегов. JSON-строка использует синтаксис, аналогичный операции ``GetResources``, но использует только поля ``ResourceTypeFilters`` и ``TagFilters``. Если вы укажете более одного ключа тега, в результате запроса будут возвращены только ресурсы, которые соответствуют всем ключам тегов и по меньшей мере одному значению каждого указанного ключа тега. Если вы укажете более одного значения для ключа тега, ресурс соответствует фильтру, если он имеет значение ключа тега, которое совпадает с любым из указанных значений. Например, рассмотрим следующий пример запроса к ресурсам, имеющим два тега, Stage и Version, с двумя значениями каждый: [{"Stage":["Test","Deploy"]},{"Version":["1","2"]}]. Результаты этого запроса к ресурсам могут включать следующие элементы.
- Инстанс Amazon EC2, имеющий следующие два тега: {"Stage":"Deploy"} и {"Version":"2"}
- Ведро S3, имеющее следующие два тега: {"Stage":"Test"} и {"Version":"1"}

Результаты запроса к ресурсам не будут включать следующие элементы.

Инстанс Amazon EC2, имеющий только следующий тег: {"Stage":"Deploy"}. У инстанса отсутствуют все ключи тегов, указанные в фильтре, поэтому он исключается из результатов.
База данных RDS, имеющая следующие два тега: {"Stage":"Archived"} и {"Version":"4"}. База данных имеет все ключи тегов, но ни один из ключей не имеет связанного значения, соответствующего по крайней мере одному из указанных значений в фильтре.

Пример: "TagFilters": [ { "Key": "Stage", "Values": [ "Gamma", "Beta" ] }

StackIdentifier — применяется только если Type = CLOUDFORMATION_STACK_1_0 . Значение этого параметра — Amazon Resource Name (ARN) стека CloudFormation, ресурсы которого необходимо включить в группу.

Теги -> (карта)

Теги, связанные с группой.

ключ -> (строка)

значение -> (строка)

Конфигурация группы -> (структура)

Настройка сервиса, связанная с группой ресурсов. Подробности синтаксиса настройки сервиса см. в разделе Настройки сервисов для Ресурсных групп .

Конфигурация -> (список)

Конфигурация, в настоящее время связанная с группой и действующая.

(структура)

Элемент конфигурации группы. Конфигурация сервиса группы может содержать один или несколько элементов. Подробности синтаксиса конфигурации сервиса группы см. в разделе Настройки сервисов для ресурсных групп .

Тип -> (строка)

Указывает тип элемента конфигурации группы. Каждый элемент должен иметь уникальное значение для type . Список типов, которые можно указать для элемента конфигурации, см. в разделе Поддерживаемые типы ресурсов и параметры .

Параметры -> (список)

Набор параметров для этого элемента конфигурации группы. Список параметров, которые можно использовать с каждым типом элемента конфигурации, см. в разделе Поддерживаемые типы ресурсов и параметры .

(структура)

Параметр элемента конфигурации группы. Подробности синтаксиса конфигурации сервиса группы см. в разделе Настройки сервисов для ресурсных групп .

Имя -> (строка)

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

Значения -> (список)

Значение или значения, которые необходимо использовать для указанного параметра. Список значений, которые можно использовать с каждым параметром, см. в разделе Поддерживаемые типы ресурсов и параметры .

(строка)

Предлагаемая конфигурация -> (список)

Если присутствует, новая конфигурация, которая применяется к группе.

(структура)

Тип -> (строка)

Указывает тип элемента конфигурации группы. Каждый элемент должен иметь уникальное значение для type . Список типов, которые можно указать для элемента конфигурации, см. в разделе Поддерживаемые типы ресурсов и параметры .

Параметры -> (список)

(структура)

Имя -> (строка)

Значения -> (список)

(строка)

Состояние -> (строка)

Текущее состояние попытки обновления конфигурации группы.

Причина ошибки -> (строка)

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