1. Packages
  2. AWS Native
  3. API Docs
  4. xray
  5. getGroup

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.101.0 published on Thursday, Apr 11, 2024 by Pulumi

aws-native.xray.getGroup

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.101.0 published on Thursday, Apr 11, 2024 by Pulumi

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

    Using getGroup

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getGroup(args: GetGroupArgs, opts?: InvokeOptions): Promise<GetGroupResult>
    function getGroupOutput(args: GetGroupOutputArgs, opts?: InvokeOptions): Output<GetGroupResult>
    def get_group(group_arn: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetGroupResult
    def get_group_output(group_arn: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetGroupResult]
    func LookupGroup(ctx *Context, args *LookupGroupArgs, opts ...InvokeOption) (*LookupGroupResult, error)
    func LookupGroupOutput(ctx *Context, args *LookupGroupOutputArgs, opts ...InvokeOption) LookupGroupResultOutput

    > Note: This function is named LookupGroup in the Go SDK.

    public static class GetGroup 
    {
        public static Task<GetGroupResult> InvokeAsync(GetGroupArgs args, InvokeOptions? opts = null)
        public static Output<GetGroupResult> Invoke(GetGroupInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetGroupResult> getGroup(GetGroupArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:xray:getGroup
      arguments:
        # arguments dictionary

    The following arguments are supported:

    GroupArn string
    The ARN of the group that was generated on creation.
    GroupArn string
    The ARN of the group that was generated on creation.
    groupArn String
    The ARN of the group that was generated on creation.
    groupArn string
    The ARN of the group that was generated on creation.
    group_arn str
    The ARN of the group that was generated on creation.
    groupArn String
    The ARN of the group that was generated on creation.

    getGroup Result

    The following output properties are available:

    FilterExpression string
    The filter expression defining criteria by which to group traces.
    GroupArn string
    The ARN of the group that was generated on creation.
    GroupName string
    The case-sensitive name of the new group. Names must be unique.
    InsightsConfiguration Pulumi.AwsNative.XRay.Outputs.GroupInsightsConfiguration
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    FilterExpression string
    The filter expression defining criteria by which to group traces.
    GroupArn string
    The ARN of the group that was generated on creation.
    GroupName string
    The case-sensitive name of the new group. Names must be unique.
    InsightsConfiguration GroupInsightsConfiguration
    Tags Tag
    filterExpression String
    The filter expression defining criteria by which to group traces.
    groupArn String
    The ARN of the group that was generated on creation.
    groupName String
    The case-sensitive name of the new group. Names must be unique.
    insightsConfiguration GroupInsightsConfiguration
    tags List<Tag>
    filterExpression string
    The filter expression defining criteria by which to group traces.
    groupArn string
    The ARN of the group that was generated on creation.
    groupName string
    The case-sensitive name of the new group. Names must be unique.
    insightsConfiguration GroupInsightsConfiguration
    tags Tag[]
    filter_expression str
    The filter expression defining criteria by which to group traces.
    group_arn str
    The ARN of the group that was generated on creation.
    group_name str
    The case-sensitive name of the new group. Names must be unique.
    insights_configuration GroupInsightsConfiguration
    tags Sequence[root_Tag]
    filterExpression String
    The filter expression defining criteria by which to group traces.
    groupArn String
    The ARN of the group that was generated on creation.
    groupName String
    The case-sensitive name of the new group. Names must be unique.
    insightsConfiguration Property Map
    tags List<Property Map>

    Supporting Types

    GroupInsightsConfiguration

    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

    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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.101.0 published on Thursday, Apr 11, 2024 by Pulumi