Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Native
  3. API Docs
  4. xray
  5. Group

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.xray.Group

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

    This schema provides construct and validation rules for AWS-XRay Group resource parameters.

    Example Usage

    Example

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var myGroupResource = new AwsNative.XRay.Group("myGroupResource", new()
    {
        GroupName = "MyGroup",
        FilterExpression = "duration > 10",
        InsightsConfiguration = new AwsNative.XRay.Inputs.GroupInsightsConfigurationArgs
        {
            InsightsEnabled = false,
            NotificationsEnabled = false,
        },
    });

});

    package main

import (
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/xray"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := xray.NewGroup(ctx, "myGroupResource", &xray.GroupArgs{
			GroupName:        pulumi.String("MyGroup"),
			FilterExpression: pulumi.String("duration > 10"),
			InsightsConfiguration: &xray.GroupInsightsConfigurationArgs{
				InsightsEnabled:      pulumi.Bool(false),
				NotificationsEnabled: pulumi.Bool(false),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Coming soon!

    import pulumi
import pulumi_aws_native as aws_native

my_group_resource = aws_native.xray.Group("myGroupResource",
    group_name="MyGroup",
    filter_expression="duration > 10",
    insights_configuration={
        "insights_enabled": False,
        "notifications_enabled": False,
    })

    import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const myGroupResource = new aws_native.xray.Group("myGroupResource", {
    groupName: "MyGroup",
    filterExpression: "duration > 10",
    insightsConfiguration: {
        insightsEnabled: false,
        notificationsEnabled: false,
    },
});

    Coming soon!

    Example

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var myGroupResource = new AwsNative.XRay.Group("myGroupResource", new()
    {
        GroupName = "MyGroup",
        FilterExpression = "duration > 10",
        InsightsConfiguration = new AwsNative.XRay.Inputs.GroupInsightsConfigurationArgs
        {
            InsightsEnabled = false,
            NotificationsEnabled = false,
        },
    });

});

    package main

