CfnFolderPropsMixin

class aws_cdk.mixins_preview.aws_quicksight.mixins.CfnFolderPropsMixin(props, *, strategy=None)

Bases: Mixin

Creates an empty shared folder.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-folder.html
CloudformationResource:: AWS::QuickSight::Folder
Mixin:: true
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_quicksight import mixins as quicksight_mixins

cfn_folder_props_mixin = quicksight_mixins.CfnFolderPropsMixin(quicksight_mixins.CfnFolderMixinProps(
    aws_account_id="awsAccountId",
    folder_id="folderId",
    folder_type="folderType",
    name="name",
    parent_folder_arn="parentFolderArn",
    permissions=[quicksight_mixins.CfnFolderPropsMixin.ResourcePermissionProperty(
        actions=["actions"],
        principal="principal"
    )],
    sharing_model="sharingModel",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::QuickSight::Folder.

Parameters:

props (Union[CfnFolderMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['awsAccountId', 'folderId', 'folderType', 'name', 'parentFolderArn', 'permissions', 'sharingModel', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

ResourcePermissionProperty

class CfnFolderPropsMixin.ResourcePermissionProperty(*, actions=None, principal=None)

Bases: object

Parameters:

actions (Optional[Sequence[str]])
principal (Optional[str]) – This can be one of the following: The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.) The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.)

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-folder-resourcepermission.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.mixins_preview.aws_quicksight import mixins as quicksight_mixins

resource_permission_property = quicksight_mixins.CfnFolderPropsMixin.ResourcePermissionProperty(
    actions=["actions"],
    principal="principal"
)

Attributes

actions

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-folder-resourcepermission.html#cfn-quicksight-folder-resourcepermission-actions

Type:: see

principal

This can be one of the following:

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-folder-resourcepermission.html#cfn-quicksight-folder-resourcepermission-principal