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

aws.quicksight.Folder

Explore with Pulumi AI

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

    Resource for managing a QuickSight Folder.

    Example Usage

    Basic Usage

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

const example = new aws.quicksight.Folder("example", {
    folderId: "example-id",
    name: "example-name",
});

    import pulumi
import pulumi_aws as aws

example = aws.quicksight.Folder("example",
    folder_id="example-id",
    name="example-name")

    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"),
			Name:     pulumi.String("example-name"),
		})
		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.Folder("example", new()
    {
        FolderId = "example-id",
        Name = "example-name",
    });

});

    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")
            .name("example-name")
            .build());

    }
}

    resources:
  example:
    type: aws:quicksight:Folder
    properties:
      folderId: example-id
      name: example-name

    With Permissions

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

const example = new aws.quicksight.Folder("example", {
    folderId: "example-id",
    name: "example-name",
    permissions: [{
        actions: [
            "quicksight:CreateFolder",
            "quicksight:DescribeFolder",
            "quicksight:UpdateFolder",
            "quicksight:DeleteFolder",
            "quicksight:CreateFolderMembership",
            "quicksight:DeleteFolderMembership",
            "quicksight:DescribeFolderPermissions",
            "quicksight:UpdateFolderPermissions",
        ],
        principal: exampleAwsQuicksightUser.arn,
    }],
});

    import pulumi
import pulumi_aws as aws

example = aws.quicksight.Folder("example",
    folder_id="example-id",
    name="example-name",
    permissions=[{
        "actions": [
            "quicksight:CreateFolder",
            "quicksight:DescribeFolder",
            "quicksight:UpdateFolder",
            "quicksight:DeleteFolder",
            "quicksight:CreateFolderMembership",
            "quicksight:DeleteFolderMembership",
            "quicksight:DescribeFolderPermissions",
            "quicksight:UpdateFolderPermissions",
        ],
        "principal": example_aws_quicksight_user["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"),
			Name:     pulumi.String("example-name"),
			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(exampleAwsQuicksightUser.Arn),
				},
			},
		})
		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.Folder("example", new()
    {
        FolderId = "example-id",
        Name = "example-name",
        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 = exampleAwsQuicksightUser.Arn,
            },
        },
    });

});

    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")
            .name("example-name")
            .permissions(FolderPermissionArgs.builder()
                .actions(                
                    "quicksight:CreateFolder",
                    "quicksight:DescribeFolder",
                    "quicksight:UpdateFolder",
                    "quicksight:DeleteFolder",
                    "quicksight:CreateFolderMembership",
                    "quicksight:DeleteFolderMembership",
                    "quicksight:DescribeFolderPermissions",
                    "quicksight:UpdateFolderPermissions")
                .principal(exampleAwsQuicksightUser.arn())
                .build())
            .build());

    }
}

    resources:
  example:
    type: aws:quicksight:Folder
    properties:
      folderId: example-id
      name: example-name
      permissions:
        - actions:
            - quicksight:CreateFolder
            - quicksight:DescribeFolder
            - quicksight:UpdateFolder
            - quicksight:DeleteFolder
            - quicksight:CreateFolderMembership
            - quicksight:DeleteFolderMembership
            - quicksight:DescribeFolderPermissions
            - quicksight:UpdateFolderPermissions
          principal: ${exampleAwsQuicksightUser.arn}

    With Parent Folder

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

const parent = new aws.quicksight.Folder("parent", {
    folderId: "parent-id",
    name: "parent-name",
});
const example = new aws.quicksight.Folder("example", {
    folderId: "example-id",
    name: "example-name",
    parentFolderArn: parent.arn,
});

    import pulumi
import pulumi_aws as aws

parent = aws.quicksight.Folder("parent",
    folder_id="parent-id",
    name="parent-name")
example = aws.quicksight.Folder("example",
    folder_id="example-id",
    name="example-name",
    parent_folder_arn=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"),
			Name:     pulumi.String("parent-name"),
		})
		if err != nil {
			return err
		}
		_, err = quicksight.NewFolder(ctx, "example", &quicksight.FolderArgs{
			FolderId:        pulumi.String("example-id"),
			Name:            pulumi.String("example-name"),
			ParentFolderArn: parent.Arn,
		})
		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 parent = new Aws.Quicksight.Folder("parent", new()
    {
        FolderId = "parent-id",
        Name = "parent-name",
    });

    var example = new Aws.Quicksight.Folder("example", new()
    {
        FolderId = "example-id",
        Name = "example-name",
        ParentFolderArn = parent.Arn,
    });

});

    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")
            .name("parent-name")
            .build());

        var example = new Folder("example", FolderArgs.builder()
            .folderId("example-id")
            .name("example-name")
            .parentFolderArn(parent.arn())
            .build());

    }
}

    resources:
  parent:
    type: aws:quicksight:Folder
    properties:
      folderId: parent-id
      name: parent-name
  example:
    type: aws:quicksight:Folder
    properties:
      folderId: example-id
      name: example-name
      parentFolderArn: ${parent.arn}

    Create Folder Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Folder(name: string, args: FolderArgs, opts?: CustomResourceOptions);
    @overload
def Folder(resource_name: str,
           args: FolderArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def Folder(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           folder_id: Optional[str] = None,
           aws_account_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)
    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.

    Parameters

    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.

    Constructor example

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

    var folderResource = new Aws.Quicksight.Folder("folderResource", new()
{
    FolderId = "string",
    AwsAccountId = "string",
    FolderType = "string",
    Name = "string",
    ParentFolderArn = "string",
    Permissions = new[]
    {
        new Aws.Quicksight.Inputs.FolderPermissionArgs
        {
            Actions = new[]
            {
                "string",
            },
            Principal = "string",
        },
    },
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := quicksight.NewFolder(ctx, "folderResource", &quicksight.FolderArgs{
	FolderId:        pulumi.String("string"),
	AwsAccountId:    pulumi.String("string"),
	FolderType:      pulumi.String("string"),
	Name:            pulumi.String("string"),
	ParentFolderArn: pulumi.String("string"),
	Permissions: quicksight.FolderPermissionArray{
		&quicksight.FolderPermissionArgs{
			Actions: pulumi.StringArray{
				pulumi.String("string"),
			},
			Principal: pulumi.String("string"),
		},
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var folderResource = new Folder("folderResource", FolderArgs.builder()
    .folderId("string")
    .awsAccountId("string")
    .folderType("string")
    .name("string")
    .parentFolderArn("string")
    .permissions(FolderPermissionArgs.builder()
        .actions("string")
        .principal("string")
        .build())
    .tags(Map.of("string", "string"))
    .build());

    folder_resource = aws.quicksight.Folder("folderResource",
    folder_id="string",
    aws_account_id="string",
    folder_type="string",
    name="string",
    parent_folder_arn="string",
    permissions=[{
        "actions": ["string"],
        "principal": "string",
    }],
    tags={
        "string": "string",
    })

    const folderResource = new aws.quicksight.Folder("folderResource", {
    folderId: "string",
    awsAccountId: "string",
    folderType: "string",
    name: "string",
    parentFolderArn: "string",
    permissions: [{
        actions: ["string"],
        principal: "string",
    }],
    tags: {
        string: "string",
    },
});

    type: aws:quicksight:Folder
properties:
    awsAccountId: string
    folderId: string
    folderType: string
    name: string
    parentFolderArn: string
    permissions:
        - actions:
            - string
          principal: string
    tags:
        string: string

    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

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

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

    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