AWS::QuickSight::Folder - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::QuickSight::Folder

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: 12

Maximum: 12

Update requires: Replacement

FolderId

The ID of the folder.

Required: No

Type: String

Pattern: ^[\w\-]+$

Minimum: 1

Maximum: 2048

Update requires: Replacement

FolderType

The type of folder it is.

Required: No

Type: String

Allowed values: SHARED | RESTRICTED

Update requires: Replacement

Name

A display name for the folder.

Required: No

Type: String

Minimum: 1

Maximum: 200

Update 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: 1

Maximum: 64

Update requires: No interruption

SharingModel

The sharing scope of the folder.

Required: No

Type: String

Allowed values: ACCOUNT | NAMESPACE

Update requires: Replacement

Tags

A list of tags for the folders that you want to apply overrides to.

Required: No

Type: Array of Tag

Minimum: 1

Maximum: 200

Update 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.