Class: Aws::XRay::Types::CreateGroupRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#filter_expression ⇒ String

The filter expression defining criteria by which to group traces.

Returns:

  • (String) 


225
226
227
228
229
230
231
232
 
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 225

class CreateGroupRequest < Struct.new(
  :group_name,
  :filter_expression,
  :insights_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#group_name ⇒ String

The case-sensitive name of the new group. Default is a reserved name and names must be unique.

Returns:

  • (String) 


225
226
227
228
229
230
231
232
 
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 225

class CreateGroupRequest < Struct.new(
  :group_name,
  :filter_expression,
  :insights_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#insights_configuration ⇒ Types::InsightsConfiguration

The structure containing configurations related to insights.

  • The InsightsEnabled boolean can be set to true to enable insights for the new group or false to disable insights for the new group.

  • The NotificationsEnabled boolean can be set to true to enable insights notifications for the new group. Notifications may only be enabled on a group with InsightsEnabled set to true.

Returns:



225
226
227
228
229
230
231
232
 
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 225

class CreateGroupRequest < Struct.new(
  :group_name,
  :filter_expression,
  :insights_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

A map that contains one or more tag keys and tag values to attach to an X-Ray group. For more information about ways to use tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference.

The following restrictions apply to tags:

  • Maximum number of user-applied tags per resource: 50

  • Maximum tag key length: 128 Unicode characters

  • Maximum tag value length: 256 Unicode characters

  • Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @

  • Tag keys and values are case sensitive.

  • Don't use aws: as a prefix for keys; it's reserved for Amazon Web Services use.

Returns:



225
226
227
228
229
230
231
232
 
# File 'gems/aws-sdk-xray/lib/aws-sdk-xray/types.rb', line 225

class CreateGroupRequest < Struct.new(
  :group_name,
  :filter_expression,
  :insights_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end