Skip to content

Start Tag Sync Task

resourcegroups_start_tag_sync_task R Documentation

Creates a new tag-sync task to onboard and sync resources tagged with a specific tag key-value pair to an application

Description

Creates a new tag-sync task to onboard and sync resources tagged with a specific tag key-value pair to an application.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:StartTagSyncTask on the application group

  • resource-groups:CreateGroup

  • iam:PassRole on the role provided in the request

Usage

resourcegroups_start_tag_sync_task(Group, TagKey, TagValue, RoleArn)

Arguments

Group

[required] The Amazon resource name (ARN) or name of the application group for which you want to create a tag-sync task.

TagKey

[required] The tag key. Resources tagged with this tag key-value pair will be added to the application. If a resource with this tag is later untagged, the tag-sync task removes the resource from the application.

TagValue

[required] The tag value. Resources tagged with this tag key-value pair will be added to the application. If a resource with this tag is later untagged, the tag-sync task removes the resource from the application.

RoleArn

[required] The Amazon resource name (ARN) of the role assumed by the service to tag and untag resources on your behalf.

Value

A list with the following syntax:

list(
  GroupArn = "string",
  GroupName = "string",
  TaskArn = "string",
  TagKey = "string",
  TagValue = "string",
  RoleArn = "string"
)

Request syntax

svc$start_tag_sync_task(
  Group = "string",
  TagKey = "string",
  TagValue = "string",
  RoleArn = "string"
)