1. Packages
  2. AWS Classic
  3. API Docs
  4. quicksight
  5. Folder

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

AWS Classic v6.3.0 published on Thursday, Sep 28, 2023 by Pulumi

aws.quicksight.Folder

Explore with Pulumi AI

aws logo

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

AWS Classic v6.3.0 published on Thursday, Sep 28, 2023 by Pulumi

    Resource for managing a QuickSight Folder.

    Example Usage

    Basic Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aws.Quicksight.Folder("example", new()
        {
            FolderId = "example-id",
        });
    
    });
    
    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.NewFolder(ctx, "example", &quicksight.FolderArgs{
    			FolderId: pulumi.String("example-id"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.quicksight.Folder;
    import com.pulumi.aws.quicksight.FolderArgs;
    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 Folder("example", FolderArgs.builder()        
                .folderId("example-id")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.quicksight.Folder("example", folder_id="example-id")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.quicksight.Folder("example", {folderId: "example-id"});
    
    resources:
      example:
        type: aws:quicksight:Folder
        properties:
          folderId: example-id
    

    With Permissions

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aws.Quicksight.Folder("example", new()
        {
            FolderId = "example-id",
            Permissions = new[]
            {
                new Aws.Quicksight.Inputs.FolderPermissionArgs
                {
                    Actions = new[]
                    {
                        "quicksight:CreateFolder",
                        "quicksight:DescribeFolder",
                        "quicksight:UpdateFolder",
                        "quicksight:DeleteFolder",
                        "quicksight:CreateFolderMembership",
                        "quicksight:DeleteFolderMembership",
                        "quicksight:DescribeFolderPermissions",
                        "quicksight:UpdateFolderPermissions",
                    },
                    Principal = aws_quicksight_user.Example.Arn,
                },
            },
        });
    
    });
    
    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.NewFolder(ctx, "example", &quicksight.FolderArgs{
    			FolderId: pulumi.String("example-id"),
    			Permissions: quicksight.FolderPermissionArray{
    				&quicksight.FolderPermissionArgs{
    					Actions: pulumi.StringArray{
    						pulumi.String("quicksight:CreateFolder"),
    						pulumi.String("quicksight:DescribeFolder"),
    						pulumi.String("quicksight:UpdateFolder"),
    						pulumi.String("quicksight:DeleteFolder"),
    						pulumi.String("quicksight:CreateFolderMembership"),
    						pulumi.String("quicksight:DeleteFolderMembership"),
    						pulumi.String("quicksight:DescribeFolderPermissions"),
    						pulumi.String("quicksight:UpdateFolderPermissions"),
    					},
    					Principal: pulumi.Any(aws_quicksight_user.Example.Arn),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.quicksight.Folder;
    import com.pulumi.aws.quicksight.FolderArgs;
    import com.pulumi.aws.quicksight.inputs.FolderPermissionArgs;
    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 Folder("example", FolderArgs.builder()        
                .folderId("example-id")
                .permissions(FolderPermissionArgs.builder()
                    .actions(                
                        "quicksight:CreateFolder",
                        "quicksight:DescribeFolder",
                        "quicksight:UpdateFolder",
                        "quicksight:DeleteFolder",
                        "quicksight:CreateFolderMembership",
                        "quicksight:DeleteFolderMembership",
                        "quicksight:DescribeFolderPermissions",
                        "quicksight:UpdateFolderPermissions")
                    .principal(aws_quicksight_user.example().arn())
                    .build())
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.quicksight.Folder("example",
        folder_id="example-id",
        permissions=[aws.quicksight.FolderPermissionArgs(
            actions=[
                "quicksight:CreateFolder",
                "quicksight:DescribeFolder",
                "quicksight:UpdateFolder",
                "quicksight:DeleteFolder",
                "quicksight:CreateFolderMembership",
                "quicksight:DeleteFolderMembership",
                "quicksight:DescribeFolderPermissions",
                "quicksight:UpdateFolderPermissions",
            ],
            principal=aws_quicksight_user["example"]["arn"],
        )])
    
    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.quicksight.Folder("example", {
        folderId: "example-id",
        permissions: [{
            actions: [
                "quicksight:CreateFolder",
                "quicksight:DescribeFolder",
                "quicksight:UpdateFolder",
                "quicksight:DeleteFolder",
                "quicksight:CreateFolderMembership",
                "quicksight:DeleteFolderMembership",
                "quicksight:DescribeFolderPermissions",
                "quicksight:UpdateFolderPermissions",
            ],
            principal: aws_quicksight_user.example.arn,
        }],
    });
    
    resources:
      example:
        type: aws:quicksight:Folder
        properties:
          folderId: example-id
          permissions:
            - actions:
                - quicksight:CreateFolder
                - quicksight:DescribeFolder
                - quicksight:UpdateFolder
                - quicksight:DeleteFolder
                - quicksight:CreateFolderMembership
                - quicksight:DeleteFolderMembership
                - quicksight:DescribeFolderPermissions
                - quicksight:UpdateFolderPermissions
              principal: ${aws_quicksight_user.example.arn}
    

    With Parent Folder

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var parent = new Aws.Quicksight.Folder("parent", new()
        {
            FolderId = "parent-id",
        });
    
        var example = new Aws.Quicksight.Folder("example", new()
        {
            FolderId = "example-id",
            ParentFolderArn = parent.Arn,
        });
    
    });
    
    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 {
    		parent, err := quicksight.NewFolder(ctx, "parent", &quicksight.FolderArgs{
    			FolderId: pulumi.String("parent-id"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = quicksight.NewFolder(ctx, "example", &quicksight.FolderArgs{
    			FolderId:        pulumi.String("example-id"),
    			ParentFolderArn: parent.Arn,
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.quicksight.Folder;
    import com.pulumi.aws.quicksight.FolderArgs;
    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 parent = new Folder("parent", FolderArgs.builder()        
                .folderId("parent-id")
                .build());
    
            var example = new Folder("example", FolderArgs.builder()        
                .folderId("example-id")
                .parentFolderArn(parent.arn())
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_aws as aws
    
    parent = aws.quicksight.Folder("parent", folder_id="parent-id")
    example = aws.quicksight.Folder("example",
        folder_id="example-id",
        parent_folder_arn=parent.arn)
    
    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const parent = new aws.quicksight.Folder("parent", {folderId: "parent-id"});
    const example = new aws.quicksight.Folder("example", {
        folderId: "example-id",
        parentFolderArn: parent.arn,
    });
    
    resources:
      parent:
        type: aws:quicksight:Folder
        properties:
          folderId: parent-id
      example:
        type: aws:quicksight:Folder
        properties:
          folderId: example-id
          parentFolderArn: ${parent.arn}
    

    Create Folder Resource

    new Folder(name: string, args: FolderArgs, opts?: CustomResourceOptions);
    @overload
    def Folder(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               aws_account_id: Optional[str] = None,
               folder_id: Optional[str] = None,
               folder_type: Optional[str] = None,
               name: Optional[str] = None,
               parent_folder_arn: Optional[str] = None,
               permissions: Optional[Sequence[FolderPermissionArgs]] = None,
               tags: Optional[Mapping[str, str]] = None)
    @overload
    def Folder(resource_name: str,
               args: FolderArgs,
               opts: Optional[ResourceOptions] = None)
    func NewFolder(ctx *Context, name string, args FolderArgs, opts ...ResourceOption) (*Folder, error)
    public Folder(string name, FolderArgs args, CustomResourceOptions? opts = null)
    public Folder(String name, FolderArgs args)
    public Folder(String name, FolderArgs args, CustomResourceOptions options)
    
    type: aws:quicksight:Folder
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args FolderArgs
    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 FolderArgs
    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 FolderArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FolderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FolderArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Folder 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 Folder resource accepts the following input properties:

    FolderId string

    Identifier for the folder.

    AwsAccountId string

    AWS account ID.

    FolderType string

    The type of folder. By default, it is SHARED. Valid values are: SHARED.

    Name string

    Display name for the folder.

    The following arguments are optional:

    ParentFolderArn string

    The Amazon Resource Name (ARN) for the parent folder. If not set, creates a root-level folder.

    Permissions List<Pulumi.Aws.Quicksight.Inputs.FolderPermission>

    A set of resource permissions on the folder. Maximum of 64 items. See permissions.

    Tags Dictionary<string, string>

    Key-value map 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.

    FolderId string

    Identifier for the folder.

    AwsAccountId string

    AWS account ID.

    FolderType string

    The type of folder. By default, it is SHARED. Valid values are: SHARED.

    Name string

    Display name for the folder.

    The following arguments are optional:

    ParentFolderArn string

    The Amazon Resource Name (ARN) for the parent folder. If not set, creates a root-level folder.

    Permissions []FolderPermissionArgs

    A set of resource permissions on the folder. Maximum of 64 items. See permissions.

    Tags map[string]string

    Key-value map 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.

    folderId String

    Identifier for the folder.

    awsAccountId String

    AWS account ID.

    folderType String

    The type of folder. By default, it is SHARED. Valid values are: SHARED.

    name String

    Display name for the folder.

    The following arguments are optional:

    parentFolderArn String

    The Amazon Resource Name (ARN) for the parent folder. If not set, creates a root-level folder.

    permissions List<FolderPermission>

    A set of resource permissions on the folder. Maximum of 64 items. See permissions.

    tags Map<String,String>

    Key-value map 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.

    folderId string

    Identifier for the folder.

    awsAccountId string

    AWS account ID.

    folderType string

    The type of folder. By default, it is SHARED. Valid values are: SHARED.

    name string

    Display name for the folder.

    The following arguments are optional:

    parentFolderArn string

    The Amazon Resource Name (ARN) for the parent folder. If not set, creates a root-level folder.

    permissions FolderPermission[]

    A set of resource permissions on the folder. Maximum of 64 items. See permissions.

    tags {[key: string]: string}

    Key-value map 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.

    folder_id str

    Identifier for the folder.

    aws_account_id str

    AWS account ID.

    folder_type str

    The type of folder. By default, it is SHARED. Valid values are: SHARED.

    name str

    Display name for the folder.

    The following arguments are optional:

    parent_folder_arn str

    The Amazon Resource Name (ARN) for the parent folder. If not set, creates a root-level folder.

    permissions Sequence[FolderPermissionArgs]

    A set of resource permissions on the folder. Maximum of 64 items. See permissions.

    tags Mapping[str, str]

    Key-value map 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.

    folderId String

    Identifier for the folder.

    awsAccountId String

    AWS account ID.

    folderType String

    The type of folder. By default, it is SHARED. Valid values are: SHARED.

    name String

    Display name for the folder.

    The following arguments are optional:

    parentFolderArn String

    The Amazon Resource Name (ARN) for the parent folder. If not set, creates a root-level folder.

    permissions List<Property Map>

    A set of resource permissions on the folder. Maximum of 64 items. See permissions.

    tags Map<String>

    Key-value map 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 Folder resource produces the following output properties:

    Arn string

    ARN of the folder.

    CreatedTime string

    The time that the folder was created.

    FolderPaths List<string>

    An array of ancestor ARN strings for the folder. Empty for root-level folders.

    Id string

    The provider-assigned unique ID for this managed resource.

    LastUpdatedTime string

    The time that the folder was last updated.

    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

    ARN of the folder.

    CreatedTime string

    The time that the folder was created.

    FolderPaths []string

    An array of ancestor ARN strings for the folder. Empty for root-level folders.

    Id string

    The provider-assigned unique ID for this managed resource.

    LastUpdatedTime string

    The time that the folder was last updated.

    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

    ARN of the folder.

    createdTime String

    The time that the folder was created.

    folderPaths List<String>

    An array of ancestor ARN strings for the folder. Empty for root-level folders.

    id String

    The provider-assigned unique ID for this managed resource.

    lastUpdatedTime String

    The time that the folder was last updated.

    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

    ARN of the folder.

    createdTime string

    The time that the folder was created.

    folderPaths string[]

    An array of ancestor ARN strings for the folder. Empty for root-level folders.

    id string

    The provider-assigned unique ID for this managed resource.

    lastUpdatedTime string

    The time that the folder was last updated.

    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

    ARN of the folder.

    created_time str

    The time that the folder was created.

    folder_paths Sequence[str]

    An array of ancestor ARN strings for the folder. Empty for root-level folders.

    id str

    The provider-assigned unique ID for this managed resource.

    last_updated_time str

    The time that the folder was last updated.

    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

    ARN of the folder.

    createdTime String

    The time that the folder was created.

    folderPaths List<String>

    An array of ancestor ARN strings for the folder. Empty for root-level folders.

    id String

    The provider-assigned unique ID for this managed resource.

    lastUpdatedTime String

    The time that the folder was last updated.

    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 Folder Resource

    Get an existing Folder 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?: FolderState, opts?: CustomResourceOptions): Folder
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            arn: Optional[str] = None,
            aws_account_id: Optional[str] = None,
            created_time: Optional[str] = None,
            folder_id: Optional[str] = None,
            folder_paths: Optional[Sequence[str]] = None,
            folder_type: Optional[str] = None,
            last_updated_time: Optional[str] = None,
            name: Optional[str] = None,
            parent_folder_arn: Optional[str] = None,
            permissions: Optional[Sequence[FolderPermissionArgs]] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None) -> Folder
    func GetFolder(ctx *Context, name string, id IDInput, state *FolderState, opts ...ResourceOption) (*Folder, error)
    public static Folder Get(string name, Input<string> id, FolderState? state, CustomResourceOptions? opts = null)
    public static Folder get(String name, Output<String> id, FolderState 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

    ARN of the folder.

    AwsAccountId string

    AWS account ID.

    CreatedTime string

    The time that the folder was created.

    FolderId string

    Identifier for the folder.

    FolderPaths List<string>

    An array of ancestor ARN strings for the folder. Empty for root-level folders.

    FolderType string

    The type of folder. By default, it is SHARED. Valid values are: SHARED.

    LastUpdatedTime string

    The time that the folder was last updated.

    Name string

    Display name for the folder.

    The following arguments are optional:

    ParentFolderArn string

    The Amazon Resource Name (ARN) for the parent folder. If not set, creates a root-level folder.

    Permissions List<Pulumi.Aws.Quicksight.Inputs.FolderPermission>

    A set of resource permissions on the folder. Maximum of 64 items. See permissions.

    Tags Dictionary<string, string>

    Key-value map 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

    ARN of the folder.

    AwsAccountId string

    AWS account ID.

    CreatedTime string

    The time that the folder was created.

    FolderId string

    Identifier for the folder.

    FolderPaths []string

    An array of ancestor ARN strings for the folder. Empty for root-level folders.

    FolderType string

    The type of folder. By default, it is SHARED. Valid values are: SHARED.

    LastUpdatedTime string

    The time that the folder was last updated.

    Name string

    Display name for the folder.

    The following arguments are optional:

    ParentFolderArn string

    The Amazon Resource Name (ARN) for the parent folder. If not set, creates a root-level folder.

    Permissions []FolderPermissionArgs

    A set of resource permissions on the folder. Maximum of 64 items. See permissions.

    Tags map[string]string

    Key-value map 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

    ARN of the folder.

    awsAccountId String

    AWS account ID.

    createdTime String

    The time that the folder was created.

    folderId String

    Identifier for the folder.

    folderPaths List<String>

    An array of ancestor ARN strings for the folder. Empty for root-level folders.

    folderType String

    The type of folder. By default, it is SHARED. Valid values are: SHARED.

    lastUpdatedTime String

    The time that the folder was last updated.

    name String

    Display name for the folder.

    The following arguments are optional:

    parentFolderArn String

    The Amazon Resource Name (ARN) for the parent folder. If not set, creates a root-level folder.

    permissions List<FolderPermission>

    A set of resource permissions on the folder. Maximum of 64 items. See permissions.

    tags Map<String,String>

    Key-value map 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

    ARN of the folder.

    awsAccountId string

    AWS account ID.

    createdTime string

    The time that the folder was created.

    folderId string

    Identifier for the folder.

    folderPaths string[]

    An array of ancestor ARN strings for the folder. Empty for root-level folders.

    folderType string

    The type of folder. By default, it is SHARED. Valid values are: SHARED.

    lastUpdatedTime string

    The time that the folder was last updated.

    name string

    Display name for the folder.

    The following arguments are optional:

    parentFolderArn string

    The Amazon Resource Name (ARN) for the parent folder. If not set, creates a root-level folder.

    permissions FolderPermission[]

    A set of resource permissions on the folder. Maximum of 64 items. See permissions.

    tags {[key: string]: string}

    Key-value map 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

    ARN of the folder.

    aws_account_id str

    AWS account ID.

    created_time str

    The time that the folder was created.

    folder_id str

    Identifier for the folder.

    folder_paths Sequence[str]

    An array of ancestor ARN strings for the folder. Empty for root-level folders.

    folder_type str

    The type of folder. By default, it is SHARED. Valid values are: SHARED.

    last_updated_time str

    The time that the folder was last updated.

    name str

    Display name for the folder.

    The following arguments are optional:

    parent_folder_arn str

    The Amazon Resource Name (ARN) for the parent folder. If not set, creates a root-level folder.

    permissions Sequence[FolderPermissionArgs]

    A set of resource permissions on the folder. Maximum of 64 items. See permissions.

    tags Mapping[str, str]

    Key-value map 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

    ARN of the folder.

    awsAccountId String

    AWS account ID.

    createdTime String

    The time that the folder was created.

    folderId String

    Identifier for the folder.

    folderPaths List<String>

    An array of ancestor ARN strings for the folder. Empty for root-level folders.

    folderType String

    The type of folder. By default, it is SHARED. Valid values are: SHARED.

    lastUpdatedTime String

    The time that the folder was last updated.

    name String

    Display name for the folder.

    The following arguments are optional:

    parentFolderArn String

    The Amazon Resource Name (ARN) for the parent folder. If not set, creates a root-level folder.

    permissions List<Property Map>

    A set of resource permissions on the folder. Maximum of 64 items. See permissions.

    tags Map<String>

    Key-value map 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

    FolderPermission, FolderPermissionArgs

    Actions List<string>

    List of IAM actions to grant or revoke permissions on.

    Principal string

    ARN of the principal. See the ResourcePermission documentation for the applicable ARN values.

    Actions []string

    List of IAM actions to grant or revoke permissions on.

    Principal string

    ARN of the principal. See the ResourcePermission documentation for the applicable ARN values.

    actions List<String>

    List of IAM actions to grant or revoke permissions on.

    principal String

    ARN of the principal. See the ResourcePermission documentation for the applicable ARN values.

    actions string[]

    List of IAM actions to grant or revoke permissions on.

    principal string

    ARN of the principal. See the ResourcePermission documentation for the applicable ARN values.

    actions Sequence[str]

    List of IAM actions to grant or revoke permissions on.

    principal str

    ARN of the principal. See the ResourcePermission documentation for the applicable ARN values.

    actions List<String>

    List of IAM actions to grant or revoke permissions on.

    principal String

    ARN of the principal. See the ResourcePermission documentation for the applicable ARN values.

    Import

    Using pulumi import, import a QuickSight folder using the AWS account ID and folder ID name separated by a comma (,). For example:

     $ pulumi import aws:quicksight/folder:Folder example 123456789012,example-id
    

    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.3.0 published on Thursday, Sep 28, 2023 by Pulumi