Class: Aws::ResourceGroups::Types::GetTagSyncTaskOutput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-resourcegroups/lib/aws-sdk-resourcegroups/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#created_at ⇒ Time

The timestamp of when the tag-sync task was created.

Returns:

  • (Time) 


473
474
475
476
477
478
479
480
481
482
483
484
485
486
 
# File 'gems/aws-sdk-resourcegroups/lib/aws-sdk-resourcegroups/types.rb', line 473

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

#error_message ⇒ String

The specific error message in cases where the tag-sync task status is ERROR.

Returns:

  • (String) 


473
474
475
476
477
478
479
480
481
482
483
484
485
486
 
# File 'gems/aws-sdk-resourcegroups/lib/aws-sdk-resourcegroups/types.rb', line 473

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

#group_arn ⇒ String

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

Returns:

  • (String) 


473
474
475
476
477
478
479
480
481
482
483
484
485
486
 
# File 'gems/aws-sdk-resourcegroups/lib/aws-sdk-resourcegroups/types.rb', line 473

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

#group_name ⇒ String

The name of the application group.

Returns:

  • (String) 


473
474
475
476
477
478
479
480
481
482
483
484
485
486
 
# File 'gems/aws-sdk-resourcegroups/lib/aws-sdk-resourcegroups/types.rb', line 473

class GetTagSyncTaskOutput < Struct.new(
  :group_arn,
  :group_name,
  :task_arn,
  :tag_key,
  :tag_value,
  :resource_query,
  :role_arn,
  :status,
  :error_message,
  :created_at)
  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:



473
474
475
476
477
478
479
480
481
482
483
484
485
486
 
# File 'gems/aws-sdk-resourcegroups/lib/aws-sdk-resourcegroups/types.rb', line 473

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

#role_arn ⇒ String

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

For more information about this role, review Tag-sync required permissions.

Returns:

  • (String) 


473
474
475
476
477
478
479
480
481
482
483
484
485
486
 
# File 'gems/aws-sdk-resourcegroups/lib/aws-sdk-resourcegroups/types.rb', line 473

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

#status ⇒ String

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.

Returns:

  • (String) 


473
474
475
476
477
478
479
480
481
482
483
484
485
486
 
# File 'gems/aws-sdk-resourcegroups/lib/aws-sdk-resourcegroups/types.rb', line 473

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

#tag_key ⇒ String

The tag key.

Returns:

  • (String) 


473
474
475
476
477
478
479
480
481
482
483
484
485
486
 
# File 'gems/aws-sdk-resourcegroups/lib/aws-sdk-resourcegroups/types.rb', line 473

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

#tag_value ⇒ String

The tag value.

Returns:

  • (String) 


473
474
475
476
477
478
479
480
481
482
483
484
485
486
 
# File 'gems/aws-sdk-resourcegroups/lib/aws-sdk-resourcegroups/types.rb', line 473

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

#task_arn ⇒ String

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

Returns:

  • (String) 


473
474
475
476
477
478
479
480
481
482
483
484
485
486
 
# File 'gems/aws-sdk-resourcegroups/lib/aws-sdk-resourcegroups/types.rb', line 473

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