interface DashboardVersionProperty
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.QuickSight.CfnDashboard.DashboardVersionProperty |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnDashboard_DashboardVersionProperty |
![]() | software.amazon.awscdk.services.quicksight.CfnDashboard.DashboardVersionProperty |
![]() | aws_cdk.aws_quicksight.CfnDashboard.DashboardVersionProperty |
![]() | aws-cdk-lib » aws_quicksight » CfnDashboard » DashboardVersionProperty |
Dashboard version.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_quicksight as quicksight } from 'aws-cdk-lib';
const dashboardVersionProperty: quicksight.CfnDashboard.DashboardVersionProperty = {
arn: 'arn',
createdTime: 'createdTime',
dataSetArns: ['dataSetArns'],
description: 'description',
errors: [{
message: 'message',
type: 'type',
violatedEntities: [{
path: 'path',
}],
}],
sheets: [{
images: [{
sheetImageId: 'sheetImageId',
source: {
sheetImageStaticFileSource: {
staticFileId: 'staticFileId',
},
},
// the properties below are optional
actions: [{
actionOperations: [{
navigationOperation: {
localNavigationConfiguration: {
targetSheetId: 'targetSheetId',
},
},
setParametersOperation: {
parameterValueConfigurations: [{
destinationParameterName: 'destinationParameterName',
value: {
customValuesConfiguration: {
customValues: {
dateTimeValues: ['dateTimeValues'],
decimalValues: [123],
integerValues: [123],
stringValues: ['stringValues'],
},
// the properties below are optional
includeNullValue: false,
},
selectAllValueOptions: 'selectAllValueOptions',
sourceColumn: {
columnName: 'columnName',
dataSetIdentifier: 'dataSetIdentifier',
},
sourceField: 'sourceField',
sourceParameterName: 'sourceParameterName',
},
}],
},
urlOperation: {
urlTarget: 'urlTarget',
urlTemplate: 'urlTemplate',
},
}],
customActionId: 'customActionId',
name: 'name',
trigger: 'trigger',
// the properties below are optional
status: 'status',
}],
imageContentAltText: 'imageContentAltText',
interactions: {
imageMenuOption: {
availabilityStatus: 'availabilityStatus',
},
},
scaling: {
scalingType: 'scalingType',
},
tooltip: {
tooltipText: {
plainText: 'plainText',
},
visibility: 'visibility',
},
}],
name: 'name',
sheetId: 'sheetId',
}],
sourceEntityArn: 'sourceEntityArn',
status: 'status',
themeArn: 'themeArn',
versionNumber: 123,
};
Properties
Name | Type | Description |
---|---|---|
arn? | string | The Amazon Resource Name (ARN) of the resource. |
created | string | The time that this dashboard version was created. |
data | string[] | The Amazon Resource Numbers (ARNs) for the datasets that are associated with this version of the dashboard. |
description? | string | Description. |
errors? | IResolvable | IResolvable | Dashboard [] | Errors associated with this dashboard version. |
sheets? | IResolvable | IResolvable | Sheet [] | A list of the associated sheets with the unique identifier and name of each sheet. |
source | string | Source entity ARN. |
status? | string | The HTTP status of the request. |
theme | string | The ARN of the theme associated with a version of the dashboard. |
version | number | Version number for this version of the dashboard. |
arn?
Type:
string
(optional)
The Amazon Resource Name (ARN) of the resource.
createdTime?
Type:
string
(optional)
The time that this dashboard version was created.
dataSetArns?
Type:
string[]
(optional)
The Amazon Resource Numbers (ARNs) for the datasets that are associated with this version of the dashboard.
description?
Type:
string
(optional)
Description.
errors?
Type:
IResolvable
|
IResolvable
|
Dashboard
[]
(optional)
Errors associated with this dashboard version.
sheets?
Type:
IResolvable
|
IResolvable
|
Sheet
[]
(optional)
A list of the associated sheets with the unique identifier and name of each sheet.
sourceEntityArn?
Type:
string
(optional)
Source entity ARN.
status?
Type:
string
(optional)
The HTTP status of the request.
themeArn?
Type:
string
(optional)
The ARN of the theme associated with a version of the dashboard.
versionNumber?
Type:
number
(optional)
Version number for this version of the dashboard.