CfnDashboardProps

class aws_cdk.aws_quicksight.CfnDashboardProps(*, aws_account_id, dashboard_id, source_entity, dashboard_publish_options=None, name=None, parameters=None, permissions=None, tags=None, theme_arn=None, version_description=None)

Bases: object

Properties for defining a CfnDashboard.

Parameters
  • aws_account_id (str) – The ID of the AWS account where you want to create the dashboard.

  • dashboard_id (str) – The ID for the dashboard, also added to the IAM policy.

  • source_entity (Union[DashboardSourceEntityProperty, Dict[str, Any], IResolvable]) – The entity that you are using as a source when you create the dashboard. In SourceEntity , you specify the type of object that you want to use. You can only create a dashboard from a template, so you use a SourceTemplate entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate , specify the Amazon Resource Name (ARN) of the source template. The SourceTemplate ARN can contain any AWS account; and any QuickSight-supported AWS Region . Use the DataSetReferences entity within SourceTemplate to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.

  • dashboard_publish_options (Union[DashboardPublishOptionsProperty, Dict[str, Any], IResolvable, None]) – Options for publishing the dashboard when you create it:. - AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED . When this is set to DISABLED , Amazon QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default. - AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED . The visual option to export data to .CSV format isn’t enabled when this is set to DISABLED . This option is ENABLED by default. - VisibilityState for SheetControlsOption - This visibility state can be either COLLAPSED or EXPANDED . This option is COLLAPSED by default.

  • name (Optional[str]) – The display name of the dashboard.

  • parameters (Union[ParametersProperty, Dict[str, Any], IResolvable, None]) – The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values.

  • permissions (Union[IResolvable, Sequence[Union[ResourcePermissionProperty, Dict[str, Any], IResolvable]], None]) – A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN. To specify no permissions, omit the permissions list.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.

  • theme_arn (Optional[str]) – The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that is used in the source entity. The theme ARN must exist in the same AWS account where you create the dashboard.

  • version_description (Optional[str]) – A description for the first version of the dashboard being created.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dashboard.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_dashboard_props = quicksight.CfnDashboardProps(
    aws_account_id="awsAccountId",
    dashboard_id="dashboardId",
    source_entity=quicksight.CfnDashboard.DashboardSourceEntityProperty(
        source_template=quicksight.CfnDashboard.DashboardSourceTemplateProperty(
            arn="arn",
            data_set_references=[quicksight.CfnDashboard.DataSetReferenceProperty(
                data_set_arn="dataSetArn",
                data_set_placeholder="dataSetPlaceholder"
            )]
        )
    ),

    # the properties below are optional
    dashboard_publish_options=quicksight.CfnDashboard.DashboardPublishOptionsProperty(
        ad_hoc_filtering_option=quicksight.CfnDashboard.AdHocFilteringOptionProperty(
            availability_status="availabilityStatus"
        ),
        export_to_csv_option=quicksight.CfnDashboard.ExportToCSVOptionProperty(
            availability_status="availabilityStatus"
        ),
        sheet_controls_option=quicksight.CfnDashboard.SheetControlsOptionProperty(
            visibility_state="visibilityState"
        )
    ),
    name="name",
    parameters=quicksight.CfnDashboard.ParametersProperty(
        date_time_parameters=[quicksight.CfnDashboard.DateTimeParameterProperty(
            name="name",
            values=["values"]
        )],
        decimal_parameters=[quicksight.CfnDashboard.DecimalParameterProperty(
            name="name",
            values=[123]
        )],
        integer_parameters=[quicksight.CfnDashboard.IntegerParameterProperty(
            name="name",
            values=[123]
        )],
        string_parameters=[quicksight.CfnDashboard.StringParameterProperty(
            name="name",
            values=["values"]
        )]
    ),
    permissions=[quicksight.CfnDashboard.ResourcePermissionProperty(
        actions=["actions"],
        principal="principal"
    )],
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    theme_arn="themeArn",
    version_description="versionDescription"
)

Attributes

aws_account_id

The ID of the AWS account where you want to create the dashboard.

Link

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

Return type

str

dashboard_id

The ID for the dashboard, also added to the IAM policy.

Link

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

Return type

str

dashboard_publish_options

.

  • AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED . When this is set to DISABLED , Amazon QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default.

  • AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED . The visual option to export data to .CSV format isn’t enabled when this is set to DISABLED . This option is ENABLED by default.

  • VisibilityState for SheetControlsOption - This visibility state can be either COLLAPSED or EXPANDED . This option is COLLAPSED by default.

Link

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

Type

Options for publishing the dashboard when you create it

Return type

Union[DashboardPublishOptionsProperty, IResolvable, None]

name

The display name of the dashboard.

Link

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

Return type

Optional[str]

parameters

The parameters for the creation of the dashboard, which you want to use to override the default settings.

A dashboard can have any type of parameters, and some parameters might accept multiple values.

Link

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

Return type

Union[ParametersProperty, IResolvable, None]

permissions

A structure that contains the permissions of the dashboard.

You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.

To specify no permissions, omit the permissions list.

Link

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

Return type

Union[IResolvable, List[Union[ResourcePermissionProperty, IResolvable]], None]

source_entity

The entity that you are using as a source when you create the dashboard.

In SourceEntity , you specify the type of object that you want to use. You can only create a dashboard from a template, so you use a SourceTemplate entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate , specify the Amazon Resource Name (ARN) of the source template. The SourceTemplate ARN can contain any AWS account; and any QuickSight-supported AWS Region .

Use the DataSetReferences entity within SourceTemplate to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.

Link

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

Return type

Union[DashboardSourceEntityProperty, IResolvable]

tags

Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.

Link

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

Return type

Optional[List[CfnTag]]

theme_arn

The Amazon Resource Name (ARN) of the theme that is being used for this dashboard.

If you add a value for this field, it overrides the value that is used in the source entity. The theme ARN must exist in the same AWS account where you create the dashboard.

Link

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

Return type

Optional[str]

version_description

A description for the first version of the dashboard being created.

Link

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

Return type

Optional[str]