Package software.amazon.awscdk.services.quicksight

Class CfnDashboardProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.quicksight.CfnDashboardProps.Jsii$Proxy

All Implemented Interfaces:

CfnDashboardProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnDashboardProps

@Stability(Stable)
@Internal
public static final class CfnDashboardProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnDashboardProps

An implementation for CfnDashboardProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.quicksight.CfnDashboardProps

CfnDashboardProps.Builder, CfnDashboardProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnDashboardProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnDashboardProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final String	getAwsAccountId()	The ID of the AWS account where you want to create the dashboard.
final String	getDashboardId()	The ID for the dashboard, also added to the IAM policy.
final Object	getDashboardPublishOptions()	Options for publishing the dashboard when you create it:.
final Object	getDefinition()	Returns union: either IResolvable or CfnDashboard.DashboardVersionDefinitionProperty
final List<String>	getFolderArns()
final List<String>	getLinkEntities()	A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.
final Object	getLinkSharingConfiguration()	A structure that contains the link sharing configurations that you want to apply overrides to.
final String	getName()	The display name of the dashboard.
final Object	getParameters()	The parameters for the creation of the dashboard, which you want to use to override the default settings.
final Object	getPermissions()	A structure that contains the permissions of the dashboard.
final Object	getSourceEntity()	The entity that you are using as a source when you create the dashboard.
final List<CfnTag>	getTags()	Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
final String	getThemeArn()	The Amazon Resource Name (ARN) of the theme that is being used for this dashboard.
final Object	getValidationStrategy()	The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects.
final String	getVersionDescription()	A description for the first version of the dashboard being created.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnDashboardProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnDashboardProps.Builder.

Method Details

getAwsAccountId

public final String getAwsAccountId()

Description copied from interface: CfnDashboardProps

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

Specified by:

getAwsAccountId in interface CfnDashboardProps

See Also:

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

getDashboardId

public final String getDashboardId()

Description copied from interface: CfnDashboardProps

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

Specified by:

getDashboardId in interface CfnDashboardProps

See Also:

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

getName

public final String getName()

Description copied from interface: CfnDashboardProps

The display name of the dashboard.

Specified by:

getName in interface CfnDashboardProps

See Also:

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

getDashboardPublishOptions

public final Object getDashboardPublishOptions()

Description copied from interface: CfnDashboardProps

Options for publishing the dashboard when you create it:.

• AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED . When this is set to DISABLED , Amazon Quick Sight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default.
• AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED . The visual option to export data to .CSV format isn't enabled when this is set to DISABLED . This option is ENABLED by default.
• VisibilityState for SheetControlsOption - This visibility state can be either COLLAPSED or EXPANDED . This option is COLLAPSED by default.
• AvailabilityStatus for QuickSuiteActionsOption - This status can be either ENABLED or DISABLED . Features related to Actions in Amazon Quick Suite on dashboards are disabled when this is set to DISABLED . This option is DISABLED by default.
• AvailabilityStatus for ExecutiveSummaryOption - This status can be either ENABLED or DISABLED . The option to build an executive summary is disabled when this is set to DISABLED . This option is ENABLED by default.
• AvailabilityStatus for DataStoriesSharingOption - This status can be either ENABLED or DISABLED . The option to share a data story is disabled when this is set to DISABLED . This option is ENABLED by default.

Returns union: either IResolvable or CfnDashboard.DashboardPublishOptionsProperty

Specified by:

getDashboardPublishOptions in interface CfnDashboardProps

See Also:

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

getDefinition

public final Object getDefinition()

Description copied from interface: CfnDashboardProps

Returns union: either IResolvable or CfnDashboard.DashboardVersionDefinitionProperty

Specified by:

getDefinition in interface CfnDashboardProps

See Also:

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

getFolderArns

public final List<String> getFolderArns()

Specified by:

getFolderArns in interface CfnDashboardProps

See Also:

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

getLinkEntities

public final List<String> getLinkEntities()

Description copied from interface: CfnDashboardProps

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

Specified by:

getLinkEntities in interface CfnDashboardProps

See Also:

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

getLinkSharingConfiguration

public final Object getLinkSharingConfiguration()

Description copied from interface: CfnDashboardProps

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

Returns union: either IResolvable or CfnDashboard.LinkSharingConfigurationProperty

Specified by:

getLinkSharingConfiguration in interface CfnDashboardProps

See Also:

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

getParameters

public final Object getParameters()

Description copied from interface: CfnDashboardProps

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.

Returns union: either IResolvable or CfnDashboard.ParametersProperty

Specified by:

getParameters in interface CfnDashboardProps

See Also:

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

getPermissions

public final Object getPermissions()

Description copied from interface: CfnDashboardProps

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.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDashboard.ResourcePermissionProperty>

Specified by:

getPermissions in interface CfnDashboardProps

See Also:

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

getSourceEntity

public final Object getSourceEntity()

Description copied from interface: CfnDashboardProps

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.

Returns union: either IResolvable or CfnDashboard.DashboardSourceEntityProperty

Specified by:

getSourceEntity in interface CfnDashboardProps

See Also:

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

getTags

public final List<CfnTag> getTags()

Description copied from interface: CfnDashboardProps

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

Specified by:

getTags in interface CfnDashboardProps

See Also:

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

getThemeArn

public final String getThemeArn()

Description copied from interface: CfnDashboardProps

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.

Specified by:

getThemeArn in interface CfnDashboardProps

See Also:

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

getValidationStrategy

public final Object getValidationStrategy()

Description copied from interface: CfnDashboardProps

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.

Returns union: either IResolvable or CfnDashboard.ValidationStrategyProperty

Specified by:

getValidationStrategy in interface CfnDashboardProps

See Also:

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

getVersionDescription

public final String getVersionDescription()

Description copied from interface: CfnDashboardProps

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

Specified by:

getVersionDescription in interface CfnDashboardProps

See Also:

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

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object