You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateGroupRequest as input to an Aws::Client method, you can use a vanilla Hash:

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

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#filter_expression ⇒ String

The filter expression defining criteria by which to group traces.

Returns:

  • (String) —

    The filter expression defining criteria by which to group traces.

#group_name ⇒ String

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

Returns:

  • (String) —

    The case-sensitive name of the new group.

#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 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.

Returns:

#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 AWS resources in the AWS 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 AWS use.

Returns:

  • (Array<Types::Tag>) —

    A map that contains one or more tag keys and tag values to attach to an X-Ray group.