Folder class
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")
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 main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/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
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_quicksight_folder" "example" {
folder_id = "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.ArrayList;
import java.util.Arrays;
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", {
permissions: [{
actions: [
"quicksight:CreateFolder",
"quicksight:DescribeFolder",
"quicksight:UpdateFolder",
"quicksight:DeleteFolder",
"quicksight:CreateFolderMembership",
"quicksight:DeleteFolderMembership",
"quicksight:DescribeFolderPermissions",
"quicksight:UpdateFolderPermissions",
],
principal: exampleAwsQuicksightUser.arn,
}],
folderId: "example-id",
name: "example-name",
});
import pulumi
import pulumi_aws as aws
example = aws.quicksight.Folder("example",
permissions=[{
"actions": [
"quicksight:CreateFolder",
"quicksight:DescribeFolder",
"quicksight:UpdateFolder",
"quicksight:DeleteFolder",
"quicksight:CreateFolderMembership",
"quicksight:DeleteFolderMembership",
"quicksight:DescribeFolderPermissions",
"quicksight:UpdateFolderPermissions",
],
"principal": example_aws_quicksight_user["arn"],
}],
folder_id="example-id",
name="example-name")
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()
{
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,
},
},
FolderId = "example-id",
Name = "example-name",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/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{
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),
},
},
FolderId: pulumi.String("example-id"),
Name: pulumi.String("example-name"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_quicksight_folder" "example" {
permissions {
actions = ["quicksight:CreateFolder", "quicksight:DescribeFolder", "quicksight:UpdateFolder", "quicksight:DeleteFolder", "quicksight:CreateFolderMembership", "quicksight:DeleteFolderMembership", "quicksight:DescribeFolderPermissions", "quicksight:UpdateFolderPermissions"]
principal = exampleAwsQuicksightUser.arn
}
folder_id = "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 com.pulumi.aws.quicksight.inputs.FolderPermissionArgs;
import java.util.ArrayList;
import java.util.Arrays;
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()
.permissions(FolderPermissionArgs.builder()
.actions(
"quicksight:CreateFolder",
"quicksight:DescribeFolder",
"quicksight:UpdateFolder",
"quicksight:DeleteFolder",
"quicksight:CreateFolderMembership",
"quicksight:DeleteFolderMembership",
"quicksight:DescribeFolderPermissions",
"quicksight:UpdateFolderPermissions")
.principal(exampleAwsQuicksightUser.arn())
.build())
.folderId("example-id")
.name("example-name")
.build());
}
}
resources:
example:
type: aws:quicksight:Folder
properties:
permissions:
- actions:
- quicksight:CreateFolder
- quicksight:DescribeFolder
- quicksight:UpdateFolder
- quicksight:DeleteFolder
- quicksight:CreateFolderMembership
- quicksight:DeleteFolderMembership
- quicksight:DescribeFolderPermissions
- quicksight:UpdateFolderPermissions
principal: ${exampleAwsQuicksightUser.arn}
folderId: example-id
name: example-name
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)
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 main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/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
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_quicksight_folder" "parent" {
folder_id = "parent-id"
name = "parent-name"
}
resource "aws_quicksight_folder" "example" {
folder_id = "example-id"
name = "example-name"
parent_folder_arn = aws_quicksight_folder.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.ArrayList;
import java.util.Arrays;
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}
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
Constructors
- Folder(String name, {FolderArgs? args, CustomResourceOptions? options})
-
Creates a new Folder.
nameThe Pulumi resource name.argsArguments used to configure this Folder. The set of arguments for Folder.optionsResource options controlling this resource's behavior. - Folder.reference(String urn)
- Creates a typed reference to an existing Folder resource.
Properties
-
arn
↔ Output<
String> -
ARN of the folder.
latefinal
-
awsAccountId
↔ Output<
String> -
AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
createdTime
↔ Output<
String> -
The time that the folder was created.
latefinal
-
folderId
↔ Output<
String> -
Identifier for the folder.
latefinal
-
folderPaths
↔ Output<
List< String> > -
An array of ancestor ARN strings for the folder. Empty for root-level folders.
latefinal
-
folderType
↔ Output<
String?> -
The type of folder. By default, it is
SHARED. Valid values are:SHARED.latefinal - hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
lastUpdatedTime
↔ Output<
String> -
The time that the folder was last updated.
latefinal
-
name
↔ Output<
String> -
Display name for the folder.
latefinal
-
parentFolderArn
↔ Output<
String?> -
ARN for the parent folder. If not set, creates a root-level folder.
latefinal
-
permissions
↔ Output<
List< FolderPermission> ?> -
A set of resource permissions on the folder. Maximum of 64 items. See permissions.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
Key-value map of resource tags. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited