Class: Aws::ResourceGroups::Types::StartTagSyncTaskOutput

Inherits:

Struct

• Object
• Struct
• Aws::ResourceGroups::Types::StartTagSyncTaskOutput

Defined in:

gems/aws-sdk-resourcegroups/lib/aws-sdk-resourcegroups/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #group_arn ⇒ String

  The Amazon resource name (ARN) of the application group for which you want to add or remove resources.

• #group_name ⇒ String

  The name of the application group to onboard and sync resources.

• #resource_query ⇒ Types::ResourceQuery

  The query you can use to define a resource group or a search for resources.

• #role_arn ⇒ String

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

• #tag_key ⇒ String

  The tag key of the tag-sync task.

• #tag_value ⇒ String

  The tag value of the tag-sync task.

• #task_arn ⇒ String

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

Instance Attribute Details

#group_arn ⇒ String

The Amazon resource name (ARN) of the application group for which you want to add or remove resources.

Returns:

• (String)

# File 'gems/aws-sdk-resourcegroups/lib/aws-sdk-resourcegroups/types.rb', line 1773

class StartTagSyncTaskOutput < Struct.new(
  :group_arn,
  :group_name,
  :task_arn,
  :tag_key,
  :tag_value,
  :resource_query,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#group_name ⇒ String

The name of the application group to onboard and sync resources.

Returns:

• (String)

# File 'gems/aws-sdk-resourcegroups/lib/aws-sdk-resourcegroups/types.rb', line 1773

class StartTagSyncTaskOutput < Struct.new(
  :group_arn,
  :group_name,
  :task_arn,
  :tag_key,
  :tag_value,
  :resource_query,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#resource_query ⇒ Types::ResourceQuery

The query you can use to define a resource group or a search for resources. A ResourceQuery specifies both a query Type and a Query string as JSON string objects. See the examples section for example JSON strings. For more information about creating a resource group with a resource query, see Build queries and groups in Resource Groups in the Resource Groups User Guide

When you combine all of the elements together into a single string, any double quotes that are embedded inside another double quote pair must be escaped by preceding the embedded double quote with a backslash character (\). For example, a complete ResourceQuery parameter must be formatted like the following CLI parameter example:

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

In the preceding example, all of the double quote characters in the value part of the Query element must be escaped because the value itself is surrounded by double quotes. For more information, see Quoting strings in the Command Line Interface User Guide.

For the complete list of resource types that you can use in the array value for ResourceTypeFilters, see Resources you can use with Resource Groups and Tag Editor in the Resource Groups User Guide. For example:

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

Returns:

• (Types::ResourceQuery)

# File 'gems/aws-sdk-resourcegroups/lib/aws-sdk-resourcegroups/types.rb', line 1773

class StartTagSyncTaskOutput < Struct.new(
  :group_arn,
  :group_name,
  :task_arn,
  :tag_key,
  :tag_value,
  :resource_query,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-resourcegroups/lib/aws-sdk-resourcegroups/types.rb', line 1773

class StartTagSyncTaskOutput < Struct.new(
  :group_arn,
  :group_name,
  :task_arn,
  :tag_key,
  :tag_value,
  :resource_query,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#tag_key ⇒ String

The tag key of the tag-sync task.

Returns:

• (String)

# File 'gems/aws-sdk-resourcegroups/lib/aws-sdk-resourcegroups/types.rb', line 1773

class StartTagSyncTaskOutput < Struct.new(
  :group_arn,
  :group_name,
  :task_arn,
  :tag_key,
  :tag_value,
  :resource_query,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#tag_value ⇒ String

The tag value of the tag-sync task.

Returns:

• (String)

# File 'gems/aws-sdk-resourcegroups/lib/aws-sdk-resourcegroups/types.rb', line 1773

class StartTagSyncTaskOutput < Struct.new(
  :group_arn,
  :group_name,
  :task_arn,
  :tag_key,
  :tag_value,
  :resource_query,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#task_arn ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-resourcegroups/lib/aws-sdk-resourcegroups/types.rb', line 1773

class StartTagSyncTaskOutput < Struct.new(
  :group_arn,
  :group_name,
  :task_arn,
  :tag_key,
  :tag_value,
  :resource_query,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end