Skip to content

Resource: awsXrayGroup

Creates and manages an AWS XRay Group.

Example Usage

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.xrayGroup.XrayGroup(this, "example", {
  filterExpression: "responsetime > 5",
  groupName: "example",
  insightsConfiguration: {
    insightsEnabled: true,
    notificationsEnabled: true,
  },
});

Argument Reference

  • groupName - (Required) The name of the group.
  • filterExpression - (Required) The filter expression defining criteria by which to group traces. more info can be found in official docs.
  • insightsConfiguration - (Optional) Configuration options for enabling insights.
  • tags - (Optional) Key-value mapping of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Nested fields

insightsConfiguration

  • insightsEnabled - (Required) Specifies whether insights are enabled.
  • notificationsEnabled - (Optional) Specifies whether insight notifications are enabled.

Attributes Reference

In addition to all arguments above, the following attributes are exported:

  • id - The ARN of the Group.
  • arn - The ARN of the Group.
  • tagsAll - A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.

Import

XRay Groups can be imported using the ARN, e.g.,

$ terraform import aws_xray_group.example arn:aws:xray:us-west-2:1234567890:group/example-group/TNGX7SW5U6QY36T4ZMOUA3HVLBYCZTWDIOOXY3CJAXTHSS3YCWUA