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

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

Overview

Note:

When making an API call, you may pass CreateGroupRequest data as a hash:

{
  group_name: "GroupName", # required
  filter_expression: "FilterExpression",
  insights_configuration: {
    insights_enabled: false,
    notifications_enabled: false,
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#filter_expressionString

The filter expression defining criteria by which to group traces.

Returns:

  • (String)

247
248
249
250
251
252
253
254
# File 'lib/aws-sdk-xray/types.rb', line 247

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

#group_nameString

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

Returns:

  • (String)

247
248
249
250
251
252
253
254
# File 'lib/aws-sdk-xray/types.rb', line 247

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

#insights_configurationTypes::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 NotifcationsEnabled 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.


247
248
249
250
251
252
253
254
# File 'lib/aws-sdk-xray/types.rb', line 247

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

#tagsArray<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][1

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.

[1]: docs.aws.amazon.com/general/latest/gr/aws_tagging.html

Returns:


247
248
249
250
251
252
253
254
# File 'lib/aws-sdk-xray/types.rb', line 247

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