Dashboard

quicksight.services.k8s.aws/v1alpha1

Type	Link
GoDoc	quicksight-controller/apis/v1alpha1#Dashboard

Metadata

Property	Value
Scope	Namespaced
Kind	`Dashboard`
ListKind	`DashboardList`
Plural	`dashboards`
Singular	`dashboard`

Dashboard.

Spec

awsAccountID: string
folderARNs:
- string
id: string
linkEntities:
- string
linkEntityRefs:
  from: 
    name: string
    namespace: string
linkSharingConfiguration: 
  permissions:
    actions:
    - string
    principal: string
name: string
parameters: 
  dateTimeParameters:
  - name: string
    values:
    - string
  decimalParameters:
  - name: string
    values:
    - number
  integerParameters:
  - name: string
    values:
    - integer
  stringParameters:
  - name: string
    values:
    - string
permissions:
  actions:
  - string
  principal: string
publishOptions: 
  adHocFilteringOption: 
    availabilityStatus: string
  dataPointDrillUpDownOption: 
    availabilityStatus: string
  dataPointMenuLabelOption: 
    availabilityStatus: string
  dataPointTooltipOption: 
    availabilityStatus: string
  dataQAEnabledOption: 
    availabilityStatus: string
  dataStoriesSharingOption: 
    availabilityStatus: string
  executiveSummaryOption: 
    availabilityStatus: string
  exportToCSVOption: 
    availabilityStatus: string
  exportWithHiddenFieldsOption: 
    availabilityStatus: string
  quickSuiteActionsOption: 
    availabilityStatus: string
  sheetControlsOption: 
    visibilityState: string
  sheetLayoutElementMaximizationOption: 
    availabilityStatus: string
  visualAxisSortOption: 
    availabilityStatus: string
  visualMenuOption: 
    availabilityStatus: string
  visualPublishOptions: 
    exportHiddenFieldsOption: 
      availabilityStatus: string
sourceEntity: 
  sourceTemplate: 
    arn: string
    dataSetReferences:
    - dataSetARN: string
      dataSetPlaceholder: string
      dataSetRef: 
        from: 
          name: string
          namespace: string
tags:
- key: string
  value: string
themeARN: string
validationStrategy: 
  mode: string
versionDescription: string

Field	Description
awsAccountID Required	string The ID of the Amazon Web Services account where you want to create the dashboard. Regex Pattern: `^[0-9]{12}$`
folderARNs Optional	array When you create the dashboard, Amazon Quick Sight adds the dashboard to these folders.
folderARNs.[] Required	string
linkEntities Optional	array A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.
linkEntities.[] Required	string
linkEntityRefs.[] Required	object AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference
type to provide more user friendly syntax for references using ‘from’ field
Ex:
APIIDRef:

from:
  name: my-api || **linkEntityRefs.[].from**<br/>Optional | **object**<br/>AWSResourceReference provides all the values necessary to reference another<br/>k8s resource for finding the identifier(Id/ARN/Name) |

