Package com.pulumi.aws.quicksight

Class Folder

  • public class Folder
extends com.pulumi.resources.CustomResource
    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.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());
 
     }
 }
    ### 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.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());
 
     }
 }
    ### 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.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());
 
     }
 }
    ## Import Using `pulumi import`, import a QuickSight folder using the AWS account ID and folder ID name separated by a comma (`,`). For example: ```sh $ pulumi import aws:quicksight/folder:Folder example 123456789012,example-id ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Constructor Summary

      Constructors 
      Constructor Description
      Folder​(java.lang.String name)  
      Folder​(java.lang.String name, FolderArgs args)  
      Folder​(java.lang.String name, FolderArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.lang.String> awsAccountId()  
      com.pulumi.core.Output<java.lang.String> createdTime()  
      com.pulumi.core.Output<java.lang.String> folderId()  
      com.pulumi.core.Output<java.util.List<java.lang.String>> folderPaths()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> folderType()  
      static Folder get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, FolderState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> lastUpdatedTime()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> parentFolderArn()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<FolderPermission>>> permissions()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • Folder

        public Folder​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • Folder

        public Folder​(java.lang.String name,
              FolderArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • Folder

        public Folder​(java.lang.String name,
              FolderArgs args,
              @Nullable
              com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN of the folder.

      • awsAccountId

        public com.pulumi.core.Output<java.lang.String> awsAccountId()
        Returns:
        AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider.

      • createdTime

        public com.pulumi.core.Output<java.lang.String> createdTime()
        Returns:
        Time that the folder was created.

      • folderId

        public com.pulumi.core.Output<java.lang.String> folderId()
        Returns:
        Identifier for the folder. The following arguments are optional:

      • folderPaths

        public com.pulumi.core.Output<java.util.List<java.lang.String>> folderPaths()
        Returns:
        Array of ancestor ARN strings for the folder. Empty for root-level folders.

      • folderType

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> folderType()
        Returns:
        Type of folder. By default, it is `SHARED`. Valid values are: `SHARED`.

      • lastUpdatedTime

        public com.pulumi.core.Output<java.lang.String> lastUpdatedTime()
        Returns:
        Time that the folder was last updated.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Display name for the folder.

      • parentFolderArn

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> parentFolderArn()
        Returns:
        ARN for the parent folder. If not set, creates a root-level folder.

      • permissions

        public com.pulumi.core.Output<java.util.Optional<java.util.List<FolderPermission>>> permissions()
        Returns:
        Set of resource permissions on the folder. Maximum of 64 items. See `permissions` Block.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • get

        public static Folder get​(java.lang.String name,
                         com.pulumi.core.Output<java.lang.String> id,
                         @Nullable
                         FolderState state,
                         @Nullable
                         com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.