Package software.amazon.awscdk.services.quicksight

Class CfnFolder

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.quicksight.CfnFolder
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IFolderRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-12-01T16:02:27.116Z") @Stability(Stable) public class CfnFolder extends CfnResource implements IInspectable, IFolderRef, ITaggableV2
Creates an empty shared folder.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.quicksight.*;
 CfnFolder cfnFolder = CfnFolder.Builder.create(this, "MyCfnFolder")
         .awsAccountId("awsAccountId")
         .folderId("folderId")
         .folderType("folderType")
         .name("name")
         .parentFolderArn("parentFolderArn")
         .permissions(List.of(ResourcePermissionProperty.builder()
                 .actions(List.of("actions"))
                 .principal("principal")
                 .build()))
         .sharingModel("sharingModel")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnFolder

      protected CfnFolder(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnFolder

      protected CfnFolder(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnFolder

      @Stability(Stable) public CfnFolder(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnFolderProps props)
      Create a new AWS::QuickSight::Folder.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnFolder

      @Stability(Stable) public CfnFolder(@NotNull software.constructs.Construct scope, @NotNull String id)
      Create a new AWS::QuickSight::Folder.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.

  • Method Details

    • arnForFolder

      @Stability(Stable) @NotNull public static String arnForFolder(@NotNull IFolderRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnFolder

      @Stability(Stable) @NotNull public static Boolean isCfnFolder(@NotNull Object x)
      Checks whether the given object is a CfnFolder.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) for the folder.

    • getAttrCreatedTime

      @Stability(Stable) @NotNull public String getAttrCreatedTime()
      The time that the folder was created.

    • getAttrLastUpdatedTime

      @Stability(Stable) @NotNull public String getAttrLastUpdatedTime()
      The time that the folder was last updated.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getFolderRef

      @Stability(Stable) @NotNull public FolderReference getFolderRef()
      A reference to a Folder resource.
      Specified by:
      getFolderRef in interface IFolderRef

    • getAwsAccountId

      @Stability(Stable) @Nullable public String getAwsAccountId()
      The ID for the AWS account where you want to create the folder.

    • setAwsAccountId

      @Stability(Stable) public void setAwsAccountId(@Nullable String value)
      The ID for the AWS account where you want to create the folder.

    • getFolderId

      @Stability(Stable) @Nullable public String getFolderId()
      The ID of the folder.

    • setFolderId

      @Stability(Stable) public void setFolderId(@Nullable String value)
      The ID of the folder.

    • getFolderType

      @Stability(Stable) @Nullable public String getFolderType()
      The type of folder it is.

    • setFolderType

      @Stability(Stable) public void setFolderType(@Nullable String value)
      The type of folder it is.

    • getName

      @Stability(Stable) @Nullable public String getName()
      A display name for the folder.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      A display name for the folder.

    • getParentFolderArn

      @Stability(Stable) @Nullable public String getParentFolderArn()
      The Amazon Resource Name (ARN) for the folder.

    • setParentFolderArn

      @Stability(Stable) public void setParentFolderArn(@Nullable String value)
      The Amazon Resource Name (ARN) for the folder.

    • getPermissions

      @Stability(Stable) @Nullable public Object getPermissions()
      A structure that describes the principals and the resource-level permissions of a folder.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnFolder.ResourcePermissionProperty>

    • setPermissions

      @Stability(Stable) public void setPermissions(@Nullable IResolvable value)
      A structure that describes the principals and the resource-level permissions of a folder.

    • setPermissions

      @Stability(Stable) public void setPermissions(@Nullable List<Object> value)
      A structure that describes the principals and the resource-level permissions of a folder.

    • getSharingModel

      @Stability(Stable) @Nullable public String getSharingModel()
      The sharing scope of the folder.

    • setSharingModel

      @Stability(Stable) public void setSharingModel(@Nullable String value)
      The sharing scope of the folder.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      A list of tags for the folders that you want to apply overrides to.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      A list of tags for the folders that you want to apply overrides to.