Class CfnDashboard

A CloudFormation AWS::QuickSight::Dashboard.

Inheritance

System.Object

Construct

CfnElement

CfnRefElement

CfnResource

CfnDashboard

Implements

IConstruct

Constructs.IConstruct

IDependable

IInspectable

Inherited Members

CfnResource.IsCfnResource(IConstruct)

CfnResource.AddDeletionOverride(String)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(String, Object)

CfnResource.AddOverride(String, Object)

CfnResource.AddPropertyDeletionOverride(String)

CfnResource.AddPropertyOverride(String, Object)

CfnResource.ApplyRemovalPolicy(Nullable<RemovalPolicy>, IRemovalPolicyOptions)

CfnResource.GetAtt(String)

CfnResource.GetMetadata(String)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(Object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnRefElement.Ref

CfnElement.IsCfnElement(Object)

CfnElement.OverrideLogicalId(String)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Construct.IsConstruct(Object)

Construct.OnPrepare()

Construct.OnSynthesize(ISynthesisSession)

Construct.OnValidate()

Construct.Prepare()

Construct.Synthesize(ISynthesisSession)

Construct.Validate()

Construct.Node

Namespace: Amazon.CDK.AWS.QuickSight

Assembly: Amazon.CDK.AWS.QuickSight.dll

Syntax (csharp)

public class CfnDashboard : CfnResource, IConstruct, IConstruct, IDependable, IInspectable

Syntax (vb)

Public Class CfnDashboard
    Inherits CfnResource
    Implements IConstruct, IConstruct, IDependable, IInspectable

Remarks

Creates a dashboard from a template. To first create a template, see the CreateTemplate API operation.

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 .

CloudformationResource: AWS::QuickSight::Dashboard

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.QuickSight;

CfnDashboard cfnDashboard = new CfnDashboard(this, "MyCfnDashboard", new CfnDashboardProps {
    AwsAccountId = "awsAccountId",
    DashboardId = "dashboardId",
    SourceEntity = new DashboardSourceEntityProperty {
        SourceTemplate = new DashboardSourceTemplateProperty {
            Arn = "arn",
            DataSetReferences = new [] { new DataSetReferenceProperty {
                DataSetArn = "dataSetArn",
                DataSetPlaceholder = "dataSetPlaceholder"
            } }
        }
    },

    // the properties below are optional
    DashboardPublishOptions = new DashboardPublishOptionsProperty {
        AdHocFilteringOption = new AdHocFilteringOptionProperty {
            AvailabilityStatus = "availabilityStatus"
        },
        ExportToCsvOption = new ExportToCSVOptionProperty {
            AvailabilityStatus = "availabilityStatus"
        },
        SheetControlsOption = new SheetControlsOptionProperty {
            VisibilityState = "visibilityState"
        }
    },
    Name = "name",
    Parameters = new ParametersProperty {
        DateTimeParameters = new [] { new DateTimeParameterProperty {
            Name = "name",
            Values = new [] { "values" }
        } },
        DecimalParameters = new [] { new DecimalParameterProperty {
            Name = "name",
            Values = new [] { 123 }
        } },
        IntegerParameters = new [] { new IntegerParameterProperty {
            Name = "name",
            Values = new [] { 123 }
        } },
        StringParameters = new [] { new StringParameterProperty {
            Name = "name",
            Values = new [] { "values" }
        } }
    },
    Permissions = new [] { new ResourcePermissionProperty {
        Actions = new [] { "actions" },
        Principal = "principal"
    } },
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } },
    ThemeArn = "themeArn",
    VersionDescription = "versionDescription"
});

Synopsis

Constructors

CfnDashboard(Construct, String, ICfnDashboardProps)	Create a new AWS::QuickSight::Dashboard.
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

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.
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:.
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.
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(Construct, String, ICfnDashboardProps)

Create a new AWS::QuickSight::Dashboard.

public CfnDashboard(Construct scope, string id, ICfnDashboardProps props)

Parameters

scope Construct

• scope in which this resource is defined.

id System.String

• scoped id of the resource.

props ICfnDashboardProps

• resource properties.

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

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

AwsAccountId

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

public virtual string AwsAccountId { get; set; }

Property Value

System.String

Remarks

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

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

CfnResource.CfnProperties

DashboardId

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

public virtual string DashboardId { get; set; }

Property Value

System.String

Remarks

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

DashboardPublishOptions

Options for publishing the dashboard when you create it:.

public virtual object DashboardPublishOptions { get; set; }

Property Value

System.Object

Remarks

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

Name

The display name of the dashboard.

public virtual string Name { get; set; }

Property Value

System.String

Remarks

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

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

Remarks

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

Permissions

A structure that contains the permissions of the dashboard.

public virtual 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.

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

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

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.

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

Tags

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

public virtual TagManager Tags { get; }

Property Value

TagManager

Remarks

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

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

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.

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

VersionDescription

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

public virtual string VersionDescription { get; set; }

Property Value

System.String

Remarks

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

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>

Overrides

CfnResource.RenderProperties(IDictionary<String, Object>)

Implements

IConstruct

Constructs.IConstruct

IDependable

IInspectable