DashboardArgs

data class DashboardArgs(val awsAccountId: Output<String>? = null, val dashboardId: Output<String>? = null, val dashboardPublishOptions: Output<DashboardPublishOptionsArgs>? = null, val definition: Output<DashboardVersionDefinitionArgs>? = null, val linkEntities: Output<List<String>>? = null, val linkSharingConfiguration: Output<DashboardLinkSharingConfigurationArgs>? = null, val name: Output<String>? = null, val parameters: Output<DashboardParametersArgs>? = null, val permissions: Output<List<DashboardResourcePermissionArgs>>? = null, val sourceEntity: Output<DashboardSourceEntityArgs>? = null, val tags: Output<List<TagArgs>>? = null, val themeArn: Output<String>? = null, val validationStrategy: Output<DashboardValidationStrategyArgs>? = null, val versionDescription: Output<String>? = null) : ConvertibleToJava<DashboardArgs>

Definition of the AWS::QuickSight::Dashboard Resource Type.

Constructors

Link copied to clipboard
constructor(awsAccountId: Output<String>? = null, dashboardId: Output<String>? = null, dashboardPublishOptions: Output<DashboardPublishOptionsArgs>? = null, definition: Output<DashboardVersionDefinitionArgs>? = null, linkEntities: Output<List<String>>? = null, linkSharingConfiguration: Output<DashboardLinkSharingConfigurationArgs>? = null, name: Output<String>? = null, parameters: Output<DashboardParametersArgs>? = null, permissions: Output<List<DashboardResourcePermissionArgs>>? = null, sourceEntity: Output<DashboardSourceEntityArgs>? = null, tags: Output<List<TagArgs>>? = null, themeArn: Output<String>? = null, validationStrategy: Output<DashboardValidationStrategyArgs>? = null, versionDescription: Output<String>? = null)

Properties

Link copied to clipboard
val awsAccountId: Output<String>? = null

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

Link copied to clipboard
val dashboardId: Output<String>? = null

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

Link copied to clipboard

Options for publishing the dashboard when you create it:

Link copied to clipboard
Link copied to clipboard
val linkEntities: Output<List<String>>? = null

A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

Link copied to clipboard

A structure that contains the link sharing configurations that you want to apply overrides to.

Link copied to clipboard
val name: Output<String>? = null

The display name of the dashboard.

Link copied to clipboard
val parameters: Output<DashboardParametersArgs>? = null

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 copied to clipboard

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 copied to clipboard

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 copied to clipboard
val tags: Output<List<TagArgs>>? = null

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

Link copied to clipboard
val themeArn: Output<String>? = null

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 copied to clipboard

The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to LENIENT , validation is skipped for specific errors.

Link copied to clipboard
val versionDescription: Output<String>? = null

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

Functions

Link copied to clipboard
open override fun toJava(): DashboardArgs