Class CfnDashboard
Creates a dashboard from a template. To first create a template, see the CreateTemplate
API operation.
Inherited Members
Namespace: Amazon.CDK.AWS.QuickSight
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDashboard : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnDashboard
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created from analyses. You can share Amazon QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different AWS account .
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dashboard.html
CloudformationResource: AWS::QuickSight::Dashboard
ExampleMetadata: fixture=_generated
Synopsis
Constructors
CfnDashboard(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnDashboard(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnDashboard(Construct, String, ICfnDashboardProps) |
Properties
AttrArn | The Amazon Resource Name (ARN) of the dashboard. |
AttrCreatedTime | The time this dashboard version was created. |
AttrLastPublishedTime | The time that the dashboard was last published. |
AttrLastUpdatedTime | The time that the dashboard was last updated. |
AttrVersion | <p>Dashboard version.</p>. |
AttrVersionArn | |
AttrVersionCreatedTime | |
AttrVersionDataSetArns | |
AttrVersionDescription | |
AttrVersionErrors | |
AttrVersionSheets | |
AttrVersionSourceEntityArn | |
AttrVersionStatus | |
AttrVersionThemeArn | |
AttrVersionVersionNumber | |
AwsAccountId | The ID of the AWS account where you want to create the dashboard. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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 | Tag Manager which manages the tags for this resource. |
TagsRaw | 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. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnDashboard(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnDashboard(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnDashboard(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnDashboard(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnDashboard(Construct, String, ICfnDashboardProps)
public CfnDashboard(Construct scope, string id, ICfnDashboardProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnDashboardProps
Resource properties.
Properties
AttrArn
The Amazon Resource Name (ARN) of the dashboard.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrCreatedTime
The time this dashboard version was created.
public virtual string AttrCreatedTime { get; }
Property Value
System.String
Remarks
CloudformationAttribute: CreatedTime
AttrLastPublishedTime
The time that the dashboard was last published.
public virtual string AttrLastPublishedTime { get; }
Property Value
System.String
Remarks
CloudformationAttribute: LastPublishedTime
AttrLastUpdatedTime
The time that the dashboard was last updated.
public virtual string AttrLastUpdatedTime { get; }
Property Value
System.String
Remarks
CloudformationAttribute: LastUpdatedTime
AttrVersion
<p>Dashboard version.</p>.
public virtual IResolvable AttrVersion { get; }
Property Value
Remarks
CloudformationAttribute: Version
AttrVersionArn
public virtual string AttrVersionArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Version.Arn
AttrVersionCreatedTime
public virtual string AttrVersionCreatedTime { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Version.CreatedTime
AttrVersionDataSetArns
public virtual string[] AttrVersionDataSetArns { get; }
Property Value
System.String[]
Remarks
CloudformationAttribute: Version.DataSetArns
AttrVersionDescription
public virtual string AttrVersionDescription { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Version.Description
AttrVersionErrors
public virtual IResolvable AttrVersionErrors { get; }
Property Value
Remarks
CloudformationAttribute: Version.Errors
AttrVersionSheets
public virtual IResolvable AttrVersionSheets { get; }
Property Value
Remarks
CloudformationAttribute: Version.Sheets
AttrVersionSourceEntityArn
public virtual string AttrVersionSourceEntityArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Version.SourceEntityArn
AttrVersionStatus
public virtual string AttrVersionStatus { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Version.Status
AttrVersionThemeArn
public virtual string AttrVersionThemeArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Version.ThemeArn
AttrVersionVersionNumber
public virtual IResolvable AttrVersionVersionNumber { get; }
Property Value
Remarks
CloudformationAttribute: Version.VersionNumber
AwsAccountId
The ID of the AWS account where you want to create the dashboard.
public virtual string AwsAccountId { get; set; }
Property Value
System.String
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
DashboardId
The ID for the dashboard, also added to the IAM policy.
public virtual string DashboardId { get; set; }
Property Value
System.String
DashboardPublishOptions
Options for publishing the dashboard when you create it:.
public virtual object DashboardPublishOptions { get; set; }
Property Value
System.Object
Definition
public virtual object Definition { get; set; }
Property Value
System.Object
LinkEntities
A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.
public virtual string[] LinkEntities { get; set; }
Property Value
System.String[]
LinkSharingConfiguration
A structure that contains the link sharing configurations that you want to apply overrides to.
public virtual object LinkSharingConfiguration { get; set; }
Property Value
System.Object
Name
The display name of the dashboard.
public virtual string Name { get; set; }
Property Value
System.String
Parameters
The parameters for the creation of the dashboard, which you want to use to override the default settings.
public virtual object Parameters { get; set; }
Property Value
System.Object
Permissions
A structure that contains the permissions of the dashboard.
public virtual object Permissions { get; set; }
Property Value
System.Object
SourceEntity
The entity that you are using as a source when you create the dashboard.
public virtual object SourceEntity { get; set; }
Property Value
System.Object
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
ThemeArn
The Amazon Resource Name (ARN) of the theme that is being used for this dashboard.
public virtual string ThemeArn { get; set; }
Property Value
System.String
ValidationStrategy
The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects.
public virtual object ValidationStrategy { get; set; }
Property Value
System.Object
VersionDescription
A description for the first version of the dashboard being created.
public virtual string VersionDescription { get; set; }
Property Value
System.String
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>