1. Packages
  2. AWS Classic
  3. API Docs
  4. xray
  5. Group

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.41.0 published on Tuesday, Jun 18, 2024 by Pulumi

aws.xray.Group

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.41.0 published on Tuesday, Jun 18, 2024 by Pulumi

    Creates and manages an AWS XRay Group.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.xray.Group("example", {
        groupName: "example",
        filterExpression: "responsetime > 5",
        insightsConfiguration: {
            insightsEnabled: true,
            notificationsEnabled: true,
        },
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.xray.Group("example",
        group_name="example",
        filter_expression="responsetime > 5",
        insights_configuration=aws.xray.GroupInsightsConfigurationArgs(
            insights_enabled=True,
            notifications_enabled=True,
        ))
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/xray"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := xray.NewGroup(ctx, "example", &xray.GroupArgs{
    			GroupName:        pulumi.String("example"),
    			FilterExpression: pulumi.String("responsetime > 5"),
    			InsightsConfiguration: &xray.GroupInsightsConfigurationArgs{
    				InsightsEnabled:      pulumi.Bool(true),
    				NotificationsEnabled: pulumi.Bool(true),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aws.Xray.Group("example", new()
        {
            GroupName = "example",
            FilterExpression = "responsetime > 5",
            InsightsConfiguration = new Aws.Xray.Inputs.GroupInsightsConfigurationArgs
            {
                InsightsEnabled = true,
                NotificationsEnabled = true,
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.xray.Group;
    import com.pulumi.aws.xray.GroupArgs;
    import com.pulumi.aws.xray.inputs.GroupInsightsConfigurationArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new Group("example", GroupArgs.builder()
                .groupName("example")
                .filterExpression("responsetime > 5")
                .insightsConfiguration(GroupInsightsConfigurationArgs.builder()
                    .insightsEnabled(true)
                    .notificationsEnabled(true)
                    .build())
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:xray:Group
        properties:
          groupName: example
          filterExpression: responsetime > 5
          insightsConfiguration:
            insightsEnabled: true
            notificationsEnabled: true
    

    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: GroupArgs,
              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[Mapping[str, str]] = None)
    func NewGroup(ctx *Context, name string, args GroupArgs, opts ...ResourceOption) (*Group, error)
    public Group(string name, GroupArgs args, CustomResourceOptions? opts = null)
    public Group(String name, GroupArgs args)
    public Group(String name, GroupArgs args, CustomResourceOptions options)
    
    type: aws: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.

    Example

    The following reference example uses placeholder values for all input properties.

    var examplegroupResourceResourceFromXraygroup = new Aws.Xray.Group("examplegroupResourceResourceFromXraygroup", new()
    {
        FilterExpression = "string",
        GroupName = "string",
        InsightsConfiguration = new Aws.Xray.Inputs.GroupInsightsConfigurationArgs
        {
            InsightsEnabled = false,
            NotificationsEnabled = false,
        },
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := xray.NewGroup(ctx, "examplegroupResourceResourceFromXraygroup", &xray.GroupArgs{
    	FilterExpression: pulumi.String("string"),
    	GroupName:        pulumi.String("string"),
    	InsightsConfiguration: &xray.GroupInsightsConfigurationArgs{
    		InsightsEnabled:      pulumi.Bool(false),
    		NotificationsEnabled: pulumi.Bool(false),
    	},
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var examplegroupResourceResourceFromXraygroup = new Group("examplegroupResourceResourceFromXraygroup", GroupArgs.builder()
        .filterExpression("string")
        .groupName("string")
        .insightsConfiguration(GroupInsightsConfigurationArgs.builder()
            .insightsEnabled(false)
            .notificationsEnabled(false)
            .build())
        .tags(Map.of("string", "string"))
        .build());
    
    examplegroup_resource_resource_from_xraygroup = aws.xray.Group("examplegroupResourceResourceFromXraygroup",
        filter_expression="string",
        group_name="string",
        insights_configuration=aws.xray.GroupInsightsConfigurationArgs(
            insights_enabled=False,
            notifications_enabled=False,
        ),
        tags={
            "string": "string",
        })
    
    const examplegroupResourceResourceFromXraygroup = new aws.xray.Group("examplegroupResourceResourceFromXraygroup", {
        filterExpression: "string",
        groupName: "string",
        insightsConfiguration: {
            insightsEnabled: false,
            notificationsEnabled: false,
        },
        tags: {
            string: "string",
        },
    });
    
    type: aws:xray:Group
    properties:
        filterExpression: string
        groupName: string
        insightsConfiguration:
            insightsEnabled: false
            notificationsEnabled: false
        tags:
            string: string
    

    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. more info can be found in official docs.
    GroupName string
    The name of the group.
    InsightsConfiguration Pulumi.Aws.Xray.Inputs.GroupInsightsConfiguration
    Configuration options for enabling insights.
    Tags Dictionary<string, string>
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level
    FilterExpression string
    The filter expression defining criteria by which to group traces. more info can be found in official docs.
    GroupName string
    The name of the group.
    InsightsConfiguration GroupInsightsConfigurationArgs
    Configuration options for enabling insights.
    Tags map[string]string
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level
    filterExpression String
    The filter expression defining criteria by which to group traces. more info can be found in official docs.
    groupName String
    The name of the group.
    insightsConfiguration GroupInsightsConfiguration
    Configuration options for enabling insights.
    tags Map<String,String>
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level
    filterExpression string
    The filter expression defining criteria by which to group traces. more info can be found in official docs.
    groupName string
    The name of the group.
    insightsConfiguration GroupInsightsConfiguration
    Configuration options for enabling insights.
    tags {[key: string]: string}
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level
    filter_expression str
    The filter expression defining criteria by which to group traces. more info can be found in official docs.
    group_name str
    The name of the group.
    insights_configuration GroupInsightsConfigurationArgs
    Configuration options for enabling insights.
    tags Mapping[str, str]
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level
    filterExpression String
    The filter expression defining criteria by which to group traces. more info can be found in official docs.
    groupName String
    The name of the group.
    insightsConfiguration Property Map
    Configuration options for enabling insights.
    tags Map<String>
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level

    Outputs

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

    Arn string
    The ARN of the Group.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    The ARN of the Group.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The ARN of the Group.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    The ARN of the Group.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    The ARN of the Group.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The ARN of the Group.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing Group Resource

    Get an existing Group resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: GroupState, opts?: CustomResourceOptions): Group
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            arn: Optional[str] = None,
            filter_expression: Optional[str] = None,
            group_name: Optional[str] = None,
            insights_configuration: Optional[GroupInsightsConfigurationArgs] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None) -> Group
    func GetGroup(ctx *Context, name string, id IDInput, state *GroupState, opts ...ResourceOption) (*Group, error)
    public static Group Get(string name, Input<string> id, GroupState? state, CustomResourceOptions? opts = null)
    public static Group get(String name, Output<String> id, GroupState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    The ARN of the Group.
    FilterExpression string
    The filter expression defining criteria by which to group traces. more info can be found in official docs.
    GroupName string
    The name of the group.
    InsightsConfiguration Pulumi.Aws.Xray.Inputs.GroupInsightsConfiguration
    Configuration options for enabling insights.
    Tags Dictionary<string, string>
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    The ARN of the Group.
    FilterExpression string
    The filter expression defining criteria by which to group traces. more info can be found in official docs.
    GroupName string
    The name of the group.
    InsightsConfiguration GroupInsightsConfigurationArgs
    Configuration options for enabling insights.
    Tags map[string]string
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The ARN of the Group.
    filterExpression String
    The filter expression defining criteria by which to group traces. more info can be found in official docs.
    groupName String
    The name of the group.
    insightsConfiguration GroupInsightsConfiguration
    Configuration options for enabling insights.
    tags Map<String,String>
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    The ARN of the Group.
    filterExpression string
    The filter expression defining criteria by which to group traces. more info can be found in official docs.
    groupName string
    The name of the group.
    insightsConfiguration GroupInsightsConfiguration
    Configuration options for enabling insights.
    tags {[key: string]: string}
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    The ARN of the Group.
    filter_expression str
    The filter expression defining criteria by which to group traces. more info can be found in official docs.
    group_name str
    The name of the group.
    insights_configuration GroupInsightsConfigurationArgs
    Configuration options for enabling insights.
    tags Mapping[str, str]
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The ARN of the Group.
    filterExpression String
    The filter expression defining criteria by which to group traces. more info can be found in official docs.
    groupName String
    The name of the group.
    insightsConfiguration Property Map
    Configuration options for enabling insights.
    tags Map<String>
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Supporting Types

    GroupInsightsConfiguration, GroupInsightsConfigurationArgs

    InsightsEnabled bool
    Specifies whether insights are enabled.
    NotificationsEnabled bool
    Specifies whether insight notifications are enabled.
    InsightsEnabled bool
    Specifies whether insights are enabled.
    NotificationsEnabled bool
    Specifies whether insight notifications are enabled.
    insightsEnabled Boolean
    Specifies whether insights are enabled.
    notificationsEnabled Boolean
    Specifies whether insight notifications are enabled.
    insightsEnabled boolean
    Specifies whether insights are enabled.
    notificationsEnabled boolean
    Specifies whether insight notifications are enabled.
    insights_enabled bool
    Specifies whether insights are enabled.
    notifications_enabled bool
    Specifies whether insight notifications are enabled.
    insightsEnabled Boolean
    Specifies whether insights are enabled.
    notificationsEnabled Boolean
    Specifies whether insight notifications are enabled.

    Import

    Using pulumi import, import XRay Groups using the ARN. For example:

    $ pulumi import aws:xray/group:Group example arn:aws:xray:us-west-2:1234567890:group/example-group/TNGX7SW5U6QY36T4ZMOUA3HVLBYCZTWDIOOXY3CJAXTHSS3YCWUA
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.41.0 published on Tuesday, Jun 18, 2024 by Pulumi