quicksight/aws.sdk.kotlin.services.quicksight.model/CreateDashboardRequest/Builder

Builder

Properties

var awsAccountId: String?

The ID of the Amazon Web Services account where you want to create the dashboard.

var dashboardId: String?

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

dashboardPublishOptions

var dashboardPublishOptions: DashboardPublishOptions?

Options for publishing the dashboard when you create it:

var definition: DashboardVersionDefinition?

The definition of a dashboard.

var folderArns: List<String>?

When you create the dashboard, Amazon QuickSight adds the dashboard to these folders.

var linkEntities: List<String>?

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

linkSharingConfiguration

var linkSharingConfiguration: LinkSharingConfiguration?

A structure that contains the permissions of a shareable link to the dashboard.

var name: String?

The display name of the dashboard.

var parameters: Parameters?

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.

var permissions: List<ResourcePermission>?

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.

var sourceEntity: DashboardSourceEntity?

The entity that you are using as a source when you create the dashboard. In SourceEntity, you specify the type of object you're using as source. 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 <a href="https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTemplate.html">CreateTemplate</a> API operation. For SourceTemplate, specify the Amazon Resource Name (ARN) of the source template. The SourceTemplateARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region.

var tags: List<Tag>?

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

var themeArn: String?

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 Amazon Web Services account where you create the dashboard.

validationStrategy

var validationStrategy: ValidationStrategy?

The option to relax the validation needed to create a dashboard with definition objects. This option skips the validation step for specific errors.

versionDescription

var versionDescription: String?

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

Functions

dashboardPublishOptions

fun dashboardPublishOptions(block: DashboardPublishOptions.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.quicksight.model.DashboardPublishOptions inside the given block

fun definition(block: DashboardVersionDefinition.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.quicksight.model.DashboardVersionDefinition inside the given block

linkSharingConfiguration

fun linkSharingConfiguration(block: LinkSharingConfiguration.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.quicksight.model.LinkSharingConfiguration inside the given block

fun parameters(block: Parameters.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.quicksight.model.Parameters inside the given block

fun sourceEntity(block: DashboardSourceEntity.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.quicksight.model.DashboardSourceEntity inside the given block

validationStrategy

fun validationStrategy(block: ValidationStrategy.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.quicksight.model.ValidationStrategy inside the given block