Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. quicksight
  5. Group
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

aws.quicksight.Group

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

    Resource for managing QuickSight Group

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.quicksight.Group("example", {groupName: "tf-example"});

    import pulumi
import pulumi_aws as aws

example = aws.quicksight.Group("example", group_name="tf-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.NewGroup(ctx, "example", &quicksight.GroupArgs{
			GroupName: pulumi.String("tf-example"),
		})
		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.Quicksight.Group("example", new()
    {
        GroupName = "tf-example",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.quicksight.Group;
import com.pulumi.aws.quicksight.GroupArgs;
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("tf-example")
            .build());

    }
}

    resources:
  example:
    type: aws:quicksight:Group
    properties:
      groupName: tf-example

    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,
          group_name: Optional[str] = None,
          aws_account_id: Optional[str] = None,
          description: Optional[str] = None,
          namespace: Optional[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:quicksight: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.

    Constructor example

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

    var examplegroupResourceResourceFromQuicksightgroup = new Aws.Quicksight.Group("examplegroupResourceResourceFromQuicksightgroup", new()
{
    GroupName = "string",
    AwsAccountId = "string",
    Description = "string",
    Namespace = "string",
});

    example, err := quicksight.NewGroup(ctx, "examplegroupResourceResourceFromQuicksightgroup", &quicksight.GroupArgs{
	GroupName:    pulumi.String("string"),
	AwsAccountId: pulumi.String("string"),
	Description:  pulumi.String("string"),
	Namespace:    pulumi.String("string"),
})

    var examplegroupResourceResourceFromQuicksightgroup = new Group("examplegroupResourceResourceFromQuicksightgroup", GroupArgs.builder()
    .groupName("string")
    .awsAccountId("string")
    .description("string")
    .namespace("string")
    .build());

    examplegroup_resource_resource_from_quicksightgroup = aws.quicksight.Group("examplegroupResourceResourceFromQuicksightgroup",
    group_name="string",
    aws_account_id="string",
    description="string",
    namespace="string")

    const examplegroupResourceResourceFromQuicksightgroup = new aws.quicksight.Group("examplegroupResourceResourceFromQuicksightgroup", {
    groupName: "string",
    awsAccountId: "string",
    description: "string",
    namespace: "string",
});

    type: aws:quicksight:Group
properties:
    awsAccountId: string
    description: string
    groupName: string
    namespace: 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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Group resource accepts the following input properties:

    GroupName string
    A name for the group.
    AwsAccountId string
    The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
    Description string
    A description for the group.
    Namespace string
    The namespace. Currently, you should set this to default.
    GroupName string
    A name for the group.
    AwsAccountId string
    The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
    Description string
    A description for the group.
    Namespace string
    The namespace. Currently, you should set this to default.
    groupName String
    A name for the group.
    awsAccountId String
    The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
    description String
    A description for the group.
    namespace String
    The namespace. Currently, you should set this to default.
    groupName string
    A name for the group.
    awsAccountId string
    The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
    description string
    A description for the group.
    namespace string
    The namespace. Currently, you should set this to default.
    group_name str
    A name for the group.
    aws_account_id str
    The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
    description str
    A description for the group.
    namespace str
    The namespace. Currently, you should set this to default.
    groupName String
    A name for the group.
    awsAccountId String
    The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
    description String
    A description for the group.
    namespace String
    The namespace. Currently, you should set this to default.

    Outputs

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

    Arn string
    Amazon Resource Name (ARN) of group
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    Amazon Resource Name (ARN) of group
    Id string
    The provider-assigned unique ID for this managed resource.
    arn String
    Amazon Resource Name (ARN) of group
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    Amazon Resource Name (ARN) of group
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    Amazon Resource Name (ARN) of group
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    Amazon Resource Name (ARN) of group
    id String
    The provider-assigned unique ID for this managed resource.

    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,
        aws_account_id: Optional[str] = None,
        description: Optional[str] = None,
        group_name: Optional[str] = None,
        namespace: Optional[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
    Amazon Resource Name (ARN) of group
    AwsAccountId string
    The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
    Description string
    A description for the group.
    GroupName string
    A name for the group.
    Namespace string
    The namespace. Currently, you should set this to default.
    Arn string
    Amazon Resource Name (ARN) of group
    AwsAccountId string
    The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
    Description string
    A description for the group.
    GroupName string
    A name for the group.
    Namespace string
    The namespace. Currently, you should set this to default.
    arn String
    Amazon Resource Name (ARN) of group
    awsAccountId String
    The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
    description String
    A description for the group.
    groupName String
    A name for the group.
    namespace String
    The namespace. Currently, you should set this to default.
    arn string
    Amazon Resource Name (ARN) of group
    awsAccountId string
    The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
    description string
    A description for the group.
    groupName string
    A name for the group.
    namespace string
    The namespace. Currently, you should set this to default.
    arn str
    Amazon Resource Name (ARN) of group
    aws_account_id str
    The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
    description str
    A description for the group.
    group_name str
    A name for the group.
    namespace str
    The namespace. Currently, you should set this to default.
    arn String
    Amazon Resource Name (ARN) of group
    awsAccountId String
    The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
    description String
    A description for the group.
    groupName String
    A name for the group.
    namespace String
    The namespace. Currently, you should set this to default.

    Import

    Using pulumi import, import QuickSight Group using the aws account id, namespace and group name separated by /. For example:

    $ pulumi import aws:quicksight/group:Group example 123456789123/default/tf-example

    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
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-aws