CfnCustomPermissionsPropsMixin

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

Bases: Mixin

Creates a custom permissions profile.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-custompermissions.html
CloudformationResource:: AWS::QuickSight::CustomPermissions
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_custom_permissions_props_mixin = quicksight_mixins.CfnCustomPermissionsPropsMixin(quicksight_mixins.CfnCustomPermissionsMixinProps(
    aws_account_id="awsAccountId",
    capabilities=quicksight_mixins.CfnCustomPermissionsPropsMixin.CapabilitiesProperty(
        add_or_run_anomaly_detection_for_analyses="addOrRunAnomalyDetectionForAnalyses",
        analysis="analysis",
        create_and_update_dashboard_email_reports="createAndUpdateDashboardEmailReports",
        create_and_update_datasets="createAndUpdateDatasets",
        create_and_update_data_sources="createAndUpdateDataSources",
        create_and_update_themes="createAndUpdateThemes",
        create_and_update_threshold_alerts="createAndUpdateThresholdAlerts",
        create_shared_folders="createSharedFolders",
        create_spice_dataset="createSpiceDataset",
        dashboard="dashboard",
        export_to_csv="exportToCsv",
        export_to_csv_in_scheduled_reports="exportToCsvInScheduledReports",
        export_to_excel="exportToExcel",
        export_to_excel_in_scheduled_reports="exportToExcelInScheduledReports",
        export_to_pdf="exportToPdf",
        export_to_pdf_in_scheduled_reports="exportToPdfInScheduledReports",
        include_content_in_scheduled_reports_email="includeContentInScheduledReportsEmail",
        print_reports="printReports",
        rename_shared_folders="renameSharedFolders",
        share_analyses="shareAnalyses",
        share_dashboards="shareDashboards",
        share_datasets="shareDatasets",
        share_data_sources="shareDataSources",
        subscribe_dashboard_email_reports="subscribeDashboardEmailReports",
        view_account_spice_capacity="viewAccountSpiceCapacity"
    ),
    custom_permissions_name="customPermissionsName",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnCustomPermissionsMixinProps, 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', 'capabilities', 'customPermissionsName', '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

CapabilitiesProperty

class CfnCustomPermissionsPropsMixin.CapabilitiesProperty(*, add_or_run_anomaly_detection_for_analyses=None, analysis=None, create_and_update_dashboard_email_reports=None, create_and_update_datasets=None, create_and_update_data_sources=None, create_and_update_themes=None, create_and_update_threshold_alerts=None, create_shared_folders=None, create_spice_dataset=None, dashboard=None, export_to_csv=None, export_to_csv_in_scheduled_reports=None, export_to_excel=None, export_to_excel_in_scheduled_reports=None, export_to_pdf=None, export_to_pdf_in_scheduled_reports=None, include_content_in_scheduled_reports_email=None, print_reports=None, rename_shared_folders=None, share_analyses=None, share_dashboards=None, share_datasets=None, share_data_sources=None, subscribe_dashboard_email_reports=None, view_account_spice_capacity=None)

Bases: object

A set of actions that correspond to Amazon Quick Sight permissions.

Parameters:

add_or_run_anomaly_detection_for_analyses (Optional[str]) – The ability to add or run anomaly detection.
analysis (Optional[str]) – The ability to perform analysis-related actions.
create_and_update_dashboard_email_reports (Optional[str]) – The ability to create and update email reports.
create_and_update_datasets (Optional[str]) – The ability to create and update datasets.
create_and_update_data_sources (Optional[str]) – The ability to create and update data sources.
create_and_update_themes (Optional[str]) – The ability to export to Create and Update themes.
create_and_update_threshold_alerts (Optional[str]) – The ability to create and update threshold alerts.
create_shared_folders (Optional[str]) – The ability to create shared folders.
create_spice_dataset (Optional[str]) – The ability to create a SPICE dataset.
dashboard (Optional[str]) – The ability to perform dashboard-related actions.
export_to_csv (Optional[str]) – The ability to export to CSV files from the UI.
export_to_csv_in_scheduled_reports (Optional[str]) – The ability to export to CSV files in scheduled email reports.
export_to_excel (Optional[str]) – The ability to export to Excel files from the UI.
export_to_excel_in_scheduled_reports (Optional[str]) – The ability to export to Excel files in scheduled email reports.
export_to_pdf (Optional[str]) – The ability to export to PDF files from the UI.
export_to_pdf_in_scheduled_reports (Optional[str]) – The ability to export to PDF files in scheduled email reports.
include_content_in_scheduled_reports_email (Optional[str]) – The ability to include content in scheduled email reports.
print_reports (Optional[str]) – The ability to print reports.
rename_shared_folders (Optional[str]) – The ability to rename shared folders.
share_analyses (Optional[str]) – The ability to share analyses.
share_dashboards (Optional[str]) – The ability to share dashboards.
share_datasets (Optional[str]) – The ability to share datasets.
share_data_sources (Optional[str]) – The ability to share data sources.
subscribe_dashboard_email_reports (Optional[str]) – The ability to subscribe to email reports.
view_account_spice_capacity (Optional[str]) – The ability to view account SPICE capacity.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-custompermissions-capabilities.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

capabilities_property = quicksight_mixins.CfnCustomPermissionsPropsMixin.CapabilitiesProperty(
    add_or_run_anomaly_detection_for_analyses="addOrRunAnomalyDetectionForAnalyses",
    analysis="analysis",
    create_and_update_dashboard_email_reports="createAndUpdateDashboardEmailReports",
    create_and_update_datasets="createAndUpdateDatasets",
    create_and_update_data_sources="createAndUpdateDataSources",
    create_and_update_themes="createAndUpdateThemes",
    create_and_update_threshold_alerts="createAndUpdateThresholdAlerts",
    create_shared_folders="createSharedFolders",
    create_spice_dataset="createSpiceDataset",
    dashboard="dashboard",
    export_to_csv="exportToCsv",
    export_to_csv_in_scheduled_reports="exportToCsvInScheduledReports",
    export_to_excel="exportToExcel",
    export_to_excel_in_scheduled_reports="exportToExcelInScheduledReports",
    export_to_pdf="exportToPdf",
    export_to_pdf_in_scheduled_reports="exportToPdfInScheduledReports",
    include_content_in_scheduled_reports_email="includeContentInScheduledReportsEmail",
    print_reports="printReports",
    rename_shared_folders="renameSharedFolders",
    share_analyses="shareAnalyses",
    share_dashboards="shareDashboards",
    share_datasets="shareDatasets",
    share_data_sources="shareDataSources",
    subscribe_dashboard_email_reports="subscribeDashboardEmailReports",
    view_account_spice_capacity="viewAccountSpiceCapacity"
)