com.pulumi.aws.quicksight.Folder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws Show documentation
Show all versions of aws Show documentation
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.aws.quicksight;
import com.pulumi.aws.Utilities;
import com.pulumi.aws.quicksight.FolderArgs;
import com.pulumi.aws.quicksight.inputs.FolderState;
import com.pulumi.aws.quicksight.outputs.FolderPermission;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Export;
import com.pulumi.core.annotations.ResourceType;
import com.pulumi.core.internal.Codegen;
import java.lang.String;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import javax.annotation.Nullable;
/**
* Resource for managing a QuickSight Folder.
*
* ## Example Usage
*
* ### Basic Usage
*
* <!--Start PulumiCodeChooser -->
*
* {@code
* 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());
*
* }
* }
* }
*
* <!--End PulumiCodeChooser -->
*
* ### With Permissions
*
* <!--Start PulumiCodeChooser -->
*
* {@code
* 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());
*
* }
* }
* }
*
* <!--End PulumiCodeChooser -->
*
* ### With Parent Folder
*
* <!--Start PulumiCodeChooser -->
*
* {@code
* 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());
*
* }
* }
* }
*
* <!--End PulumiCodeChooser -->
*
* ## 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
* ```
*
*/
@ResourceType(type="aws:quicksight/folder:Folder")
public class Folder extends com.pulumi.resources.CustomResource {
/**
* ARN of the folder.
*
*/
@Export(name="arn", refs={String.class}, tree="[0]")
private Output arn;
/**
* @return ARN of the folder.
*
*/
public Output arn() {
return this.arn;
}
/**
* AWS account ID.
*
*/
@Export(name="awsAccountId", refs={String.class}, tree="[0]")
private Output awsAccountId;
/**
* @return AWS account ID.
*
*/
public Output awsAccountId() {
return this.awsAccountId;
}
/**
* The time that the folder was created.
*
*/
@Export(name="createdTime", refs={String.class}, tree="[0]")
private Output createdTime;
/**
* @return The time that the folder was created.
*
*/
public Output createdTime() {
return this.createdTime;
}
/**
* Identifier for the folder.
*
*/
@Export(name="folderId", refs={String.class}, tree="[0]")
private Output folderId;
/**
* @return Identifier for the folder.
*
*/
public Output folderId() {
return this.folderId;
}
/**
* An array of ancestor ARN strings for the folder. Empty for root-level folders.
*
*/
@Export(name="folderPaths", refs={List.class,String.class}, tree="[0,1]")
private Output> folderPaths;
/**
* @return An array of ancestor ARN strings for the folder. Empty for root-level folders.
*
*/
public Output> folderPaths() {
return this.folderPaths;
}
/**
* The type of folder. By default, it is `SHARED`. Valid values are: `SHARED`.
*
*/
@Export(name="folderType", refs={String.class}, tree="[0]")
private Output folderType;
/**
* @return The type of folder. By default, it is `SHARED`. Valid values are: `SHARED`.
*
*/
public Output> folderType() {
return Codegen.optional(this.folderType);
}
/**
* The time that the folder was last updated.
*
*/
@Export(name="lastUpdatedTime", refs={String.class}, tree="[0]")
private Output lastUpdatedTime;
/**
* @return The time that the folder was last updated.
*
*/
public Output lastUpdatedTime() {
return this.lastUpdatedTime;
}
/**
* Display name for the folder.
*
* The following arguments are optional:
*
*/
@Export(name="name", refs={String.class}, tree="[0]")
private Output name;
/**
* @return Display name for the folder.
*
* The following arguments are optional:
*
*/
public Output name() {
return this.name;
}
/**
* The Amazon Resource Name (ARN) for the parent folder. If not set, creates a root-level folder.
*
*/
@Export(name="parentFolderArn", refs={String.class}, tree="[0]")
private Output parentFolderArn;
/**
* @return The Amazon Resource Name (ARN) for the parent folder. If not set, creates a root-level folder.
*
*/
public Output> parentFolderArn() {
return Codegen.optional(this.parentFolderArn);
}
/**
* A set of resource permissions on the folder. Maximum of 64 items. See permissions.
*
*/
@Export(name="permissions", refs={List.class,FolderPermission.class}, tree="[0,1]")
private Output> permissions;
/**
* @return A set of resource permissions on the folder. Maximum of 64 items. See permissions.
*
*/
public Output>> permissions() {
return Codegen.optional(this.permissions);
}
/**
* 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.
*
*/
@Export(name="tags", refs={Map.class,String.class}, tree="[0,1,1]")
private Output> tags;
/**
* @return 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.
*
*/
public Output>> tags() {
return Codegen.optional(this.tags);
}
/**
* A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.
*
* @deprecated
* Please use `tags` instead.
*
*/
@Deprecated /* Please use `tags` instead. */
@Export(name="tagsAll", refs={Map.class,String.class}, tree="[0,1,1]")
private Output> tagsAll;
/**
* @return A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.
*
*/
public Output> tagsAll() {
return this.tagsAll;
}
/**
*
* @param name The _unique_ name of the resulting resource.
*/
public Folder(java.lang.String name) {
this(name, FolderArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public Folder(java.lang.String name, FolderArgs args) {
this(name, args, null);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
* @param options A bag of options that control this resource's behavior.
*/
public Folder(java.lang.String name, FolderArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("aws:quicksight/folder:Folder", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
}
private Folder(java.lang.String name, Output id, @Nullable FolderState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("aws:quicksight/folder:Folder", name, state, makeResourceOptions(options, id), false);
}
private static FolderArgs makeArgs(FolderArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
if (options != null && options.getUrn().isPresent()) {
return null;
}
return args == null ? FolderArgs.Empty : args;
}
private static com.pulumi.resources.CustomResourceOptions makeResourceOptions(@Nullable com.pulumi.resources.CustomResourceOptions options, @Nullable Output id) {
var defaultOptions = com.pulumi.resources.CustomResourceOptions.builder()
.version(Utilities.getVersion())
.build();
return com.pulumi.resources.CustomResourceOptions.merge(defaultOptions, options, id);
}
/**
* Get an existing Host resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state
* @param options Optional settings to control the behavior of the CustomResource.
*/
public static Folder get(java.lang.String name, Output id, @Nullable FolderState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new Folder(name, id, state, options);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy