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

Inherits:

Struct

• Object
• Struct
• Aws::XRay::Types::CreateGroupRequest

Includes:

Structure

Defined in:

lib/aws-sdk-xray/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #filter_expression ⇒ String

  The filter expression defining criteria by which to group traces.

• #group_name ⇒ String

  The case-sensitive name of the new group.

• #insights_configuration ⇒ Types::InsightsConfiguration

  The structure containing configurations related to insights.

• #tags ⇒ Array<Types::Tag>

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

Instance Attribute Details

#filter_expression ⇒ String

The filter expression defining criteria by which to group traces.

Returns:

• (String)

# File '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)

# File '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:

• (Types::InsightsConfiguration)

# File '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][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:

• (Array<Types::Tag>)

# File 'lib/aws-sdk-xray/types.rb', line 225

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