Skip to content
v2.274.0

CfnFolderProps Struct ​

Properties for defining a CfnFolder.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_quicksight as quicksight } from 'aws-cdk-lib';
const cfnFolderProps: quicksight.CfnFolderProps = {
  awsAccountId: 'awsAccountId',
  folderId: 'folderId',
  folderType: 'folderType',
  name: 'name',
  parentFolderArn: 'parentFolderArn',
  permissions: [{
    actions: ['actions'],
    principal: 'principal',
  }],
  sharingModel: 'sharingModel',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties ​

awsAccountIdoptionalstringaws_account_idoptionalstrawsAccountIdoptionalStringAwsAccountIdoptionalstringAwsAccountIdoptional*string#
The ID for the AWS account where you want to create the folder.
folderIdoptionalstringfolder_idoptionalstrfolderIdoptionalStringFolderIdoptionalstringFolderIdoptional*string#
The ID of the folder.
folderTypeoptionalstringfolder_typeoptionalstrfolderTypeoptionalStringFolderTypeoptionalstringFolderTypeoptional*string#
The type of folder it is.
nameoptionalstringnameoptionalstrnameoptionalStringNameoptionalstringNameoptional*string#
A display name for the folder.
parentFolderArnoptionalstringparent_folder_arnoptionalstrparentFolderArnoptionalStringParentFolderArnoptionalstringParentFolderArnoptional*string#
The Amazon Resource Name (ARN) for the folder.
permissionsoptionalIResolvable | IResolvable | CfnFolder.ResourcePermissionProperty[]permissionsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ResourcePermissionProperty]]]permissionsoptionalIResolvablePermissionsoptionalIResolvablePermissionsoptionalinterface{}#
A structure that describes the principals and the resource-level permissions of a folder.

To specify no permissions, omit Permissions .

sharingModeloptionalstringsharing_modeloptionalstrsharingModeloptionalStringSharingModeloptionalstringSharingModeloptional*string#
The sharing scope of the folder.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
A list of tags for the folders that you want to apply overrides to.