| linkEntityRefs.[].from.name
Optional | string
| | linkEntityRefs.[].from.namespace
Optional | string
| | linkSharingConfiguration
Optional | object
A structure that contains the permissions of a shareable link to the dashboard. | | linkSharingConfiguration.permissions
Optional | array
| | linkSharingConfiguration.permissions.[]
Required | object
Permission for the resource. || linkSharingConfiguration.permissions.[].actions
Optional | array
| | linkSharingConfiguration.permissions.[].actions.[]
Required | string
|| linkSharingConfiguration.permissions.[].principal
Optional | string
| | name
Required | string
The display name of the dashboard. | | parameters
Optional | object
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. | | parameters.dateTimeParameters
Optional | array
| | parameters.dateTimeParameters.[]
Required | object
A date-time parameter. || parameters.dateTimeParameters.[].name
Optional | string
| | parameters.dateTimeParameters.[].values
Optional | array
| | parameters.dateTimeParameters.[].values.[]
Required | string
|| parameters.decimalParameters
Optional | array
| | parameters.decimalParameters.[]
Required | object
A decimal parameter. || parameters.decimalParameters.[].name
Optional | string
| | parameters.decimalParameters.[].values
Optional | array
| | parameters.decimalParameters.[].values.[]
Required | number
|| parameters.integerParameters
Optional | array
| | parameters.integerParameters.[]
Required | object
An integer parameter. || parameters.integerParameters.[].name
Optional | string
| | parameters.integerParameters.[].values
Optional | array
| | parameters.integerParameters.[].values.[]
Required | integer
|| parameters.stringParameters
Optional | array
| | parameters.stringParameters.[]
Required | object
A string parameter. || parameters.stringParameters.[].name
Optional | string
| | parameters.stringParameters.[].values
Optional | array
| | parameters.stringParameters.[].values.[]
Required | string
|| permissions
Optional | array
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. | | permissions.[]
Required | object
Permission for the resource. || permissions.[].actions
Optional | array
| | permissions.[].actions.[]
Required | string
|| permissions.[].principal
Optional | string
| | publishOptions
Optional | object
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. | | publishOptions.adHocFilteringOption
Optional | object
An ad hoc (one-time) filtering option. | | publishOptions.adHocFilteringOption.availabilityStatus
Optional | string
| | publishOptions.dataPointDrillUpDownOption
Optional | object
The drill down options for data points in a dashbaord. | | publishOptions.dataPointDrillUpDownOption.availabilityStatus
Optional | string
| | publishOptions.dataPointMenuLabelOption
Optional | object
The data point menu options of a dashboard. | | publishOptions.dataPointMenuLabelOption.availabilityStatus
Optional | string
| | publishOptions.dataPointTooltipOption
Optional | object
The data point tooltip options. | | publishOptions.dataPointTooltipOption.availabilityStatus
Optional | string
| | publishOptions.dataQAEnabledOption
Optional | object
Adds Q&A capabilities to a dashboard. If no topic is linked, Dashboard Q&A
uses the data values that are rendered on the dashboard. End users can use
Dashboard Q&A to ask for different slices of the data that they see on the
dashboard. If a topic is linked, Topic Q&A is enabled. | | publishOptions.dataQAEnabledOption.availabilityStatus
Optional | string
| | publishOptions.dataStoriesSharingOption
Optional | object
Executive summary option. | | publishOptions.dataStoriesSharingOption.availabilityStatus
Optional | string
| | publishOptions.executiveSummaryOption
Optional | object
Data stories sharing option. | | publishOptions.executiveSummaryOption.availabilityStatus
Optional | string
| | publishOptions.exportToCSVOption
Optional | object
Export to .csv option. | | publishOptions.exportToCSVOption.availabilityStatus
Optional | string
| | publishOptions.exportWithHiddenFieldsOption
Optional | object
Determines whether or not hidden fields are visible on exported dashbaords. | | publishOptions.exportWithHiddenFieldsOption.availabilityStatus
Optional | string
| | publishOptions.quickSuiteActionsOption
Optional | object
Determines if Actions in Amazon Quick Suite are enabled in a dashboard.. | | publishOptions.quickSuiteActionsOption.availabilityStatus
Optional | string
| | publishOptions.sheetControlsOption
Optional | object
Sheet controls option. | | publishOptions.sheetControlsOption.visibilityState
Optional | string
| | publishOptions.sheetLayoutElementMaximizationOption
Optional | object
The sheet layout maximization options of a dashbaord. | | publishOptions.sheetLayoutElementMaximizationOption.availabilityStatus
Optional | string
| | publishOptions.visualAxisSortOption
Optional | object
The axis sort options for a visual. | | publishOptions.visualAxisSortOption.availabilityStatus
Optional | string
| | publishOptions.visualMenuOption
Optional | object
The menu options for a visual. | | publishOptions.visualMenuOption.availabilityStatus
Optional | string
| | publishOptions.visualPublishOptions
Optional | object
The visual publish options of a visual in a dashboard | | publishOptions.visualPublishOptions.exportHiddenFieldsOption
Optional | object
Determines if hidden fields are included in an exported dashboard. | | publishOptions.visualPublishOptions.exportHiddenFieldsOption.availabilityStatus
Optional | string
| | sourceEntity
Optional | object
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 CreateTemplate (https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTemplate.html)
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 Quick Sight-supported Amazon Web Services
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.

