CfnFolderProps

class aws_cdk.aws_quicksight.CfnFolderProps(*, aws_account_id=None, folder_id=None, folder_type=None, name=None, parent_folder_arn=None, permissions=None, sharing_model=None, tags=None)

Bases: object

Properties for defining a CfnFolder.

Parameters:
  • aws_account_id (Optional[str]) – The ID for the AWS account where you want to create the folder.

  • folder_id (Optional[str]) – The ID of the folder.

  • folder_type (Optional[str]) – The type of folder it is.

  • name (Optional[str]) – A display name for the folder.

  • parent_folder_arn (Optional[str]) – The Amazon Resource Name (ARN) for the folder.

  • permissions (Union[IResolvable, Sequence[Union[IResolvable, ResourcePermissionProperty, Dict[str, Any]]], None]) – A structure that describes the principals and the resource-level permissions of a folder. To specify no permissions, omit Permissions .

  • sharing_model (Optional[str]) – The sharing scope of the folder.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – A list of tags for the folders that you want to apply overrides to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-folder.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

cfn_folder_props = quicksight.CfnFolderProps(
    aws_account_id="awsAccountId",
    folder_id="folderId",
    folder_type="folderType",
    name="name",
    parent_folder_arn="parentFolderArn",
    permissions=[quicksight.CfnFolder.ResourcePermissionProperty(
        actions=["actions"],
        principal="principal"
    )],
    sharing_model="sharingModel",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

aws_account_id

The ID for the AWS account where you want to create the folder.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-folder.html#cfn-quicksight-folder-awsaccountid

folder_id

The ID of the folder.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-folder.html#cfn-quicksight-folder-folderid

folder_type

The type of folder it is.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-folder.html#cfn-quicksight-folder-foldertype

name

A display name for the folder.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-folder.html#cfn-quicksight-folder-name

parent_folder_arn

The Amazon Resource Name (ARN) for the folder.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-folder.html#cfn-quicksight-folder-parentfolderarn

permissions

A structure that describes the principals and the resource-level permissions of a folder.

To specify no permissions, omit Permissions .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-folder.html#cfn-quicksight-folder-permissions

sharing_model

The sharing scope of the folder.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-folder.html#cfn-quicksight-folder-sharingmodel

tags

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-folder.html#cfn-quicksight-folder-tags