Try AWS Native preview for resources not in the classic version.
aws.quicksight.getQuicksightGroup
Explore with Pulumi AI
Try AWS Native preview for resources not in the classic version.
This data source can be used to fetch information about a specific QuickSight group. By using this data source, you can reference QuickSight group properties without having to hard code ARNs or unique IDs as input.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = aws.quicksight.getQuicksightGroup({
groupName: "example",
});
import pulumi
import pulumi_aws as aws
example = aws.quicksight.get_quicksight_group(group_name="example")
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/quicksight"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := quicksight.GetQuicksightGroup(ctx, &quicksight.GetQuicksightGroupArgs{
GroupName: "example",
}, nil)
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 = Aws.Quicksight.GetQuicksightGroup.Invoke(new()
{
GroupName = "example",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.quicksight.QuicksightFunctions;
import com.pulumi.aws.quicksight.inputs.GetQuicksightGroupArgs;
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) {
final var example = QuicksightFunctions.getQuicksightGroup(GetQuicksightGroupArgs.builder()
.groupName("example")
.build());
}
}
variables:
example:
fn::invoke:
Function: aws:quicksight:getQuicksightGroup
Arguments:
groupName: example
Using getQuicksightGroup
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 getQuicksightGroup(args: GetQuicksightGroupArgs, opts?: InvokeOptions): Promise<GetQuicksightGroupResult>
function getQuicksightGroupOutput(args: GetQuicksightGroupOutputArgs, opts?: InvokeOptions): Output<GetQuicksightGroupResult>
def get_quicksight_group(aws_account_id: Optional[str] = None,
group_name: Optional[str] = None,
namespace: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetQuicksightGroupResult
def get_quicksight_group_output(aws_account_id: Optional[pulumi.Input[str]] = None,
group_name: Optional[pulumi.Input[str]] = None,
namespace: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetQuicksightGroupResult]
func GetQuicksightGroup(ctx *Context, args *GetQuicksightGroupArgs, opts ...InvokeOption) (*GetQuicksightGroupResult, error)
func GetQuicksightGroupOutput(ctx *Context, args *GetQuicksightGroupOutputArgs, opts ...InvokeOption) GetQuicksightGroupResultOutput
> Note: This function is named GetQuicksightGroup
in the Go SDK.
public static class GetQuicksightGroup
{
public static Task<GetQuicksightGroupResult> InvokeAsync(GetQuicksightGroupArgs args, InvokeOptions? opts = null)
public static Output<GetQuicksightGroupResult> Invoke(GetQuicksightGroupInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetQuicksightGroupResult> getQuicksightGroup(GetQuicksightGroupArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aws:quicksight/getQuicksightGroup:getQuicksightGroup
arguments:
# arguments dictionary
The following arguments are supported:
- Group
Name string The name of the group that you want to match.
The following arguments are optional:
- Aws
Account stringId - AWS account ID.
- Namespace string
- QuickSight namespace. Defaults to
default
.
- Group
Name string The name of the group that you want to match.
The following arguments are optional:
- Aws
Account stringId - AWS account ID.
- Namespace string
- QuickSight namespace. Defaults to
default
.
- group
Name String The name of the group that you want to match.
The following arguments are optional:
- aws
Account StringId - AWS account ID.
- namespace String
- QuickSight namespace. Defaults to
default
.
- group
Name string The name of the group that you want to match.
The following arguments are optional:
- aws
Account stringId - AWS account ID.
- namespace string
- QuickSight namespace. Defaults to
default
.
- group_
name str The name of the group that you want to match.
The following arguments are optional:
- aws_
account_ strid - AWS account ID.
- namespace str
- QuickSight namespace. Defaults to
default
.
- group
Name String The name of the group that you want to match.
The following arguments are optional:
- aws
Account StringId - AWS account ID.
- namespace String
- QuickSight namespace. Defaults to
default
.
getQuicksightGroup Result
The following output properties are available:
- Arn string
- The Amazon Resource Name (ARN) for the group.
- Aws
Account stringId - Description string
- The group description.
- Group
Name string - Id string
- The provider-assigned unique ID for this managed resource.
- Principal
Id string - The principal ID of the group.
- Namespace string
- Arn string
- The Amazon Resource Name (ARN) for the group.
- Aws
Account stringId - Description string
- The group description.
- Group
Name string - Id string
- The provider-assigned unique ID for this managed resource.
- Principal
Id string - The principal ID of the group.
- Namespace string
- arn String
- The Amazon Resource Name (ARN) for the group.
- aws
Account StringId - description String
- The group description.
- group
Name String - id String
- The provider-assigned unique ID for this managed resource.
- principal
Id String - The principal ID of the group.
- namespace String
- arn string
- The Amazon Resource Name (ARN) for the group.
- aws
Account stringId - description string
- The group description.
- group
Name string - id string
- The provider-assigned unique ID for this managed resource.
- principal
Id string - The principal ID of the group.
- namespace string
- arn str
- The Amazon Resource Name (ARN) for the group.
- aws_
account_ strid - description str
- The group description.
- group_
name str - id str
- The provider-assigned unique ID for this managed resource.
- principal_
id str - The principal ID of the group.
- namespace str
- arn String
- The Amazon Resource Name (ARN) for the group.
- aws
Account StringId - description String
- The group description.
- group
Name String - id String
- The provider-assigned unique ID for this managed resource.
- principal
Id String - The principal ID of the group.
- namespace String
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aws
Terraform Provider.
Try AWS Native preview for resources not in the classic version.