class CfnDashboard (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.QuickSight.CfnDashboard |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnDashboard |
![]() | software.amazon.awscdk.services.quicksight.CfnDashboard |
![]() | aws_cdk.aws_quicksight.CfnDashboard |
![]() | aws-cdk-lib » aws_quicksight » CfnDashboard |
Implements
IConstruct
, IDependable
, IInspectable
, ITaggable
Creates a dashboard from a template. To first create a template, see the CreateTemplate
API operation.
A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created from analyses. You can share Amazon QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different AWS account .
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dashboard.html
Example
// The generated example for this type would exceed 500 lines,
// and has been elided for readability.
Initializer
new CfnDashboard(scope: Construct, id: string, props: CfnDashboardProps)
Parameters
- scope
Construct
— Scope in which this resource is defined. - id
string
— Construct identifier for this resource (unique in its scope). - props
Cfn
— Resource properties.Dashboard Props
Construct Props
Name | Type | Description |
---|---|---|
aws | string | The ID of the AWS account where you want to create the dashboard. |
dashboard | string | The ID for the dashboard, also added to the IAM policy. |
name | string | The display name of the dashboard. |
dashboard | IResolvable | Dashboard | Options for publishing the dashboard when you create it:. |
definition? | IResolvable | Dashboard | |
folder | string[] | |
link | string[] | A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard. |
link | IResolvable | Link | A structure that contains the link sharing configurations that you want to apply overrides to. |
parameters? | IResolvable | Parameters | The parameters for the creation of the dashboard, which you want to use to override the default settings. |
permissions? | IResolvable | IResolvable | Resource [] | A structure that contains the permissions of the dashboard. |
source | IResolvable | Dashboard | The entity that you are using as a source when you create the dashboard. |
tags? | Cfn [] | Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard. |
theme | string | The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. |
validation | IResolvable | Validation | The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. |
version | string | A description for the first version of the dashboard being created. |
awsAccountId
Type:
string
The ID of the AWS account where you want to create the dashboard.
dashboardId
Type:
string
The ID for the dashboard, also added to the IAM policy.
name
Type:
string
The display name of the dashboard.
dashboardPublishOptions?
Type:
IResolvable
|
Dashboard
(optional)
Options for publishing the dashboard when you create it:.
AvailabilityStatus
forAdHocFilteringOption
- This status can be eitherENABLED
orDISABLED
. When this is set toDISABLED
, Amazon QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option isENABLED
by default.AvailabilityStatus
forExportToCSVOption
- This status can be eitherENABLED
orDISABLED
. The visual option to export data to .CSV format isn't enabled when this is set toDISABLED
. This option isENABLED
by default.VisibilityState
forSheetControlsOption
- This visibility state can be eitherCOLLAPSED
orEXPANDED
. This option isCOLLAPSED
by default.
definition?
Type:
IResolvable
|
Dashboard
(optional)
folderArns?
Type:
string[]
(optional)
linkEntities?
Type:
string[]
(optional)
A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.
linkSharingConfiguration?
Type:
IResolvable
|
Link
(optional)
A structure that contains the link sharing configurations that you want to apply overrides to.
parameters?
Type:
IResolvable
|
Parameters
(optional)
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.
permissions?
Type:
IResolvable
|
IResolvable
|
Resource
[]
(optional)
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.
sourceEntity?
Type:
IResolvable
|
Dashboard
(optional)
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.
tags?
Type:
Cfn
[]
(optional)
Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
themeArn?
Type:
string
(optional)
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.
validationStrategy?
Type:
IResolvable
|
Validation
(optional)
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.
versionDescription?
Type:
string
(optional)
A description for the first version of the dashboard being created.
Properties
Name | Type | Description |
---|---|---|
attr | string | The Amazon Resource Name (ARN) of the dashboard. |
attr | string | The time this dashboard version was created. |
attr | string | The time that the dashboard was last published. |
attr | string | The time that the dashboard was last updated. |
attr | IResolvable | Dashboard version. . |
attr | string | |
attr | string | |
attr | string[] | |
attr | string | |
attr | IResolvable | |
attr | IResolvable | |
attr | string | |
attr | string | |
attr | string | |
attr | IResolvable | |
aws | string | The ID of the AWS account where you want to create the dashboard. |
cfn | ICfn | Options for this resource, such as condition, update policy etc. |
cfn | { [string]: any } | |
cfn | string | AWS resource type. |
creation | string[] | |
dashboard | string | The ID for the dashboard, also added to the IAM policy. |
logical | string | The logical ID for this CloudFormation stack element. |
name | string | The display name of the dashboard. |
node | Node | The tree node. |
ref | string | Return a string that will be resolved to a CloudFormation { Ref } for this element. |
stack | Stack | The stack in which this element is defined. |
tags | Tag | Tag Manager which manages the tags for this resource. |
dashboard | IResolvable | Dashboard | Options for publishing the dashboard when you create it:. |
definition? | IResolvable | Dashboard | |
folder | string[] | |
link | string[] | A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard. |
link | IResolvable | Link | A structure that contains the link sharing configurations that you want to apply overrides to. |
parameters? | IResolvable | Parameters | The parameters for the creation of the dashboard, which you want to use to override the default settings. |
permissions? | IResolvable | IResolvable | Resource [] | A structure that contains the permissions of the dashboard. |
source | IResolvable | Dashboard | The entity that you are using as a source when you create the dashboard. |
tags | Cfn [] | Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard. |
theme | string | The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. |
validation | IResolvable | Validation | The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. |
version | string | A description for the first version of the dashboard being created. |
static CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. |
attrArn
Type:
string
The Amazon Resource Name (ARN) of the dashboard.
attrCreatedTime
Type:
string
The time this dashboard version was created.
attrLastPublishedTime
Type:
string
The time that the dashboard was last published.
attrLastUpdatedTime
Type:
string
The time that the dashboard was last updated.
attrVersion
Type:
IResolvable
<p>Dashboard version.
.attrVersionArn
Type:
string
attrVersionCreatedTime
Type:
string
attrVersionDataSetArns
Type:
string[]
attrVersionDescription
Type:
string
attrVersionErrors
Type:
IResolvable
attrVersionSheets
Type:
IResolvable
attrVersionSourceEntityArn
Type:
string
attrVersionStatus
Type:
string
attrVersionThemeArn
Type:
string
attrVersionVersionNumber
Type:
IResolvable
awsAccountId
Type:
string
The ID of the AWS account where you want to create the dashboard.
cfnOptions
Type:
ICfn
Options for this resource, such as condition, update policy etc.
cfnProperties
Type:
{ [string]: any }
cfnResourceType
Type:
string
AWS resource type.
creationStack
Type:
string[]
dashboardId
Type:
string
The ID for the dashboard, also added to the IAM policy.
logicalId
Type:
string
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use overrideLogicalId(newLogicalId)
.
name
Type:
string
The display name of the dashboard.
node
Type:
Node
The tree node.
ref
Type:
string
Return a string that will be resolved to a CloudFormation { Ref }
for this element.
If, by any chance, the intrinsic reference of a resource is not a string, you could
coerce it to an IResolvable through Lazy.any({ produce: resource.ref })
.
stack
Type:
Stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
tags
Type:
Tag
Tag Manager which manages the tags for this resource.
dashboardPublishOptions?
Type:
IResolvable
|
Dashboard
(optional)
Options for publishing the dashboard when you create it:.
definition?
Type:
IResolvable
|
Dashboard
(optional)
folderArns?
Type:
string[]
(optional)
linkEntities?
Type:
string[]
(optional)
A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.
linkSharingConfiguration?
Type:
IResolvable
|
Link
(optional)
A structure that contains the link sharing configurations that you want to apply overrides to.
parameters?
Type:
IResolvable
|
Parameters
(optional)
The parameters for the creation of the dashboard, which you want to use to override the default settings.
permissions?
Type:
IResolvable
|
IResolvable
|
Resource
[]
(optional)
A structure that contains the permissions of the dashboard.
sourceEntity?
Type:
IResolvable
|
Dashboard
(optional)
The entity that you are using as a source when you create the dashboard.
tagsRaw?
Type:
Cfn
[]
(optional)
Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
themeArn?
Type:
string
(optional)
The Amazon Resource Name (ARN) of the theme that is being used for this dashboard.
validationStrategy?
Type:
IResolvable
|
Validation
(optional)
The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects.
versionDescription?
Type:
string
(optional)
A description for the first version of the dashboard being created.
static CFN_RESOURCE_TYPE_NAME
Type:
string
The CloudFormation resource type name for this resource class.
Methods
Name | Description |
---|---|
add | Syntactic sugar for addOverride(path, undefined) . |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Add a value to the CloudFormation Resource Metadata. |
add | Adds an override to the synthesized CloudFormation resource. |
add | Adds an override that deletes the value of a property from the resource definition. |
add | Adds an override to a resource property. |
apply | Sets the deletion policy of the resource based on the removal policy specified. |
get | Returns a token for an runtime attribute of this resource. |
get | Retrieve a value value from the CloudFormation Resource Metadata. |
inspect(inspector) | Examines the CloudFormation resource and discloses attributes. |
obtain | Retrieves an array of resources this resource depends on. |
obtain | Get a shallow copy of dependencies between this resource and other resources in the same stack. |
override | Overrides the auto-generated logical ID with a specific ID. |
remove | Indicates that this resource no longer depends on another resource. |
replace | Replaces one dependency with another. |
to | Returns a string representation of this construct. |
protected render |
addDeletionOverride(path)
public addDeletionOverride(path: string): void
Parameters
- path
string
— The path of the value to delete.
Syntactic sugar for addOverride(path, undefined)
.
addDependency(target)
public addDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
addDependsOn(target)
public addDependsOn(target: CfnResource): void
⚠️ Deprecated: use addDependency
Parameters
- target
Cfn
Resource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)
public addMetadata(key: string, value: any): void
Parameters
- key
string
- value
any
Add a value to the CloudFormation Resource Metadata.
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)
addOverride(path, value)
public addOverride(path: string, value: any): void
Parameters
- path
string
— - The path of the property, you can use dot notation to override values in complex types. - value
any
— - The value.
Adds an override to the synthesized CloudFormation resource.
To add a
property override, either use addPropertyOverride
or prefix path
with
"Properties." (i.e. Properties.TopicName
).
If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal .
in the property name, prefix with a \
. In most
programming languages you will need to write this as "\\."
because the
\
itself will need to be escaped.
For example,
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
would add the overrides
"Properties": {
"GlobalSecondaryIndexes": [
{
"Projection": {
"NonKeyAttributes": [ "myattribute" ]
...
}
...
},
{
"ProjectionType": "INCLUDE"
...
},
]
...
}
The value
argument to addOverride
will not be processed or translated
in any way. Pass raw JSON values in here with the correct capitalization
for CloudFormation. If you pass CDK classes or structs, they will be
rendered with lowercased key names, and CloudFormation will reject the
template.
addPropertyDeletionOverride(propertyPath)
public addPropertyDeletionOverride(propertyPath: string): void
Parameters
- propertyPath
string
— The path to the property.
Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)
public addPropertyOverride(propertyPath: string, value: any): void
Parameters
- propertyPath
string
— The path of the property. - value
any
— The value.
Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value)
.
applyRemovalPolicy(policy?, options?)
public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void
Parameters
- policy
Removal
Policy - options
Removal
Policy Options
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY
), or left in your AWS
account for data recovery and cleanup later (RemovalPolicy.RETAIN
). In some
cases, a snapshot can be taken of the resource prior to deletion
(RemovalPolicy.SNAPSHOT
). A list of resources that support this policy
can be found in the following link:
getAtt(attributeName, typeHint?)
public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference
Parameters
- attributeName
string
— The name of the attribute. - typeHint
Resolution
Type Hint
Returns
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn
), but this can be used for future compatibility
in case there is no generated attribute.
getMetadata(key)
public getMetadata(key: string): any
Parameters
- key
string
Returns
any
Retrieve a value value from the CloudFormation Resource Metadata.
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)
inspect(inspector)
public inspect(inspector: TreeInspector): void
Parameters
- inspector
Tree
— tree inspector to collect and process attributes.Inspector
Examines the CloudFormation resource and discloses attributes.
obtainDependencies()
public obtainDependencies(): Stack | CfnResource[]
Returns
Stack
|
Cfn
Resource []
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
obtainResourceDependencies()
public obtainResourceDependencies(): CfnResource[]
Returns
Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)
public overrideLogicalId(newLogicalId: string): void
Parameters
- newLogicalId
string
— The new logical ID to use for this stack element.
Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)
public removeDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
replaceDependency(target, newTarget)
public replaceDependency(target: CfnResource, newTarget: CfnResource): void
Parameters
- target
Cfn
— The dependency to replace.Resource - newTarget
Cfn
— The new dependency to add.Resource
Replaces one dependency with another.
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.
protected renderProperties(props)
protected renderProperties(props: { [string]: any }): { [string]: any }
Parameters
- props
{ [string]: any }
Returns
{ [string]: any }