Creates an empty shared folder.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{
"Type" : "AWS::QuickSight::Folder",
"Properties" : {
"AwsAccountId" : String,
"FolderId" : String,
"FolderType" : String,
"Name" : String,
"ParentFolderArn" : String,
"Permissions" : [ ResourcePermission, ... ],
"SharingModel" : String,
"Tags" : [ Tag, ... ]
}
}
YAML
Type: AWS::QuickSight::Folder
Properties:
AwsAccountId: String
FolderId: String
FolderType: String
Name: String
ParentFolderArn: String
Permissions:
- ResourcePermission
SharingModel: String
Tags:
- Tag
Properties
AwsAccountId-
The ID for the AWS account where you want to create the folder.
Required: No
Type: String
Pattern:
^[0-9]{12}$Minimum:
12Maximum:
12Update requires: Replacement
FolderId-
The ID of the folder.
Required: No
Type: String
Pattern:
^[\w\-]+$Minimum:
1Maximum:
2048Update requires: Replacement
FolderType-
The type of folder it is.
Required: No
Type: String
Allowed values:
SHARED | RESTRICTEDUpdate requires: Replacement
Name-
A display name for the folder.
Required: No
Type: String
Minimum:
1Maximum:
200Update requires: No interruption
ParentFolderArn-
The Amazon Resource Name (ARN) for the folder.
Required: No
Type: String
Update requires: Replacement
Permissions-
A structure that describes the principals and the resource-level permissions of a folder.
To specify no permissions, omit
Permissions.Required: No
Type: Array of ResourcePermission
Minimum:
1Maximum:
64Update requires: No interruption
SharingModel-
The sharing scope of the folder.
Required: No
Type: String
Allowed values:
ACCOUNT | NAMESPACEUpdate requires: Replacement
-
A list of tags for the folders that you want to apply overrides to.
Required: No
Type: Array of Tag
Minimum:
1Maximum:
200Update requires: No interruption
Return values
Ref
Fn::GetAtt
Arn-
The Amazon Resource Name (ARN) for the folder.
CreatedTime-
The time that the folder was created.
LastUpdatedTime-
The time that the folder was last updated.
