pulumi-aws-kotlin/com.pulumi.aws.quicksight.kotlin/Folder

Folder

class Folder : KotlinCustomResource

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

Properties

arn

val arn: Output<String>

ARN of the folder.

awsAccountId

val awsAccountId: Output<String>

AWS account ID.

createdTime

val createdTime: Output<String>

The time that the folder was created.

folderId

val folderId: Output<String>

Identifier for the folder.

folderPaths

val folderPaths: Output<List<String>>

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

folderType

val folderType: Output<String>?

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

val id: Output<String>

lastUpdatedTime

val lastUpdatedTime: Output<String>

The time that the folder was last updated.

name

val name: Output<String>

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

parentFolderArn

val parentFolderArn: Output<String>?

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

permissions

val permissions: Output<List<FolderPermission>>?

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

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String