AWS::ResourceGroups::TagSyncTask - AWS CloudFormation
SyntaxPropertiesReturn values

AWS::ResourceGroups::TagSyncTask

Onboards and syncs 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

  • resource-groups:CreateGroup

  • iam:PassRole for the role you provide to create a tag-sync task

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::ResourceGroups::TagSyncTask",
  "Properties" : {
      "Group" : String,
      "RoleArn" : String,
      "TagKey" : String,
      "TagValue" : String
    }
}

YAML

Type: AWS::ResourceGroups::TagSyncTask
Properties:
  Group: String
  RoleArn: String
  TagKey: String
  TagValue: String

Properties

Group

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

Required: Yes

Type: String

Pattern: ([a-zA-Z0-9_\\.-]{1,150}/[a-z0-9]{26})|(arn:aws(-[a-z]+)*:resource-groups(-(test|beta|gamma))?:[a-z]{2}(-[a-z]+)+-\d{1}:[0-9]{12}:group/[a-zA-Z0-9_\\.-]{1,150}/[a-z0-9]{26})

Minimum: 12

Maximum: 1600

Update requires: Replacement

RoleArn

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

Required: Yes

Type: String

Pattern: arn:(aws[a-zA-Z-]*)?:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+

Minimum: 20

Maximum: 2048

Update requires: Replacement

TagKey

The tag key.

Required: Yes

Type: String

Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

Minimum: 1

Maximum: 128

Update requires: Replacement

TagValue

The tag value.

Required: Yes

Type: String

Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

Minimum: 0

Maximum: 256

Update requires: Replacement

Return values

Ref

The TaskArn.

Fn::GetAtt

GroupArn

The Amazon resource name (ARN) of the application group.

GroupName

The name of the application group.

Status

The status of the tag-sync task.

Valid values include:

  • ACTIVE - The tag-sync task is actively managing resources in the application by adding or removing the awsApplication tag from resources when they are tagged or untagged with the specified tag key-value pair.

  • ERROR - The tag-sync task is not actively managing resources in the application. Review the ErrorMessage for more information about resolving the error.

TaskArn

The Amazon resource name (ARN) of the tag-sync task.