FolderArgs

data class FolderArgs(val awsAccountId: Output<String>? = null, val folderId: Output<String>? = null, val folderType: Output<String>? = null, val name: Output<String>? = null, val parentFolderArn: Output<String>? = null, val permissions: Output<List<FolderPermissionArgs>>? = null, val tags: Output<Map<String, String>>? = null) : ConvertibleToJava<FolderArgs>

Resource for managing a QuickSight Folder.

Example Usage

Basic Usage

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());
}
}

With Permissions

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());
}
}

With Parent Folder

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

A QuickSight folder can be imported using the AWS account ID and folder ID name separated by a comma (,) e.g.,

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

Constructors

Link copied to clipboard
constructor(awsAccountId: Output<String>? = null, folderId: Output<String>? = null, folderType: Output<String>? = null, name: Output<String>? = null, parentFolderArn: Output<String>? = null, permissions: Output<List<FolderPermissionArgs>>? = null, tags: Output<Map<String, String>>? = null)

Properties

Link copied to clipboard
val awsAccountId: Output<String>? = null

AWS account ID.

Link copied to clipboard
val folderId: Output<String>? = null

Identifier for the folder.

Link copied to clipboard
val folderType: Output<String>? = null

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

Link copied to clipboard
val name: Output<String>? = null

Display name for the folder. The following arguments are optional:

Link copied to clipboard
val parentFolderArn: Output<String>? = null

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

Link copied to clipboard
val permissions: Output<List<FolderPermissionArgs>>? = null

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

Link copied to clipboard
val tags: Output<Map<String, String>>? = null

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.

Functions

Link copied to clipboard
open override fun toJava(): FolderArgs