import (
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/xray"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := xray.NewGroup(ctx, "myGroupResource", &xray.GroupArgs{
			GroupName:        pulumi.String("MyGroup"),
			FilterExpression: pulumi.String("duration > 10"),
			InsightsConfiguration: &xray.GroupInsightsConfigurationArgs{
				InsightsEnabled:      pulumi.Bool(false),
				NotificationsEnabled: pulumi.Bool(false),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Coming soon!

    import pulumi
import pulumi_aws_native as aws_native

my_group_resource = aws_native.xray.Group("myGroupResource",
    group_name="MyGroup",
    filter_expression="duration > 10",
    insights_configuration={
        "insights_enabled": False,
        "notifications_enabled": False,
    })

    import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const myGroupResource = new aws_native.xray.Group("myGroupResource", {
    groupName: "MyGroup",
    filterExpression: "duration > 10",
    insightsConfiguration: {
        insightsEnabled: false,
        notificationsEnabled: false,
    },
});

    Coming soon!

    Create Group Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Group(name: string, args?: GroupArgs, opts?: CustomResourceOptions);
    @overload
def Group(resource_name: str,
          args: Optional[GroupArgs] = None,
          opts: Optional[ResourceOptions] = None)

@overload
def Group(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          filter_expression: Optional[str] = None,
          group_name: Optional[str] = None,
          insights_configuration: Optional[GroupInsightsConfigurationArgs] = None,
          tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewGroup(ctx *Context, name string, args *GroupArgs, opts ...ResourceOption) (*Group, error)
    public Group(string name, GroupArgs? args = null, CustomResourceOptions? opts = null)
    public Group(String name, GroupArgs args)
public Group(String name, GroupArgs args, CustomResourceOptions options)

    type: aws-native:xray:Group
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args GroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args GroupArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args GroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Group Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Group resource accepts the following input properties:

    FilterExpression string
    The filter expression defining criteria by which to group traces.
    GroupName string
    The case-sensitive name of the new group. Names must be unique.
    InsightsConfiguration Pulumi.AwsNative.XRay.Inputs.GroupInsightsConfiguration
    The structure containing configurations related to insights.

    • The InsightsEnabled boolean can be set to true to enable insights for the group or false to disable insights for the group.
    • The NotificationsEnabled boolean can be set to true to enable insights notifications through Amazon EventBridge for the group.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    An array of key-value pairs to apply to this resource.
    FilterExpression string
    The filter expression defining criteria by which to group traces.
    GroupName string
    The case-sensitive name of the new group. Names must be unique.
    InsightsConfiguration GroupInsightsConfigurationArgs
    The structure containing configurations related to insights.

    • The InsightsEnabled boolean can be set to true to enable insights for the group or false to disable insights for the group.
    • The NotificationsEnabled boolean can be set to true to enable insights notifications through Amazon EventBridge for the group.
    Tags TagArgs
    An array of key-value pairs to apply to this resource.
    filterExpression String
    The filter expression defining criteria by which to group traces.
    groupName String
    The case-sensitive name of the new group. Names must be unique.
    insightsConfiguration GroupInsightsConfiguration
    The structure containing configurations related to insights.

    • The InsightsEnabled boolean can be set to true to enable insights for the group or false to disable insights for the group.
    • The NotificationsEnabled boolean can be set to true to enable insights notifications through Amazon EventBridge for the group.
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    filterExpression string
    The filter expression defining criteria by which to group traces.
    groupName string
    The case-sensitive name of the new group. Names must be unique.
    insightsConfiguration GroupInsightsConfiguration
    The structure containing configurations related to insights.

    • The InsightsEnabled boolean can be set to true to enable insights for the group or false to disable insights for the group.
    • The NotificationsEnabled boolean can be set to true to enable insights notifications through Amazon EventBridge for the group.
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    filter_expression str
    The filter expression defining criteria by which to group traces.
    group_name str
    The case-sensitive name of the new group. Names must be unique.
    insights_configuration GroupInsightsConfigurationArgs
    The structure containing configurations related to insights.

    • The InsightsEnabled boolean can be set to true to enable insights for the group or false to disable insights for the group.
    • The NotificationsEnabled boolean can be set to true to enable insights notifications through Amazon EventBridge for the group.
    tags Sequence[TagArgs]
    An array of key-value pairs to apply to this resource.
    filterExpression String
    The filter expression defining criteria by which to group traces.
    groupName String
    The case-sensitive name of the new group. Names must be unique.
    insightsConfiguration Property Map
    The structure containing configurations related to insights.

    • The InsightsEnabled boolean can be set to true to enable insights for the group or false to disable insights for the group.
    • The NotificationsEnabled boolean can be set to true to enable insights notifications through Amazon EventBridge for the group.
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Group resource produces the following output properties:

    GroupArn string
    The ARN of the group that was generated on creation.
    Id string
    The provider-assigned unique ID for this managed resource.
    GroupArn string
    The ARN of the group that was generated on creation.
    Id string
    The provider-assigned unique ID for this managed resource.
    groupArn String
    The ARN of the group that was generated on creation.
    id String
    The provider-assigned unique ID for this managed resource.
    groupArn string
    The ARN of the group that was generated on creation.
    id string
    The provider-assigned unique ID for this managed resource.
    group_arn str
    The ARN of the group that was generated on creation.
    id str
    The provider-assigned unique ID for this managed resource.
    groupArn String
    The ARN of the group that was generated on creation.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    GroupInsightsConfiguration, GroupInsightsConfigurationArgs

    InsightsEnabled bool
    Set the InsightsEnabled value to true to enable insights or false to disable insights.
    NotificationsEnabled bool
    Set the NotificationsEnabled value to true to enable insights notifications. Notifications can only be enabled on a group with InsightsEnabled set to true.
    InsightsEnabled bool
    Set the InsightsEnabled value to true to enable insights or false to disable insights.
    NotificationsEnabled bool
    Set the NotificationsEnabled value to true to enable insights notifications. Notifications can only be enabled on a group with InsightsEnabled set to true.
    insightsEnabled Boolean
    Set the InsightsEnabled value to true to enable insights or false to disable insights.
    notificationsEnabled Boolean
    Set the NotificationsEnabled value to true to enable insights notifications. Notifications can only be enabled on a group with InsightsEnabled set to true.
    insightsEnabled boolean
    Set the InsightsEnabled value to true to enable insights or false to disable insights.
    notificationsEnabled boolean
    Set the NotificationsEnabled value to true to enable insights notifications. Notifications can only be enabled on a group with InsightsEnabled set to true.
    insights_enabled bool
    Set the InsightsEnabled value to true to enable insights or false to disable insights.
    notifications_enabled bool
    Set the NotificationsEnabled value to true to enable insights notifications. Notifications can only be enabled on a group with InsightsEnabled set to true.
    insightsEnabled Boolean
    Set the InsightsEnabled value to true to enable insights or false to disable insights.
    notificationsEnabled Boolean
    Set the NotificationsEnabled value to true to enable insights notifications. Notifications can only be enabled on a group with InsightsEnabled set to true.

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
    pulumi/pulumi-aws-native