AWS Native
Pulumi Official

Package maintained by Pulumiv0.19.0 published on Wednesday, Jun 8, 2022 by Pulumi
Dashboard
Definition of the AWS::QuickSight::Dashboard Resource Type.
Create a Dashboard Resource
new Dashboard(name: string, args: DashboardArgs, opts?: CustomResourceOptions);
@overload
def Dashboard(resource_name: str,
opts: Optional[ResourceOptions] = None,
aws_account_id: Optional[str] = None,
dashboard_id: Optional[str] = None,
dashboard_publish_options: Optional[DashboardPublishOptionsArgs] = None,
name: Optional[str] = None,
parameters: Optional[DashboardParametersArgs] = None,
permissions: Optional[Sequence[DashboardResourcePermissionArgs]] = None,
source_entity: Optional[DashboardSourceEntityArgs] = None,
tags: Optional[Sequence[DashboardTagArgs]] = None,
theme_arn: Optional[str] = None,
version_description: Optional[str] = None)
@overload
def Dashboard(resource_name: str,
args: DashboardArgs,
opts: Optional[ResourceOptions] = None)
func NewDashboard(ctx *Context, name string, args DashboardArgs, opts ...ResourceOption) (*Dashboard, error)
public Dashboard(string name, DashboardArgs args, CustomResourceOptions? opts = null)
public Dashboard(String name, DashboardArgs args)
public Dashboard(String name, DashboardArgs args, CustomResourceOptions options)
type: aws-native:quicksight:Dashboard
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DashboardArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args DashboardArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args DashboardArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DashboardArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DashboardArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Dashboard Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Dashboard resource accepts the following input properties:
- Aws
Account stringId - Dashboard
Id string - Source
Entity Pulumi.Aws Native. Quick Sight. Inputs. Dashboard Source Entity Args - Dashboard
Publish Pulumi.Options Aws Native. Quick Sight. Inputs. Dashboard Publish Options Args - Name string
- Parameters
Pulumi.
Aws Native. Quick Sight. Inputs. Dashboard Parameters Args - Permissions
List<Pulumi.
Aws Native. Quick Sight. Inputs. Dashboard Resource Permission Args> <p>To specify no permissions, omit the permissions list.</p>
- List<Pulumi.
Aws Native. Quick Sight. Inputs. Dashboard Tag Args> - Theme
Arn string - Version
Description string
- Aws
Account stringId - Dashboard
Id string - Source
Entity DashboardSource Entity Args - Dashboard
Publish DashboardOptions Publish Options Args - Name string
- Parameters
Dashboard
Parameters Args - Permissions
[]Dashboard
Resource Permission Args <p>To specify no permissions, omit the permissions list.</p>
- []Dashboard
Tag Args - Theme
Arn string - Version
Description string
- aws
Account StringId - dashboard
Id String - source
Entity DashboardSource Entity Args - dashboard
Publish DashboardOptions Publish Options Args - name String
- parameters
Dashboard
Parameters Args - permissions
List<Dashboard
Resource Permission Args> <p>To specify no permissions, omit the permissions list.</p>
- List<Dashboard
Tag Args> - theme
Arn String - version
Description String
- aws
Account stringId - dashboard
Id string - source
Entity DashboardSource Entity Args - dashboard
Publish DashboardOptions Publish Options Args - name string
- parameters
Dashboard
Parameters Args - permissions
Dashboard
Resource Permission Args[] <p>To specify no permissions, omit the permissions list.</p>
- Dashboard
Tag Args[] - theme
Arn string - version
Description string
- aws_
account_ strid - dashboard_
id str - source_
entity DashboardSource Entity Args - dashboard_
publish_ Dashboardoptions Publish Options Args - name str
- parameters
Dashboard
Parameters Args - permissions
Sequence[Dashboard
Resource Permission Args] <p>To specify no permissions, omit the permissions list.</p>
- Sequence[Dashboard
Tag Args] - theme_
arn str - version_
description str
- aws
Account StringId - dashboard
Id String - source
Entity Property Map - dashboard
Publish Property MapOptions - name String
- parameters Property Map
- permissions List<Property Map>
<p>To specify no permissions, omit the permissions list.</p>
- List<Property Map>
- theme
Arn String - version
Description String
Outputs
All input properties are implicitly available as output properties. Additionally, the Dashboard resource produces the following output properties:
- Arn string
- Created
Time string - Id string
The provider-assigned unique ID for this managed resource.
- Last
Published stringTime - Last
Updated stringTime - Version
Pulumi.
Aws Native. Quick Sight. Outputs. Dashboard Version
- Arn string
- Created
Time string - Id string
The provider-assigned unique ID for this managed resource.
- Last
Published stringTime - Last
Updated stringTime - Version
Dashboard
Version
- arn String
- created
Time String - id String
The provider-assigned unique ID for this managed resource.
- last
Published StringTime - last
Updated StringTime - version
Dashboard
Version
- arn string
- created
Time string - id string
The provider-assigned unique ID for this managed resource.
- last
Published stringTime - last
Updated stringTime - version
Dashboard
Version
- arn str
- created_
time str - id str
The provider-assigned unique ID for this managed resource.
- last_
published_ strtime - last_
updated_ strtime - version
Dashboard
Version
- arn String
- created
Time String - id String
The provider-assigned unique ID for this managed resource.
- last
Published StringTime - last
Updated StringTime - version Property Map
Supporting Types
DashboardAdHocFilteringOption
DashboardBehavior
- Enabled
- ENABLED
- Disabled
- DISABLED
- Dashboard
Behavior Enabled - ENABLED
- Dashboard
Behavior Disabled - DISABLED
- Enabled
- ENABLED
- Disabled
- DISABLED
- Enabled
- ENABLED
- Disabled
- DISABLED
- ENABLED
- ENABLED
- DISABLED
- DISABLED
- "ENABLED"
- ENABLED
- "DISABLED"
- DISABLED
DashboardDataSetReference
- Data
Set stringArn - Data
Set stringPlaceholder
- Data
Set stringArn - Data
Set stringPlaceholder
- data
Set StringArn - data
Set StringPlaceholder
- data
Set stringArn - data
Set stringPlaceholder
- data_
set_ strarn - data_
set_ strplaceholder
- data
Set StringArn - data
Set StringPlaceholder
DashboardDateTimeParameter
DashboardDecimalParameter
DashboardError
- Message string
- Type
Dashboard
Error Type
- message String
- type
Dashboard
Error Type
- message string
- type
Dashboard
Error Type
DashboardErrorType
- Access
Denied - ACCESS_DENIED
- Source
Not Found - SOURCE_NOT_FOUND
- Data
Set Not Found - DATA_SET_NOT_FOUND
- Internal
Failure - INTERNAL_FAILURE
- Parameter
Value Incompatible - PARAMETER_VALUE_INCOMPATIBLE
- Parameter
Type Invalid - PARAMETER_TYPE_INVALID
- Parameter
Not Found - PARAMETER_NOT_FOUND
- Column
Type Mismatch - COLUMN_TYPE_MISMATCH
- Column
Geographic Role Mismatch - COLUMN_GEOGRAPHIC_ROLE_MISMATCH
- Column
Replacement Missing - COLUMN_REPLACEMENT_MISSING
- Dashboard
Error Type Access Denied - ACCESS_DENIED
- Dashboard
Error Type Source Not Found - SOURCE_NOT_FOUND
- Dashboard
Error Type Data Set Not Found - DATA_SET_NOT_FOUND
- Dashboard
Error Type Internal Failure - INTERNAL_FAILURE
- Dashboard
Error Type Parameter Value Incompatible - PARAMETER_VALUE_INCOMPATIBLE
- Dashboard
Error Type Parameter Type Invalid - PARAMETER_TYPE_INVALID
- Dashboard
Error Type Parameter Not Found - PARAMETER_NOT_FOUND
- Dashboard
Error Type Column Type Mismatch - COLUMN_TYPE_MISMATCH
- Dashboard
Error Type Column Geographic Role Mismatch - COLUMN_GEOGRAPHIC_ROLE_MISMATCH
- Dashboard
Error Type Column Replacement Missing - COLUMN_REPLACEMENT_MISSING
- Access
Denied - ACCESS_DENIED
- Source
Not Found - SOURCE_NOT_FOUND
- Data
Set Not Found - DATA_SET_NOT_FOUND
- Internal
Failure - INTERNAL_FAILURE
- Parameter
Value Incompatible - PARAMETER_VALUE_INCOMPATIBLE
- Parameter
Type Invalid - PARAMETER_TYPE_INVALID
- Parameter
Not Found - PARAMETER_NOT_FOUND
- Column
Type Mismatch - COLUMN_TYPE_MISMATCH
- Column
Geographic Role Mismatch - COLUMN_GEOGRAPHIC_ROLE_MISMATCH
- Column
Replacement Missing - COLUMN_REPLACEMENT_MISSING
- Access
Denied - ACCESS_DENIED
- Source
Not Found - SOURCE_NOT_FOUND
- Data
Set Not Found - DATA_SET_NOT_FOUND
- Internal
Failure - INTERNAL_FAILURE
- Parameter
Value Incompatible - PARAMETER_VALUE_INCOMPATIBLE
- Parameter
Type Invalid - PARAMETER_TYPE_INVALID
- Parameter
Not Found - PARAMETER_NOT_FOUND
- Column
Type Mismatch - COLUMN_TYPE_MISMATCH
- Column
Geographic Role Mismatch - COLUMN_GEOGRAPHIC_ROLE_MISMATCH
- Column
Replacement Missing - COLUMN_REPLACEMENT_MISSING
- ACCESS_DENIED
- ACCESS_DENIED
- SOURCE_NOT_FOUND
- SOURCE_NOT_FOUND
- DATA_SET_NOT_FOUND
- DATA_SET_NOT_FOUND
- INTERNAL_FAILURE
- INTERNAL_FAILURE
- PARAMETER_VALUE_INCOMPATIBLE
- PARAMETER_VALUE_INCOMPATIBLE
- PARAMETER_TYPE_INVALID
- PARAMETER_TYPE_INVALID
- PARAMETER_NOT_FOUND
- PARAMETER_NOT_FOUND
- COLUMN_TYPE_MISMATCH
- COLUMN_TYPE_MISMATCH
- COLUMN_GEOGRAPHIC_ROLE_MISMATCH
- COLUMN_GEOGRAPHIC_ROLE_MISMATCH
- COLUMN_REPLACEMENT_MISSING
- COLUMN_REPLACEMENT_MISSING
- "ACCESS_DENIED"
- ACCESS_DENIED
- "SOURCE_NOT_FOUND"
- SOURCE_NOT_FOUND
- "DATA_SET_NOT_FOUND"
- DATA_SET_NOT_FOUND
- "INTERNAL_FAILURE"
- INTERNAL_FAILURE
- "PARAMETER_VALUE_INCOMPATIBLE"
- PARAMETER_VALUE_INCOMPATIBLE
- "PARAMETER_TYPE_INVALID"
- PARAMETER_TYPE_INVALID
- "PARAMETER_NOT_FOUND"
- PARAMETER_NOT_FOUND
- "COLUMN_TYPE_MISMATCH"
- COLUMN_TYPE_MISMATCH
- "COLUMN_GEOGRAPHIC_ROLE_MISMATCH"
- COLUMN_GEOGRAPHIC_ROLE_MISMATCH
- "COLUMN_REPLACEMENT_MISSING"
- COLUMN_REPLACEMENT_MISSING
DashboardExportToCSVOption
DashboardIntegerParameter
DashboardParameters
- Date
Time List<Pulumi.Parameters Aws Native. Quick Sight. Inputs. Dashboard Date Time Parameter> - Decimal
Parameters List<Pulumi.Aws Native. Quick Sight. Inputs. Dashboard Decimal Parameter> - Integer
Parameters List<Pulumi.Aws Native. Quick Sight. Inputs. Dashboard Integer Parameter> - String
Parameters List<Pulumi.Aws Native. Quick Sight. Inputs. Dashboard String Parameter>
DashboardPublishOptions
DashboardResourcePermission
DashboardResourceStatus
- Creation
In Progress - CREATION_IN_PROGRESS
- Creation
Successful - CREATION_SUCCESSFUL
- Creation
Failed - CREATION_FAILED
- Update
In Progress - UPDATE_IN_PROGRESS
- Update
Successful - UPDATE_SUCCESSFUL
- Update
Failed - UPDATE_FAILED
- Deleted
- DELETED
- Dashboard
Resource Status Creation In Progress - CREATION_IN_PROGRESS
- Dashboard
Resource Status Creation Successful - CREATION_SUCCESSFUL
- Dashboard
Resource Status Creation Failed - CREATION_FAILED
- Dashboard
Resource Status Update In Progress - UPDATE_IN_PROGRESS
- Dashboard
Resource Status Update Successful - UPDATE_SUCCESSFUL
- Dashboard
Resource Status Update Failed - UPDATE_FAILED
- Dashboard
Resource Status Deleted - DELETED
- Creation
In Progress - CREATION_IN_PROGRESS
- Creation
Successful - CREATION_SUCCESSFUL
- Creation
Failed - CREATION_FAILED
- Update
In Progress - UPDATE_IN_PROGRESS
- Update
Successful - UPDATE_SUCCESSFUL
- Update
Failed - UPDATE_FAILED
- Deleted
- DELETED
- Creation
In Progress - CREATION_IN_PROGRESS
- Creation
Successful - CREATION_SUCCESSFUL
- Creation
Failed - CREATION_FAILED
- Update
In Progress - UPDATE_IN_PROGRESS
- Update
Successful - UPDATE_SUCCESSFUL
- Update
Failed - UPDATE_FAILED
- Deleted
- DELETED
- CREATION_IN_PROGRESS
- CREATION_IN_PROGRESS
- CREATION_SUCCESSFUL
- CREATION_SUCCESSFUL
- CREATION_FAILED
- CREATION_FAILED
- UPDATE_IN_PROGRESS
- UPDATE_IN_PROGRESS
- UPDATE_SUCCESSFUL
- UPDATE_SUCCESSFUL
- UPDATE_FAILED
- UPDATE_FAILED
- DELETED
- DELETED
- "CREATION_IN_PROGRESS"
- CREATION_IN_PROGRESS
- "CREATION_SUCCESSFUL"
- CREATION_SUCCESSFUL
- "CREATION_FAILED"
- CREATION_FAILED
- "UPDATE_IN_PROGRESS"
- UPDATE_IN_PROGRESS
- "UPDATE_SUCCESSFUL"
- UPDATE_SUCCESSFUL
- "UPDATE_FAILED"
- UPDATE_FAILED
- "DELETED"
- DELETED
DashboardSheet
DashboardSheetControlsOption
DashboardSourceEntity
DashboardSourceTemplate
DashboardStringParameter
DashboardTag
DashboardUIState
- Expanded
- EXPANDED
- Collapsed
- COLLAPSED
- Dashboard
UIState Expanded - EXPANDED
- Dashboard
UIState Collapsed - COLLAPSED
- Expanded
- EXPANDED
- Collapsed
- COLLAPSED
- Expanded
- EXPANDED
- Collapsed
- COLLAPSED
- EXPANDED
- EXPANDED
- COLLAPSED
- COLLAPSED
- "EXPANDED"
- EXPANDED
- "COLLAPSED"
- COLLAPSED
DashboardVersion
- Arn string
- Created
Time string - Data
Set List<string>Arns - Description string
- Errors
List<Pulumi.
Aws Native. Quick Sight. Inputs. Dashboard Error> - Sheets
List<Pulumi.
Aws Native. Quick Sight. Inputs. Dashboard Sheet> - Source
Entity stringArn - Status
Pulumi.
Aws Native. Quick Sight. Dashboard Resource Status - Theme
Arn string - Version
Number double
- Arn string
- Created
Time string - Data
Set []stringArns - Description string
- Errors
[]Dashboard
Error - Sheets
[]Dashboard
Sheet - Source
Entity stringArn - Status
Dashboard
Resource Status - Theme
Arn string - Version
Number float64
- arn String
- created
Time String - data
Set List<String>Arns - description String
- errors
List<Dashboard
Error> - sheets
List<Dashboard
Sheet> - source
Entity StringArn - status
Dashboard
Resource Status - theme
Arn String - version
Number Double
- arn string
- created
Time string - data
Set string[]Arns - description string
- errors
Dashboard
Error[] - sheets
Dashboard
Sheet[] - source
Entity stringArn - status
Dashboard
Resource Status - theme
Arn string - version
Number number
- arn str
- created_
time str - data_
set_ Sequence[str]arns - description str
- errors
Sequence[Dashboard
Error] - sheets
Sequence[Dashboard
Sheet] - source_
entity_ strarn - status
Dashboard
Resource Status - theme_
arn str - version_
number float
- arn String
- created
Time String - data
Set List<String>Arns - description String
- errors List<Property Map>
- sheets List<Property Map>
- source
Entity StringArn - status "CREATION_IN_PROGRESS" | "CREATION_SUCCESSFUL" | "CREATION_FAILED" | "UPDATE_IN_PROGRESS" | "UPDATE_SUCCESSFUL" | "UPDATE_FAILED" | "DELETED"
- theme
Arn String - version
Number Number
Package Details
- Repository
- https://github.com/pulumi/pulumi-aws-native
- License
- Apache-2.0