Class CfnDashboardProps
Properties for defining a CfnDashboard
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.QuickSight
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDashboardProps : Object, ICfnDashboardProps
Syntax (vb)
Public Class CfnDashboardProps
Inherits Object
Implements ICfnDashboardProps
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dashboard.html
ExampleMetadata: fixture=_generated
Synopsis
Constructors
CfnDashboardProps() |
Properties
AwsAccountId | The ID of the AWS account where you want to create the dashboard. |
DashboardId | The ID for the dashboard, also added to the IAM policy. |
DashboardPublishOptions | Options for publishing the dashboard when you create it:. |
Definition | |
LinkEntities | A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard. |
LinkSharingConfiguration | A structure that contains the link sharing configurations that you want to apply overrides to. |
Name | The display name of the dashboard. |
Parameters | The parameters for the creation of the dashboard, which you want to use to override the default settings. |
Permissions | A structure that contains the permissions of the dashboard. |
SourceEntity | The entity that you are using as a source when you create the dashboard. |
Tags | Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard. |
ThemeArn | The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. |
ValidationStrategy | The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. |
VersionDescription | A description for the first version of the dashboard being created. |
Constructors
CfnDashboardProps()
public CfnDashboardProps()
Properties
AwsAccountId
The ID of the AWS account where you want to create the dashboard.
public string AwsAccountId { get; set; }
Property Value
System.String
Remarks
DashboardId
The ID for the dashboard, also added to the IAM policy.
public string DashboardId { get; set; }
Property Value
System.String
Remarks
DashboardPublishOptions
Options for publishing the dashboard when you create it:.
public object DashboardPublishOptions { get; set; }
Property Value
System.Object
Remarks
Definition
public object Definition { get; set; }
Property Value
System.Object
Remarks
LinkEntities
A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.
public string[] LinkEntities { get; set; }
Property Value
System.String[]
Remarks
LinkSharingConfiguration
A structure that contains the link sharing configurations that you want to apply overrides to.
public object LinkSharingConfiguration { get; set; }
Property Value
System.Object
Remarks
Name
The display name of the dashboard.
public string Name { get; set; }
Property Value
System.String
Remarks
Parameters
The parameters for the creation of the dashboard, which you want to use to override the default settings.
public object Parameters { get; set; }
Property Value
System.Object
Remarks
A dashboard can have any type of parameters, and some parameters might accept multiple values.
Permissions
A structure that contains the permissions of the dashboard.
public object Permissions { get; set; }
Property Value
System.Object
Remarks
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.
SourceEntity
The entity that you are using as a source when you create the dashboard.
public object SourceEntity { get; set; }
Property Value
System.Object
Remarks
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.
Tags
Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
public ICfnTag[] Tags { get; set; }
Property Value
ICfnTag[]
Remarks
ThemeArn
The Amazon Resource Name (ARN) of the theme that is being used for this dashboard.
public string ThemeArn { get; set; }
Property Value
System.String
Remarks
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.
ValidationStrategy
The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects.
public object ValidationStrategy { get; set; }
Property Value
System.Object
Remarks
When you set this value to LENIENT
, validation is skipped for specific errors.
VersionDescription
A description for the first version of the dashboard being created.
public string VersionDescription { get; set; }
Property Value
System.String