Either a SourceEntity or a Definition must be provided in order for the request
to be valid. | | sourceEntity.sourceTemplate
Optional | object
Dashboard source template. | | sourceEntity.sourceTemplate.arn
Optional | string
| | sourceEntity.sourceTemplate.dataSetReferences
Optional | array
| | sourceEntity.sourceTemplate.dataSetReferences.[]
Required | object
Dataset reference. || sourceEntity.sourceTemplate.dataSetReferences.[].dataSetARN
Optional | string
| | sourceEntity.sourceTemplate.dataSetReferences.[].dataSetPlaceholder
Optional | string
| | sourceEntity.sourceTemplate.dataSetReferences.[].dataSetRef
Optional | object
Reference field for DataSetARN | | sourceEntity.sourceTemplate.dataSetReferences.[].dataSetRef.from
Optional | object
AWSResourceReference provides all the values necessary to reference another
k8s resource for finding the identifier(Id/ARN/Name) | | sourceEntity.sourceTemplate.dataSetReferences.[].dataSetRef.from.name
Optional | string
| | sourceEntity.sourceTemplate.dataSetReferences.[].dataSetRef.from.namespace
Optional | string
| | tags
Optional | array
Contains a map of the key-value pairs for the resource tag or tags assigned
to the dashboard. | | tags.[]
Required | object
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource. || tags.[].key
Optional | string
| | tags.[].value
Optional | string
| | themeARN
Optional | 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
Optional | object
The option to relax the validation needed to create a dashboard with definition
objects. This option skips the validation step for specific errors. | | validationStrategy.mode
Optional | string
| | versionDescription
Optional | string
A description for the first version of the dashboard being created. |

Status

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  partition: string
  region: string
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
createdTime: string
creationStatus: string
lastPublishedTime: string
lastUpdatedTime: string
versionARN: string
versionNumber: integer
versionStatus: string

Field	Description
ackResourceMetadata Optional	object All CRs managed by ACK have a common `Status.ACKResourceMetadata` member that is used to contain resource sync state, account ownership, constructed ARN for the resource
ackResourceMetadata.arn Optional	string ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. https://github.com/aws/aws-controllers-k8s/issues/270
ackResourceMetadata.ownerAccountID Required	string OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource.
ackResourceMetadata.partition Optional	string Partition is the AWS partition in which the resource exists or will exist
ackResourceMetadata.region Required	string Region is the AWS region in which the resource exists or will exist.
conditions Optional	array All CRs managed by ACK have a common `Status.Conditions` member that contains a collection of `ackv1alpha1.Condition` objects that describe the various terminal states of the CR and its backend AWS service API resource
conditions.[] Required	object Condition is the common struct used by all CRDs managed by ACK service
controllers to indicate terminal states of the CR and its backend AWS
service API resource
conditions.[].message Optional	string A human readable message indicating details about the transition.
conditions.[].reason Optional	string The reason for the condition’s last transition.
conditions.[].status Optional	string Status of the condition, one of True, False, Unknown.
conditions.[].type Optional	string Type is the type of the Condition
createdTime Optional	string The time that this dashboard was created.
creationStatus Optional	string The status of the dashboard creation request.
lastPublishedTime Optional	string The last time that this dashboard was published.
lastUpdatedTime Optional	string The last time that this dashboard was updated.
versionARN Optional	string The ARN of the dashboard, including the version number of the first version that is created.
versionNumber Optional	integer Version number for this version of the dashboard.
versionStatus Optional	string The resource status of the dashboard version. Possible values are CREATION_IN_PROGRESS, CREATION_SUCCESSFUL, CREATION_FAILED, UPDATE_IN_PROGRESS, UPDATE_SUCCESSFUL, UPDATE_FAILED, or DELETED. The resource is considered synced when the status is CREATION_SUCCESSFUL or UPDATE_SUCCESSFUL.

Dashboard

Metadata#

Spec#

Status#

Metadata

Spec

Status