Class CfnDashboardMixinProps

Properties for CfnDashboardPropsMixin.

Inheritance
object
CfnDashboardMixinProps
Inherited Members
Namespace: Amazon.CDK.CfnPropertyMixins.AWS.QuickSight
Assembly: Amazon.CDK.CfnPropertyMixins.dll
Syntax (csharp)
public class CfnDashboardMixinProps : ICfnDashboardMixinProps
Syntax (vb)
Public Class CfnDashboardMixinProps Implements ICfnDashboardMixinProps
Remarks

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

ExampleMetadata: fixture=_generated

Synopsis

Constructors

CfnDashboardMixinProps()

Properties for CfnDashboardPropsMixin.

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

Properties for CfnDashboardPropsMixin.
FolderArns

Properties for CfnDashboardPropsMixin.
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

CfnDashboardMixinProps()

Properties for CfnDashboardPropsMixin.

public CfnDashboardMixinProps()
Remarks

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

ExampleMetadata: fixture=_generated

Properties

AwsAccountId

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

public string? AwsAccountId { get; set; }
Property Value

string

Remarks

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

DashboardId

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

public string? DashboardId { get; set; }
Property Value

string

Remarks

See: 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 object? DashboardPublishOptions { get; set; }
Property Value

object

Remarks

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

    Type union: either IResolvable or CfnDashboardPropsMixin.IDashboardPublishOptionsProperty

    Definition

    Properties for CfnDashboardPropsMixin.

    public object? Definition { get; set; }
    Property Value

    object

    Remarks

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

    Type union: either IResolvable or CfnDashboardPropsMixin.IDashboardVersionDefinitionProperty

    FolderArns

    Properties for CfnDashboardPropsMixin.

    public string[]? FolderArns { get; set; }
    Property Value

    string[]

    Remarks

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

    LinkEntities

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

    public string[]? LinkEntities { get; set; }
    Property Value

    string[]

    Remarks

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

    LinkSharingConfiguration

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

    public object? LinkSharingConfiguration { get; set; }
    Property Value

    object

    Remarks

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

    Type union: either IResolvable or CfnDashboardPropsMixin.ILinkSharingConfigurationProperty

    Name

    The display name of the dashboard.

    public string? Name { get; set; }
    Property Value

    string

    Remarks

    See: 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 object? Parameters { get; set; }
    Property Value

    object

    Remarks

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

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

    Type union: either IResolvable or CfnDashboardPropsMixin.IParametersProperty

    Permissions

    A structure that contains the permissions of the dashboard.

    public object? Permissions { get; set; }
    Property Value

    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.

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

    Type union: either IResolvable or (either IResolvable or CfnDashboardPropsMixin.IResourcePermissionProperty)[]

    SourceEntity

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

    public object? SourceEntity { get; set; }
    Property Value

    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.

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

    Type union: either IResolvable or CfnDashboardPropsMixin.IDashboardSourceEntityProperty

    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

    See: 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 object? ThemeArn { get; set; }
    Property Value

    object

    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.

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

    Type union: either string or IThemeRef

    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

    object

    Remarks

    When you set this value to LENIENT , validation is skipped for specific errors.

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

    Type union: either IResolvable or CfnDashboardPropsMixin.IValidationStrategyProperty

    VersionDescription

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

    public string? VersionDescription { get; set; }
    Property Value

    string

    Remarks

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

    Implements