Skip to content

Create Group

xray_create_group R Documentation

Creates a group resource with a name and a filter expression

Description

Creates a group resource with a name and a filter expression.

Usage

xray_create_group(GroupName, FilterExpression, InsightsConfiguration,
  Tags)

Arguments

GroupName

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

FilterExpression

The filter expression defining criteria by which to group traces.

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.

Tags

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.

Value

A list with the following syntax: 

list(
  Group = list(
    GroupName = "string",
    GroupARN = "string",
    FilterExpression = "string",
    InsightsConfiguration = list(
      InsightsEnabled = TRUE|FALSE,
      NotificationsEnabled = TRUE|FALSE
    )
  )
)

Request syntax

svc$create_group(
  GroupName = "string",
  FilterExpression = "string",
  InsightsConfiguration = list(
    InsightsEnabled = TRUE|FALSE,
    NotificationsEnabled = TRUE|FALSE
  ),
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)