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

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.getGroup

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.

    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
    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.Outputs.Tag>
    An array of key-value pairs to apply to this resource.
    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
    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.
    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
    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.
    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
    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_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
    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[root_Tag]
    An array of key-value pairs to apply to this resource.
    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
    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.

    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

    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