start-tag-sync-task

Описание

Создаёт новую задачу синхронизации тегов для подключения и синхронизации ресурсов, помеченных определённой парой ключ-значение тега, с приложением. Для запуска задачи синхронизации тегов необходима роль для маркировки ресурсов. Роль для маркировки ресурсов предоставляет разрешения на маркировку и снятие маркировки ресурсов приложений и должна включать политику доверия, которая позволяет Группе ресурсов принять на себя роль и выполнить задачи маркировки ресурсов от вашего имени.

Инструкции по созданию задачи синхронизации тегов см. в разделе «Создание задачи синхронизации тегов с помощью API Группы ресурсов» в руководстве администратора приложения AppRegistry Службы каталога Amazon Web Services.

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

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

resource-groups:StartTagSyncTask для группы приложений
resource-groups:CreateGroup
iam:PassRole для роли, предоставленной в запросе

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

Синтаксис

  start-tag-sync-task
--group <value>
[--tag-key <value>]
[--tag-value <value>]
[--resource-query <value>]
--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]

Параметры

--group (строка)

Идентификатор ресурса Amazon (ARN) или имя группы приложений, для которой вы хотите создать задачу синхронизации тегов.

--tag-key (строка)

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

При использовании параметра TagKey, вы также должны указать параметр TagValue. Если вы указываете пару ключ-значение тега, вы не можете использовать параметр ResourceQuery.

--tag-value (строка)

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

При использовании параметра TagValue, вы также должны указать параметр TagKey. Если вы указываете пару ключ-значение тега, вы не можете использовать параметр ResourceQuery.

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

Запрос, который можно использовать для создания задачи синхронизации тегов. С помощью этого метода все ресурсы, соответствующие запросу, добавляются в указанную группу приложений. Параметр ResourceQuery указывает как запрос Type, так и строку Query в виде объектов JSON. Дополнительную информацию о определении запроса ресурсов для задачи синхронизации тегов см. в разделе «Типы запросов групп ресурсов» в Руководстве пользователя Группы ресурсов.

При использовании параметра ResourceQuery, вы не можете использовать параметры TagKey и TagValue.

При объединении всех элементов в одну строку, все двойные кавычки, вложенные в другую пару двойных кавычек, должны быть экранированы, предваряя вложенную двойную кавычку обратной косой чертой (). Например, полный параметр ResourceQuery должен иметь формат, аналогичный приведённому ниже примеру параметра командной строки:

--resource-query '{"Type":"TAG_FILTERS_1_0","Query":"{\"ResourceTypeFilters\":[\"AWS::AllSupported\"],\"TagFilters\":[{\"Key\":\"Stage\",\"Values\":[\"Test\"]}]}"}'

В приведенном выше примере все символы двойных кавычек в части значения элемента Query должны быть экранированы, потому что само значение заключено в двойные кавычки. Дополнительную информацию см. в разделе «Приведение строк в Руководстве пользователя командной строки».

Полный список типов ресурсов, которые можно использовать в значении массива для ResourceTypeFilters, см. в разделе «Ресурсы, которые можно использовать с группами ресурсов и редактором тегов» в Руководстве пользователя Группы ресурсов. Например:

"ResourceTypeFilters":["AWS::S3::Bucket", "AWS::EC2::Instance"]

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

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

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

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

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

ResourceTypeFilters – применяется ко всем объектам ResourceQuery типа Type . Этот элемент содержит один из следующих двух пунктов:
- Значение AWS::AllSupported . Это заставляет ResourceQuery соответствовать ресурсам любого типа ресурса, которые также соответствуют запросу.
- Список (массив 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 (ARN) стека CloudFormation, чьи ресурсы должны быть включены в группу.

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

Type=string,Query=string

Синтаксис JSON:

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

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

Идентификатор ресурса Amazon (ARN) роли, принимаемой службой для маркировки и снятия маркировки ресурсов от вашего имени.

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

Вывод

GroupArn -> (string)

Amazon Resource Name (ARN) группы приложений, к которой вы хотите добавить или удалить ресурсы.

GroupName -> (string)

Название группы приложений для включения и синхронизации ресурсов.

TaskArn -> (string)

Amazon Resource Name (ARN) новой задачи синхронизации тегов.

TagKey -> (string)

Ключ тега задачи синхронизации тегов.

TagValue -> (string)

Значение тега задачи синхронизации тегов.

ResourceQuery -> (structure)

Запрос, который можно использовать для определения группы ресурсов или поиска ресурсов. ResourceQuery определяет как запрос Type, так и строку Query как JSON-строковые объекты. Примеры JSON-строк см. в разделе Примеры. Дополнительную информацию о создании группы ресурсов с запросом к ресурсам см. в разделе Создание запросов и групп в группах ресурсов в Руководстве пользователя по группам ресурсов

При объединении всех элементов в одну строку все двойные кавычки, вложенные в другую пару двойных кавычек, должны быть экранированы, предваряя вложенную двойную кавычку обратной косой чертой (). Например, полный параметр ResourceQuery должен быть отформатирован как следующий пример параметра командной строки:

--resource-query '{"Type":"TAG_FILTERS_1_0","Query":"{\"ResourceTypeFilters\":[\"AWS::AllSupported\"],\"TagFilters\":[{\"Key\":\"Stage\",\"Values\":[\"Test\"]}]}"}'

В приведенном выше примере все символы двойных кавычек в части значения элемента Query должны быть экранированы, поскольку само значение окружено двойными кавычками. Дополнительную информацию см. в разделе Цитирование строк в Руководстве пользователя по командной строке.

Полный список типов ресурсов, которые можно использовать в значении массива для ResourceTypeFilters, см. в разделе Ресурсы, которые можно использовать с группами ресурсов и редактором тегов в Руководстве пользователя по группам ресурсов. Например:

"ResourceTypeFilters":["AWS::S3::Bucket", "AWS::EC2::Instance"]

Type -> (string)

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

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

Query -> (string)

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

ResourceTypeFilters – применяется ко всем ResourceQuery объектам либо Type . Этот элемент содержит один из двух следующих элементов:
- Значение AWS::AllSupported. Это приводит к тому, что ResourceQuery соответствует ресурсам любого типа ресурса, которые также соответствуют запросу.
- Список (массив 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, ресурсы которого должны быть включены в группу.

RoleArn -> (string)

Amazon Resource Name (ARN) роли, принимаемой сервисом для присвоения и снятия тегов ресурсов от вашего имени.