awsquicksight

package
v2.15.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 1, 2022 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CfnAnalysis_CFN_RESOURCE_TYPE_NAME 

func CfnAnalysis_CFN_RESOURCE_TYPE_NAME() *string

func CfnAnalysis_IsCfnElement 

func CfnAnalysis_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnAnalysis_IsCfnResource 

func CfnAnalysis_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnAnalysis_IsConstruct 

func CfnAnalysis_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnDashboard_CFN_RESOURCE_TYPE_NAME 

func CfnDashboard_CFN_RESOURCE_TYPE_NAME() *string

func CfnDashboard_IsCfnElement 

func CfnDashboard_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnDashboard_IsCfnResource 

func CfnDashboard_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnDashboard_IsConstruct 

func CfnDashboard_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnDataSet_CFN_RESOURCE_TYPE_NAME 

func CfnDataSet_CFN_RESOURCE_TYPE_NAME() *string

func CfnDataSet_IsCfnElement 

func CfnDataSet_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnDataSet_IsCfnResource 

func CfnDataSet_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnDataSet_IsConstruct 

func CfnDataSet_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnDataSource_CFN_RESOURCE_TYPE_NAME 

func CfnDataSource_CFN_RESOURCE_TYPE_NAME() *string

func CfnDataSource_IsCfnElement 

func CfnDataSource_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnDataSource_IsCfnResource 

func CfnDataSource_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnDataSource_IsConstruct 

func CfnDataSource_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnTemplate_CFN_RESOURCE_TYPE_NAME 

func CfnTemplate_CFN_RESOURCE_TYPE_NAME() *string

func CfnTemplate_IsCfnElement 

func CfnTemplate_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnTemplate_IsCfnResource 

func CfnTemplate_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnTemplate_IsConstruct 

func CfnTemplate_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnTheme_CFN_RESOURCE_TYPE_NAME 

func CfnTheme_CFN_RESOURCE_TYPE_NAME() *string

func CfnTheme_IsCfnElement 

func CfnTheme_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnTheme_IsCfnResource 

func CfnTheme_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnTheme_IsConstruct 

func CfnTheme_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func NewCfnAnalysis_Override 

func NewCfnAnalysis_Override(c CfnAnalysis, scope constructs.Construct, id *string, props *CfnAnalysisProps)

Create a new `AWS::QuickSight::Analysis`.

func NewCfnDashboard_Override 

func NewCfnDashboard_Override(c CfnDashboard, scope constructs.Construct, id *string, props *CfnDashboardProps)

Create a new `AWS::QuickSight::Dashboard`.

func NewCfnDataSet_Override 

func NewCfnDataSet_Override(c CfnDataSet, scope constructs.Construct, id *string, props *CfnDataSetProps)

Create a new `AWS::QuickSight::DataSet`.

func NewCfnDataSource_Override 

func NewCfnDataSource_Override(c CfnDataSource, scope constructs.Construct, id *string, props *CfnDataSourceProps)

Create a new `AWS::QuickSight::DataSource`.

func NewCfnTemplate_Override 

func NewCfnTemplate_Override(c CfnTemplate, scope constructs.Construct, id *string, props *CfnTemplateProps)

Create a new `AWS::QuickSight::Template`.

func NewCfnTheme_Override 

func NewCfnTheme_Override(c CfnTheme, scope constructs.Construct, id *string, props *CfnThemeProps)

Create a new `AWS::QuickSight::Theme`.

Types

type CfnAnalysis 

type CfnAnalysis interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AnalysisId() *string
	SetAnalysisId(val *string)
	AttrArn() *string
	AttrCreatedTime() *string
	AttrDataSetArns() *[]*string
	AttrLastUpdatedTime() *string
	AttrSheets() awscdk.IResolvable
	AttrStatus() *string
	AwsAccountId() *string
	SetAwsAccountId(val *string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Errors() interface{}
	SetErrors(val interface{})
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() constructs.Node
	Parameters() interface{}
	SetParameters(val interface{})
	Permissions() interface{}
	SetPermissions(val interface{})
	Ref() *string
	SourceEntity() interface{}
	SetSourceEntity(val interface{})
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	ThemeArn() *string
	SetThemeArn(val *string)
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::QuickSight::Analysis`.

Creates an analysis in Amazon QuickSight.

TODO: EXAMPLE

func NewCfnAnalysis 

func NewCfnAnalysis(scope constructs.Construct, id *string, props *CfnAnalysisProps) CfnAnalysis

Create a new `AWS::QuickSight::Analysis`.

type CfnAnalysisProps 

type CfnAnalysisProps struct {
	// The ID for the analysis that you're creating.
	//
	// This ID displays in the URL of the analysis.
	AnalysisId *string `json:"analysisId" yaml:"analysisId"`
	// The ID of the AWS account where you are creating an analysis.
	AwsAccountId *string `json:"awsAccountId" yaml:"awsAccountId"`
	// A source entity to use for the analysis that you're creating.
	//
	// This metadata structure contains details that describe a source template and one or more datasets.
	SourceEntity interface{} `json:"sourceEntity" yaml:"sourceEntity"`
	// `AWS::QuickSight::Analysis.Errors`.
	Errors interface{} `json:"errors" yaml:"errors"`
	// A descriptive name for the analysis that you're creating.
	//
	// This name displays for the analysis in the Amazon QuickSight console.
	Name *string `json:"name" yaml:"name"`
	// The parameter names and override values that you want to use.
	//
	// An analysis can have any parameter type, and some parameters might accept multiple values.
	Parameters interface{} `json:"parameters" yaml:"parameters"`
	// A structure that describes the principals and the resource-level permissions on an analysis.
	//
	// You can use the `Permissions` structure to grant permissions by providing a list of AWS Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN).
	//
	// To specify no permissions, omit `Permissions` .
	Permissions interface{} `json:"permissions" yaml:"permissions"`
	// Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
	// The ARN for the theme to apply to the analysis that you're creating.
	//
	// To see the theme in the Amazon QuickSight console, make sure that you have access to it.
	ThemeArn *string `json:"themeArn" yaml:"themeArn"`
}

Properties for defining a `CfnAnalysis`.

TODO: EXAMPLE

type CfnAnalysis_AnalysisErrorProperty 

type CfnAnalysis_AnalysisErrorProperty struct {
	// The message associated with the analysis error.
	Message *string `json:"message" yaml:"message"`
	// The type of the analysis error.
	Type *string `json:"type" yaml:"type"`
}

Analysis error.

TODO: EXAMPLE

type CfnAnalysis_AnalysisSourceEntityProperty 

type CfnAnalysis_AnalysisSourceEntityProperty struct {
	// The source template for the source entity of the analysis.
	SourceTemplate interface{} `json:"sourceTemplate" yaml:"sourceTemplate"`
}

The source entity of an analysis.

TODO: EXAMPLE

type CfnAnalysis_AnalysisSourceTemplateProperty 

type CfnAnalysis_AnalysisSourceTemplateProperty struct {
	// The Amazon Resource Name (ARN) of the source template of an analysis.
	Arn *string `json:"arn" yaml:"arn"`
	// The dataset references of the source template of an analysis.
	DataSetReferences interface{} `json:"dataSetReferences" yaml:"dataSetReferences"`
}

The source template of an analysis.

TODO: EXAMPLE

type CfnAnalysis_DataSetReferenceProperty 

type CfnAnalysis_DataSetReferenceProperty struct {
	// Dataset Amazon Resource Name (ARN).
	DataSetArn *string `json:"dataSetArn" yaml:"dataSetArn"`
	// Dataset placeholder.
	DataSetPlaceholder *string `json:"dataSetPlaceholder" yaml:"dataSetPlaceholder"`
}

Dataset reference.

TODO: EXAMPLE

type CfnAnalysis_DateTimeParameterProperty 

type CfnAnalysis_DateTimeParameterProperty struct {
	// A display name for the date-time parameter.
	Name *string `json:"name" yaml:"name"`
	// The values for the date-time parameter.
	Values *[]*string `json:"values" yaml:"values"`
}

A date-time parameter.

TODO: EXAMPLE

type CfnAnalysis_DecimalParameterProperty 

type CfnAnalysis_DecimalParameterProperty struct {
	// A display name for the decimal parameter.
	Name *string `json:"name" yaml:"name"`
	// The values for the decimal parameter.
	Values interface{} `json:"values" yaml:"values"`
}

A decimal parameter.

TODO: EXAMPLE

type CfnAnalysis_IntegerParameterProperty 

type CfnAnalysis_IntegerParameterProperty struct {
	// The name of the integer parameter.
	Name *string `json:"name" yaml:"name"`
	// The values for the integer parameter.
	Values interface{} `json:"values" yaml:"values"`
}

An integer parameter.

TODO: EXAMPLE

type CfnAnalysis_ParametersProperty 

type CfnAnalysis_ParametersProperty struct {
	// The parameters that have a data type of date-time.
	DateTimeParameters interface{} `json:"dateTimeParameters" yaml:"dateTimeParameters"`
	// The parameters that have a data type of decimal.
	DecimalParameters interface{} `json:"decimalParameters" yaml:"decimalParameters"`
	// The parameters that have a data type of integer.
	IntegerParameters interface{} `json:"integerParameters" yaml:"integerParameters"`
	// The parameters that have a data type of string.
	StringParameters interface{} `json:"stringParameters" yaml:"stringParameters"`
}

A list of Amazon QuickSight parameters and the list's override values.

TODO: EXAMPLE

type CfnAnalysis_ResourcePermissionProperty 

type CfnAnalysis_ResourcePermissionProperty struct {
	// The IAM action to grant or revoke permissions on.
	Actions *[]*string `json:"actions" yaml:"actions"`
	// The Amazon Resource Name (ARN) of the principal. This can be one of the following:.
	//
	// - The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)
	// - The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)
	// - The ARN of an AWS account root: This is an IAM ARN rather than a Amazon QuickSight ARN. Use this option only to share resources (templates) across AWS accounts . (This is less common.)
	Principal *string `json:"principal" yaml:"principal"`
}

Permission for the resource.

TODO: EXAMPLE

type CfnAnalysis_SheetProperty 

type CfnAnalysis_SheetProperty struct {
	// The name of a sheet.
	//
	// This name is displayed on the sheet's tab in the Amazon QuickSight console.
	Name *string `json:"name" yaml:"name"`
	// The unique identifier associated with a sheet.
	SheetId *string `json:"sheetId" yaml:"sheetId"`
}

A *sheet* , which is an object that contains a set of visuals that are viewed together on one page in Amazon QuickSight.

Every analysis and dashboard contains at least one sheet. Each sheet contains at least one visualization widget, for example a chart, pivot table, or narrative insight. Sheets can be associated with other components, such as controls, filters, and so on.

TODO: EXAMPLE

type CfnAnalysis_StringParameterProperty 

type CfnAnalysis_StringParameterProperty struct {
	// A display name for a string parameter.
	Name *string `json:"name" yaml:"name"`
	// The values of a string parameter.
	Values *[]*string `json:"values" yaml:"values"`
}

A string parameter.

TODO: EXAMPLE

type CfnDashboard 

type CfnDashboard interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	AttrCreatedTime() *string
	AttrLastPublishedTime() *string
	AttrLastUpdatedTime() *string
	AwsAccountId() *string
	SetAwsAccountId(val *string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	DashboardId() *string
	SetDashboardId(val *string)
	DashboardPublishOptions() interface{}
	SetDashboardPublishOptions(val interface{})
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() constructs.Node
	Parameters() interface{}
	SetParameters(val interface{})
	Permissions() interface{}
	SetPermissions(val interface{})
	Ref() *string
	SourceEntity() interface{}
	SetSourceEntity(val interface{})
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	ThemeArn() *string
	SetThemeArn(val *string)
	UpdatedProperites() *map[string]interface{}
	VersionDescription() *string
	SetVersionDescription(val *string)
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::QuickSight::Dashboard`.

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 .

TODO: EXAMPLE

func NewCfnDashboard 

func NewCfnDashboard(scope constructs.Construct, id *string, props *CfnDashboardProps) CfnDashboard

Create a new `AWS::QuickSight::Dashboard`.

type CfnDashboardProps 

type CfnDashboardProps struct {
	// The ID of the AWS account where you want to create the dashboard.
	AwsAccountId *string `json:"awsAccountId" yaml:"awsAccountId"`
	// The ID for the dashboard, also added to the IAM policy.
	DashboardId *string `json:"dashboardId" yaml:"dashboardId"`
	// 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.
	SourceEntity interface{} `json:"sourceEntity" yaml:"sourceEntity"`
	// 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 QuickSight 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.
	DashboardPublishOptions interface{} `json:"dashboardPublishOptions" yaml:"dashboardPublishOptions"`
	// The display name of the dashboard.
	Name *string `json:"name" yaml:"name"`
	// 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 interface{} `json:"parameters" yaml:"parameters"`
	// 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 interface{} `json:"permissions" yaml:"permissions"`
	// Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
	// 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.
	ThemeArn *string `json:"themeArn" yaml:"themeArn"`
	// A description for the first version of the dashboard being created.
	VersionDescription *string `json:"versionDescription" yaml:"versionDescription"`
}

Properties for defining a `CfnDashboard`.

TODO: EXAMPLE

type CfnDashboard_AdHocFilteringOptionProperty 

type CfnDashboard_AdHocFilteringOptionProperty struct {
	// Availability status.
	AvailabilityStatus *string `json:"availabilityStatus" yaml:"availabilityStatus"`
}

Ad hoc (one-time) filtering option.

TODO: EXAMPLE

type CfnDashboard_DashboardPublishOptionsProperty 

type CfnDashboard_DashboardPublishOptionsProperty struct {
	// Ad hoc (one-time) filtering option.
	AdHocFilteringOption interface{} `json:"adHocFilteringOption" yaml:"adHocFilteringOption"`
	// Export to .csv option.
	ExportToCsvOption interface{} `json:"exportToCsvOption" yaml:"exportToCsvOption"`
	// Sheet controls option.
	SheetControlsOption interface{} `json:"sheetControlsOption" yaml:"sheetControlsOption"`
}

Dashboard publish options.

TODO: EXAMPLE

type CfnDashboard_DashboardSourceEntityProperty 

type CfnDashboard_DashboardSourceEntityProperty struct {
	// Source template.
	SourceTemplate interface{} `json:"sourceTemplate" yaml:"sourceTemplate"`
}

Dashboard source entity.

TODO: EXAMPLE

type CfnDashboard_DashboardSourceTemplateProperty 

type CfnDashboard_DashboardSourceTemplateProperty struct {
	// The Amazon Resource Name (ARN) of the resource.
	Arn *string `json:"arn" yaml:"arn"`
	// Dataset references.
	DataSetReferences interface{} `json:"dataSetReferences" yaml:"dataSetReferences"`
}

Dashboard source template.

TODO: EXAMPLE

type CfnDashboard_DataSetReferenceProperty 

type CfnDashboard_DataSetReferenceProperty struct {
	// Dataset Amazon Resource Name (ARN).
	DataSetArn *string `json:"dataSetArn" yaml:"dataSetArn"`
	// Dataset placeholder.
	DataSetPlaceholder *string `json:"dataSetPlaceholder" yaml:"dataSetPlaceholder"`
}

Dataset reference.

TODO: EXAMPLE

type CfnDashboard_DateTimeParameterProperty 

type CfnDashboard_DateTimeParameterProperty struct {
	// A display name for the date-time parameter.
	Name *string `json:"name" yaml:"name"`
	// The values for the date-time parameter.
	Values *[]*string `json:"values" yaml:"values"`
}

A date-time parameter.

TODO: EXAMPLE

type CfnDashboard_DecimalParameterProperty 

type CfnDashboard_DecimalParameterProperty struct {
	// A display name for the decimal parameter.
	Name *string `json:"name" yaml:"name"`
	// The values for the decimal parameter.
	Values interface{} `json:"values" yaml:"values"`
}

A decimal parameter.

TODO: EXAMPLE

type CfnDashboard_ExportToCSVOptionProperty 

type CfnDashboard_ExportToCSVOptionProperty struct {
	// Availability status.
	AvailabilityStatus *string `json:"availabilityStatus" yaml:"availabilityStatus"`
}

Export to .csv option.

TODO: EXAMPLE

type CfnDashboard_IntegerParameterProperty 

type CfnDashboard_IntegerParameterProperty struct {
	// The name of the integer parameter.
	Name *string `json:"name" yaml:"name"`
	// The values for the integer parameter.
	Values interface{} `json:"values" yaml:"values"`
}

An integer parameter.

TODO: EXAMPLE

type CfnDashboard_ParametersProperty 

type CfnDashboard_ParametersProperty struct {
	// The parameters that have a data type of date-time.
	DateTimeParameters interface{} `json:"dateTimeParameters" yaml:"dateTimeParameters"`
	// The parameters that have a data type of decimal.
	DecimalParameters interface{} `json:"decimalParameters" yaml:"decimalParameters"`
	// The parameters that have a data type of integer.
	IntegerParameters interface{} `json:"integerParameters" yaml:"integerParameters"`
	// The parameters that have a data type of string.
	StringParameters interface{} `json:"stringParameters" yaml:"stringParameters"`
}

A list of Amazon QuickSight parameters and the list's override values.

TODO: EXAMPLE

type CfnDashboard_ResourcePermissionProperty 

type CfnDashboard_ResourcePermissionProperty struct {
	// The IAM action to grant or revoke permissions on.
	Actions *[]*string `json:"actions" yaml:"actions"`
	// The Amazon Resource Name (ARN) of the principal. This can be one of the following:.
	//
	// - The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)
	// - The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)
	// - The ARN of an AWS account root: This is an IAM ARN rather than a Amazon QuickSight ARN. Use this option only to share resources (templates) across AWS accounts . (This is less common.)
	Principal *string `json:"principal" yaml:"principal"`
}

Permission for the resource.

TODO: EXAMPLE

type CfnDashboard_SheetControlsOptionProperty 

type CfnDashboard_SheetControlsOptionProperty struct {
	// Visibility state.
	VisibilityState *string `json:"visibilityState" yaml:"visibilityState"`
}

Sheet controls option.

TODO: EXAMPLE

type CfnDashboard_StringParameterProperty 

type CfnDashboard_StringParameterProperty struct {
	// A display name for a string parameter.
	Name *string `json:"name" yaml:"name"`
	// The values of a string parameter.
	Values *[]*string `json:"values" yaml:"values"`
}

A string parameter.

TODO: EXAMPLE

type CfnDataSet 

type CfnDataSet interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	AttrConsumedSpiceCapacityInBytes() awscdk.IResolvable
	AttrCreatedTime() *string
	AttrLastUpdatedTime() *string
	AttrOutputColumns() awscdk.IResolvable
	AwsAccountId() *string
	SetAwsAccountId(val *string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	ColumnGroups() interface{}
	SetColumnGroups(val interface{})
	ColumnLevelPermissionRules() interface{}
	SetColumnLevelPermissionRules(val interface{})
	CreationStack() *[]*string
	DataSetId() *string
	SetDataSetId(val *string)
	FieldFolders() interface{}
	SetFieldFolders(val interface{})
	ImportMode() *string
	SetImportMode(val *string)
	IngestionWaitPolicy() interface{}
	SetIngestionWaitPolicy(val interface{})
	LogicalId() *string
	LogicalTableMap() interface{}
	SetLogicalTableMap(val interface{})
	Name() *string
	SetName(val *string)
	Node() constructs.Node
	Permissions() interface{}
	SetPermissions(val interface{})
	PhysicalTableMap() interface{}
	SetPhysicalTableMap(val interface{})
	Ref() *string
	RowLevelPermissionDataSet() interface{}
	SetRowLevelPermissionDataSet(val interface{})
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::QuickSight::DataSet`.

Creates a dataset. This operation doesn't support datasets that include uploaded files as a source.

TODO: EXAMPLE

func NewCfnDataSet 

func NewCfnDataSet(scope constructs.Construct, id *string, props *CfnDataSetProps) CfnDataSet

Create a new `AWS::QuickSight::DataSet`.

type CfnDataSetProps 

type CfnDataSetProps struct {
	// The AWS account ID.
	AwsAccountId *string `json:"awsAccountId" yaml:"awsAccountId"`
	// Groupings of columns that work together in certain Amazon QuickSight features.
	//
	// Currently, only geospatial hierarchy is supported.
	ColumnGroups interface{} `json:"columnGroups" yaml:"columnGroups"`
	// A set of one or more definitions of a `ColumnLevelPermissionRule` .
	ColumnLevelPermissionRules interface{} `json:"columnLevelPermissionRules" yaml:"columnLevelPermissionRules"`
	// An ID for the dataset that you want to create.
	//
	// This ID is unique per AWS Region for each AWS account.
	DataSetId *string `json:"dataSetId" yaml:"dataSetId"`
	// The folder that contains fields and nested subfolders for your dataset.
	FieldFolders interface{} `json:"fieldFolders" yaml:"fieldFolders"`
	// Indicates whether you want to import the data into SPICE.
	ImportMode *string `json:"importMode" yaml:"importMode"`
	// The wait policy to use when creating or updating a Dataset.
	//
	// The default is to wait for SPICE ingestion to finish with timeout of 36 hours.
	IngestionWaitPolicy interface{} `json:"ingestionWaitPolicy" yaml:"ingestionWaitPolicy"`
	// Configures the combination and transformation of the data from the physical tables.
	LogicalTableMap interface{} `json:"logicalTableMap" yaml:"logicalTableMap"`
	// The display name for the dataset.
	Name *string `json:"name" yaml:"name"`
	// A list of resource permissions on the dataset.
	Permissions interface{} `json:"permissions" yaml:"permissions"`
	// Declares the physical tables that are available in the underlying data sources.
	PhysicalTableMap interface{} `json:"physicalTableMap" yaml:"physicalTableMap"`
	// The row-level security configuration for the data that you want to create.
	RowLevelPermissionDataSet interface{} `json:"rowLevelPermissionDataSet" yaml:"rowLevelPermissionDataSet"`
	// Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnDataSet`.

TODO: EXAMPLE

type CfnDataSet_CalculatedColumnProperty 

type CfnDataSet_CalculatedColumnProperty struct {
	// A unique ID to identify a calculated column.
	//
	// During a dataset update, if the column ID of a calculated column matches that of an existing calculated column, Amazon QuickSight preserves the existing calculated column.
	ColumnId *string `json:"columnId" yaml:"columnId"`
	// Column name.
	ColumnName *string `json:"columnName" yaml:"columnName"`
	// An expression that defines the calculated column.
	Expression *string `json:"expression" yaml:"expression"`
}

A calculated column for a dataset.

TODO: EXAMPLE

type CfnDataSet_CastColumnTypeOperationProperty 

type CfnDataSet_CastColumnTypeOperationProperty struct {
	// Column name.
	ColumnName *string `json:"columnName" yaml:"columnName"`
	// New column data type.
	NewColumnType *string `json:"newColumnType" yaml:"newColumnType"`
	// When casting a column from string to datetime type, you can supply a string in a format supported by Amazon QuickSight to denote the source data format.
	Format *string `json:"format" yaml:"format"`
}

A transform operation that casts a column to a different type.

TODO: EXAMPLE

type CfnDataSet_ColumnDescriptionProperty 

type CfnDataSet_ColumnDescriptionProperty struct {
	// The text of a description for a column.
	Text *string `json:"text" yaml:"text"`
}

Metadata that contains a description for a column.

TODO: EXAMPLE

type CfnDataSet_ColumnGroupProperty 

type CfnDataSet_ColumnGroupProperty struct {
	// Geospatial column group that denotes a hierarchy.
	GeoSpatialColumnGroup interface{} `json:"geoSpatialColumnGroup" yaml:"geoSpatialColumnGroup"`
}

Groupings of columns that work together in certain Amazon QuickSight features.

This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

TODO: EXAMPLE

type CfnDataSet_ColumnLevelPermissionRuleProperty 

type CfnDataSet_ColumnLevelPermissionRuleProperty struct {
	// An array of column names.
	ColumnNames *[]*string `json:"columnNames" yaml:"columnNames"`
	// An array of Amazon Resource Names (ARNs) for Amazon QuickSight users or groups.
	Principals *[]*string `json:"principals" yaml:"principals"`
}

A rule defined to grant access on one or more restricted columns.

Each dataset can have multiple rules. To create a restricted column, you add it to one or more rules. Each rule must contain at least one column and at least one user or group. To be able to see a restricted column, a user or group needs to be added to a rule for that column.

TODO: EXAMPLE

type CfnDataSet_ColumnTagProperty 

type CfnDataSet_ColumnTagProperty struct {
	// A description for a column.
	ColumnDescription interface{} `json:"columnDescription" yaml:"columnDescription"`
	// A geospatial role for a column.
	ColumnGeographicRole *string `json:"columnGeographicRole" yaml:"columnGeographicRole"`
}

A tag for a column in a `[TagColumnOperation](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_TagColumnOperation.html)` structure. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

TODO: EXAMPLE

type CfnDataSet_CreateColumnsOperationProperty 

type CfnDataSet_CreateColumnsOperationProperty struct {
	// Calculated columns to create.
	Columns interface{} `json:"columns" yaml:"columns"`
}

A transform operation that creates calculated columns.

Columns created in one such operation form a lexical closure.

TODO: EXAMPLE

type CfnDataSet_CustomSqlProperty 

type CfnDataSet_CustomSqlProperty struct {
	// The column schema from the SQL query result set.
	Columns interface{} `json:"columns" yaml:"columns"`
	// The Amazon Resource Name (ARN) of the data source.
	DataSourceArn *string `json:"dataSourceArn" yaml:"dataSourceArn"`
	// A display name for the SQL query result.
	Name *string `json:"name" yaml:"name"`
	// The SQL query.
	SqlQuery *string `json:"sqlQuery" yaml:"sqlQuery"`
}

A physical table type built from the results of the custom SQL query.

TODO: EXAMPLE

type CfnDataSet_FieldFolderProperty 

type CfnDataSet_FieldFolderProperty struct {
	// A folder has a list of columns.
	//
	// A column can only be in one folder.
	Columns *[]*string `json:"columns" yaml:"columns"`
	// The description for a field folder.
	Description *string `json:"description" yaml:"description"`
}

A FieldFolder element is a folder that contains fields and nested subfolders.

TODO: EXAMPLE

type CfnDataSet_FilterOperationProperty 

type CfnDataSet_FilterOperationProperty struct {
	// An expression that must evaluate to a Boolean value.
	//
	// Rows for which the expression evaluates to true are kept in the dataset.
	ConditionExpression *string `json:"conditionExpression" yaml:"conditionExpression"`
}

A transform operation that filters rows based on a condition.

TODO: EXAMPLE

type CfnDataSet_GeoSpatialColumnGroupProperty 

type CfnDataSet_GeoSpatialColumnGroupProperty struct {
	// Columns in this hierarchy.
	Columns *[]*string `json:"columns" yaml:"columns"`
	// A display name for the hierarchy.
	Name *string `json:"name" yaml:"name"`
	// Country code.
	CountryCode *string `json:"countryCode" yaml:"countryCode"`
}

Geospatial column group that denotes a hierarchy.

TODO: EXAMPLE

type CfnDataSet_IngestionWaitPolicyProperty 

type CfnDataSet_IngestionWaitPolicyProperty struct {
	// The maximum time (in hours) to wait for Ingestion to complete.
	//
	// Default timeout is 36 hours. Applicable only when `DataSetImportMode` mode is set to SPICE and `WaitForSpiceIngestion` is set to true.
	IngestionWaitTimeInHours *float64 `json:"ingestionWaitTimeInHours" yaml:"ingestionWaitTimeInHours"`
	// Wait for SPICE ingestion to finish to mark dataset creation or update as successful.
	//
	// Default (true). Applicable only when `DataSetImportMode` mode is set to SPICE.
	WaitForSpiceIngestion interface{} `json:"waitForSpiceIngestion" yaml:"waitForSpiceIngestion"`
}

The wait policy to use when creating or updating a Dataset.

The default is to wait for SPICE ingestion to finish with timeout of 36 hours.

TODO: EXAMPLE

type CfnDataSet_InputColumnProperty 

type CfnDataSet_InputColumnProperty struct {
	// The name of this column in the underlying data source.
	Name *string `json:"name" yaml:"name"`
	// The data type of the column.
	Type *string `json:"type" yaml:"type"`
}

Metadata for a column that is used as the input of a transform operation.

TODO: EXAMPLE

type CfnDataSet_JoinInstructionProperty 

type CfnDataSet_JoinInstructionProperty struct {
	// The operand on the left side of a join.
	LeftOperand *string `json:"leftOperand" yaml:"leftOperand"`
	// The join instructions provided in the `ON` clause of a join.
	OnClause *string `json:"onClause" yaml:"onClause"`
	// The operand on the right side of a join.
	RightOperand *string `json:"rightOperand" yaml:"rightOperand"`
	// The type of join that it is.
	Type *string `json:"type" yaml:"type"`
	// Join key properties of the left operand.
	LeftJoinKeyProperties interface{} `json:"leftJoinKeyProperties" yaml:"leftJoinKeyProperties"`
	// Join key properties of the right operand.
	RightJoinKeyProperties interface{} `json:"rightJoinKeyProperties" yaml:"rightJoinKeyProperties"`
}

The instructions associated with a join.

TODO: EXAMPLE

type CfnDataSet_JoinKeyPropertiesProperty 

type CfnDataSet_JoinKeyPropertiesProperty struct {
	// A value that indicates that a row in a table is uniquely identified by the columns in a join key.
	//
	// This is used by Amazon QuickSight to optimize query performance.
	UniqueKey interface{} `json:"uniqueKey" yaml:"uniqueKey"`
}

Properties associated with the columns participating in a join.

TODO: EXAMPLE

type CfnDataSet_LogicalTableProperty 

type CfnDataSet_LogicalTableProperty struct {
	// A display name for the logical table.
	Alias *string `json:"alias" yaml:"alias"`
	// Source of this logical table.
	Source interface{} `json:"source" yaml:"source"`
	// Transform operations that act on this logical table.
	DataTransforms interface{} `json:"dataTransforms" yaml:"dataTransforms"`
}

A *logical table* is a unit that joins and that data transformations operate on.

A logical table has a source, which can be either a physical table or result of a join. When a logical table points to a physical table, the logical table acts as a mutable copy of that physical table through transform operations.

TODO: EXAMPLE

type CfnDataSet_LogicalTableSourceProperty 

type CfnDataSet_LogicalTableSourceProperty struct {
	// Specifies the result of a join of two logical tables.
	JoinInstruction interface{} `json:"joinInstruction" yaml:"joinInstruction"`
	// Physical table ID.
	PhysicalTableId *string `json:"physicalTableId" yaml:"physicalTableId"`
}

Information about the source of a logical table.

This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

TODO: EXAMPLE

type CfnDataSet_OutputColumnProperty 

type CfnDataSet_OutputColumnProperty struct {
	// A description for a column.
	Description *string `json:"description" yaml:"description"`
	// A display name for the dataset.
	Name *string `json:"name" yaml:"name"`
	// Type.
	Type *string `json:"type" yaml:"type"`
}

Output column.

TODO: EXAMPLE

type CfnDataSet_PhysicalTableProperty 

type CfnDataSet_PhysicalTableProperty struct {
	// A physical table type built from the results of the custom SQL query.
	CustomSql interface{} `json:"customSql" yaml:"customSql"`
	// A physical table type for relational data sources.
	RelationalTable interface{} `json:"relationalTable" yaml:"relationalTable"`
	// A physical table type for as S3 data source.
	S3Source interface{} `json:"s3Source" yaml:"s3Source"`
}

A view of a data source that contains information about the shape of the data in the underlying source.

This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

TODO: EXAMPLE

type CfnDataSet_ProjectOperationProperty 

type CfnDataSet_ProjectOperationProperty struct {
	// Projected columns.
	ProjectedColumns *[]*string `json:"projectedColumns" yaml:"projectedColumns"`
}

A transform operation that projects columns.

Operations that come after a projection can only refer to projected columns.

TODO: EXAMPLE

type CfnDataSet_RelationalTableProperty 

type CfnDataSet_RelationalTableProperty struct {
	// The Amazon Resource Name (ARN) for the data source.
	DataSourceArn *string `json:"dataSourceArn" yaml:"dataSourceArn"`
	// The column schema of the table.
	InputColumns interface{} `json:"inputColumns" yaml:"inputColumns"`
	// The name of the relational table.
	Name *string `json:"name" yaml:"name"`
	// `CfnDataSet.RelationalTableProperty.Catalog`.
	Catalog *string `json:"catalog" yaml:"catalog"`
	// The schema name.
	//
	// This name applies to certain relational database engines.
	Schema *string `json:"schema" yaml:"schema"`
}

A physical table type for relational data sources.

TODO: EXAMPLE

type CfnDataSet_RenameColumnOperationProperty 

type CfnDataSet_RenameColumnOperationProperty struct {
	// The name of the column to be renamed.
	ColumnName *string `json:"columnName" yaml:"columnName"`
	// The new name for the column.
	NewColumnName *string `json:"newColumnName" yaml:"newColumnName"`
}

A transform operation that renames a column.

TODO: EXAMPLE

type CfnDataSet_ResourcePermissionProperty 

type CfnDataSet_ResourcePermissionProperty struct {
	// The IAM action to grand or revoke permisions on.
	Actions *[]*string `json:"actions" yaml:"actions"`
	// The Amazon Resource Name (ARN) of the principal. This can be one of the following:.
	//
	// - The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)
	// - The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)
	// - The ARN of an AWS account root: This is an IAM ARN rather than a Amazon QuickSight ARN. Use this option only to share resources (templates) across AWS accounts . (This is less common.)
	Principal *string `json:"principal" yaml:"principal"`
}

Permission for the resource.

TODO: EXAMPLE

type CfnDataSet_RowLevelPermissionDataSetProperty 

type CfnDataSet_RowLevelPermissionDataSetProperty struct {
	// The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.
	Arn *string `json:"arn" yaml:"arn"`
	// The type of permissions to use when interpreting the permissions for RLS.
	//
	// `DENY_ACCESS` is included for backward compatibility only.
	PermissionPolicy *string `json:"permissionPolicy" yaml:"permissionPolicy"`
	// The user or group rules associated with the dataset that contains permissions for RLS.
	//
	// By default, `FormatVersion` is `VERSION_1` . When `FormatVersion` is `VERSION_1` , `UserName` and `GroupName` are required. When `FormatVersion` is `VERSION_2` , `UserARN` and `GroupARN` are required, and `Namespace` must not exist.
	FormatVersion *string `json:"formatVersion" yaml:"formatVersion"`
	// The namespace associated with the dataset that contains permissions for RLS.
	Namespace *string `json:"namespace" yaml:"namespace"`
}

Information about a dataset that contains permissions for row-level security (RLS).

The permissions dataset maps fields to users or groups. For more information, see [Using Row-Level Security (RLS) to Restrict Access to a Dataset](https://docs.aws.amazon.com/quicksight/latest/user/restrict-access-to-a-data-set-using-row-level-security.html) in the *Amazon QuickSight User Guide* .

The option to deny permissions by setting `PermissionPolicy` to `DENY_ACCESS` is not supported for new RLS datasets.

TODO: EXAMPLE

type CfnDataSet_S3SourceProperty 

type CfnDataSet_S3SourceProperty struct {
	// The Amazon Resource Name (ARN) for the data source.
	DataSourceArn *string `json:"dataSourceArn" yaml:"dataSourceArn"`
	// A physical table type for an S3 data source.
	//
	// > For files that aren't JSON, only `STRING` data types are supported in input columns.
	InputColumns interface{} `json:"inputColumns" yaml:"inputColumns"`
	// Information about the format for the S3 source file or files.
	UploadSettings interface{} `json:"uploadSettings" yaml:"uploadSettings"`
}

A physical table type for an S3 data source.

TODO: EXAMPLE

type CfnDataSet_TagColumnOperationProperty 

type CfnDataSet_TagColumnOperationProperty struct {
	// The column that this operation acts on.
	ColumnName *string `json:"columnName" yaml:"columnName"`
	// The dataset column tag, currently only used for geospatial type tagging.
	//
	// > This is not tags for the AWS tagging feature.
	Tags *[]*CfnDataSet_ColumnTagProperty `json:"tags" yaml:"tags"`
}

A transform operation that tags a column with additional information.

TODO: EXAMPLE

type CfnDataSet_TransformOperationProperty 

type CfnDataSet_TransformOperationProperty struct {
	// A transform operation that casts a column to a different type.
	CastColumnTypeOperation interface{} `json:"castColumnTypeOperation" yaml:"castColumnTypeOperation"`
	// An operation that creates calculated columns.
	//
	// Columns created in one such operation form a lexical closure.
	CreateColumnsOperation interface{} `json:"createColumnsOperation" yaml:"createColumnsOperation"`
	// An operation that filters rows based on some condition.
	FilterOperation interface{} `json:"filterOperation" yaml:"filterOperation"`
	// An operation that projects columns.
	//
	// Operations that come after a projection can only refer to projected columns.
	ProjectOperation interface{} `json:"projectOperation" yaml:"projectOperation"`
	// An operation that renames a column.
	RenameColumnOperation interface{} `json:"renameColumnOperation" yaml:"renameColumnOperation"`
	// An operation that tags a column with additional information.
	TagColumnOperation interface{} `json:"tagColumnOperation" yaml:"tagColumnOperation"`
}

A data transformation on a logical table.

This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

TODO: EXAMPLE

type CfnDataSet_UploadSettingsProperty 

type CfnDataSet_UploadSettingsProperty struct {
	// Whether the file has a header row, or the files each have a header row.
	ContainsHeader interface{} `json:"containsHeader" yaml:"containsHeader"`
	// The delimiter between values in the file.
	Delimiter *string `json:"delimiter" yaml:"delimiter"`
	// File format.
	Format *string `json:"format" yaml:"format"`
	// A row number to start reading data from.
	StartFromRow *float64 `json:"startFromRow" yaml:"startFromRow"`
	// Text qualifier.
	TextQualifier *string `json:"textQualifier" yaml:"textQualifier"`
}

Information about the format for a source file or files.

TODO: EXAMPLE

type CfnDataSource 

type CfnDataSource interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AlternateDataSourceParameters() interface{}
	SetAlternateDataSourceParameters(val interface{})
	AttrArn() *string
	AttrCreatedTime() *string
	AttrLastUpdatedTime() *string
	AttrStatus() *string
	AwsAccountId() *string
	SetAwsAccountId(val *string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Credentials() interface{}
	SetCredentials(val interface{})
	DataSourceId() *string
	SetDataSourceId(val *string)
	DataSourceParameters() interface{}
	SetDataSourceParameters(val interface{})
	ErrorInfo() interface{}
	SetErrorInfo(val interface{})
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() constructs.Node
	Permissions() interface{}
	SetPermissions(val interface{})
	Ref() *string
	SslProperties() interface{}
	SetSslProperties(val interface{})
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	Type() *string
	SetType(val *string)
	UpdatedProperites() *map[string]interface{}
	VpcConnectionProperties() interface{}
	SetVpcConnectionProperties(val interface{})
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::QuickSight::DataSource`.

Creates a data source.

TODO: EXAMPLE

func NewCfnDataSource 

func NewCfnDataSource(scope constructs.Construct, id *string, props *CfnDataSourceProps) CfnDataSource

Create a new `AWS::QuickSight::DataSource`.

type CfnDataSourceProps 

type CfnDataSourceProps struct {
	// A set of alternate data source parameters that you want to share for the credentials stored with this data source.
	//
	// The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the `DataSourceParameters` structure that's in the request with the structures in the `AlternateDataSourceParameters` allow list. If the structures are an exact match, the request is allowed to use the credentials from this existing data source. If the `AlternateDataSourceParameters` list is null, the `Credentials` originally used with this `DataSourceParameters` are automatically allowed.
	AlternateDataSourceParameters interface{} `json:"alternateDataSourceParameters" yaml:"alternateDataSourceParameters"`
	// The AWS account ID.
	AwsAccountId *string `json:"awsAccountId" yaml:"awsAccountId"`
	// The credentials Amazon QuickSight that uses to connect to your underlying source.
	//
	// Currently, only credentials based on user name and password are supported.
	Credentials interface{} `json:"credentials" yaml:"credentials"`
	// An ID for the data source.
	//
	// This ID is unique per AWS Region for each AWS account.
	DataSourceId *string `json:"dataSourceId" yaml:"dataSourceId"`
	// The parameters that Amazon QuickSight uses to connect to your underlying source.
	DataSourceParameters interface{} `json:"dataSourceParameters" yaml:"dataSourceParameters"`
	// Error information from the last update or the creation of the data source.
	ErrorInfo interface{} `json:"errorInfo" yaml:"errorInfo"`
	// A display name for the data source.
	Name *string `json:"name" yaml:"name"`
	// A list of resource permissions on the data source.
	Permissions interface{} `json:"permissions" yaml:"permissions"`
	// Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.
	SslProperties interface{} `json:"sslProperties" yaml:"sslProperties"`
	// Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
	// The type of the data source. To return a list of all data sources, use `ListDataSources` .
	//
	// Use `AMAZON_ELASTICSEARCH` for Amazon OpenSearch Service .
	Type *string `json:"type" yaml:"type"`
	// Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.
	VpcConnectionProperties interface{} `json:"vpcConnectionProperties" yaml:"vpcConnectionProperties"`
}

Properties for defining a `CfnDataSource`.

TODO: EXAMPLE

type CfnDataSource_AmazonElasticsearchParametersProperty 

type CfnDataSource_AmazonElasticsearchParametersProperty struct {
	// The OpenSearch domain.
	Domain *string `json:"domain" yaml:"domain"`
}

The parameters for OpenSearch .

TODO: EXAMPLE

type CfnDataSource_AmazonOpenSearchParametersProperty 

type CfnDataSource_AmazonOpenSearchParametersProperty struct {
	// The OpenSearch domain.
	Domain *string `json:"domain" yaml:"domain"`
}

The parameters for OpenSearch .

TODO: EXAMPLE

type CfnDataSource_AthenaParametersProperty 

type CfnDataSource_AthenaParametersProperty struct {
	// The workgroup that Amazon Athena uses.
	WorkGroup *string `json:"workGroup" yaml:"workGroup"`
}

Parameters for Amazon Athena.

TODO: EXAMPLE

type CfnDataSource_AuroraParametersProperty 

type CfnDataSource_AuroraParametersProperty struct {
	// Database.
	Database *string `json:"database" yaml:"database"`
	// Host.
	Host *string `json:"host" yaml:"host"`
	// Port.
	Port *float64 `json:"port" yaml:"port"`
}

Parameters for Amazon Aurora.

TODO: EXAMPLE

type CfnDataSource_AuroraPostgreSqlParametersProperty 

type CfnDataSource_AuroraPostgreSqlParametersProperty struct {
	// The Amazon Aurora PostgreSQL database to connect to.
	Database *string `json:"database" yaml:"database"`
	// The Amazon Aurora PostgreSQL-Compatible host to connect to.
	Host *string `json:"host" yaml:"host"`
	// The port that Amazon Aurora PostgreSQL is listening on.
	Port *float64 `json:"port" yaml:"port"`
}

Parameters for Amazon Aurora PostgreSQL-Compatible Edition.

TODO: EXAMPLE

type CfnDataSource_CredentialPairProperty 

type CfnDataSource_CredentialPairProperty struct {
	// Password.
	Password *string `json:"password" yaml:"password"`
	// User name.
	Username *string `json:"username" yaml:"username"`
	// A set of alternate data source parameters that you want to share for these credentials.
	//
	// The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the `DataSourceParameters` structure that's in the request with the structures in the `AlternateDataSourceParameters` allow list. If the structures are an exact match, the request is allowed to use the new data source with the existing credentials. If the `AlternateDataSourceParameters` list is null, the `DataSourceParameters` originally used with these `Credentials` is automatically allowed.
	AlternateDataSourceParameters interface{} `json:"alternateDataSourceParameters" yaml:"alternateDataSourceParameters"`
}

The combination of user name and password that are used as credentials.

TODO: EXAMPLE

type CfnDataSource_DataSourceCredentialsProperty 

type CfnDataSource_DataSourceCredentialsProperty struct {
	// The Amazon Resource Name (ARN) of a data source that has the credential pair that you want to use.
	//
	// When `CopySourceArn` is not null, the credential pair from the data source in the ARN is used as the credentials for the `DataSourceCredentials` structure.
	CopySourceArn *string `json:"copySourceArn" yaml:"copySourceArn"`
	// Credential pair.
	//
	// For more information, see `[CredentialPair](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CredentialPair.html)` .
	CredentialPair interface{} `json:"credentialPair" yaml:"credentialPair"`
}

Data source credentials.

This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

TODO: EXAMPLE

type CfnDataSource_DataSourceErrorInfoProperty 

type CfnDataSource_DataSourceErrorInfoProperty struct {
	// Error message.
	Message *string `json:"message" yaml:"message"`
	// Error type.
	Type *string `json:"type" yaml:"type"`
}

Error information for the data source creation or update.

TODO: EXAMPLE

type CfnDataSource_DataSourceParametersProperty 

type CfnDataSource_DataSourceParametersProperty struct {
	// The parameters for OpenSearch .
	AmazonElasticsearchParameters interface{} `json:"amazonElasticsearchParameters" yaml:"amazonElasticsearchParameters"`
	// The parameters for OpenSearch .
	AmazonOpenSearchParameters interface{} `json:"amazonOpenSearchParameters" yaml:"amazonOpenSearchParameters"`
	// The parameters for Amazon Athena.
	AthenaParameters interface{} `json:"athenaParameters" yaml:"athenaParameters"`
	// The parameters for Amazon Aurora MySQL.
	AuroraParameters interface{} `json:"auroraParameters" yaml:"auroraParameters"`
	// The parameters for Amazon Aurora.
	AuroraPostgreSqlParameters interface{} `json:"auroraPostgreSqlParameters" yaml:"auroraPostgreSqlParameters"`
	// The parameters for MariaDB.
	MariaDbParameters interface{} `json:"mariaDbParameters" yaml:"mariaDbParameters"`
	// The parameters for MySQL.
	MySqlParameters interface{} `json:"mySqlParameters" yaml:"mySqlParameters"`
	// Oracle parameters.
	OracleParameters interface{} `json:"oracleParameters" yaml:"oracleParameters"`
	// The parameters for PostgreSQL.
	PostgreSqlParameters interface{} `json:"postgreSqlParameters" yaml:"postgreSqlParameters"`
	// The parameters for Presto.
	PrestoParameters interface{} `json:"prestoParameters" yaml:"prestoParameters"`
	// The parameters for Amazon RDS.
	RdsParameters interface{} `json:"rdsParameters" yaml:"rdsParameters"`
	// The parameters for Amazon Redshift.
	RedshiftParameters interface{} `json:"redshiftParameters" yaml:"redshiftParameters"`
	// The parameters for S3.
	S3Parameters interface{} `json:"s3Parameters" yaml:"s3Parameters"`
	// The parameters for Snowflake.
	SnowflakeParameters interface{} `json:"snowflakeParameters" yaml:"snowflakeParameters"`
	// The parameters for Spark.
	SparkParameters interface{} `json:"sparkParameters" yaml:"sparkParameters"`
	// The parameters for SQL Server.
	SqlServerParameters interface{} `json:"sqlServerParameters" yaml:"sqlServerParameters"`
	// The parameters for Teradata.
	TeradataParameters interface{} `json:"teradataParameters" yaml:"teradataParameters"`
}

The parameters that Amazon QuickSight uses to connect to your underlying data source.

This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

TODO: EXAMPLE

type CfnDataSource_ManifestFileLocationProperty 

type CfnDataSource_ManifestFileLocationProperty struct {
	// Amazon S3 bucket.
	Bucket *string `json:"bucket" yaml:"bucket"`
	// Amazon S3 key that identifies an object.
	Key *string `json:"key" yaml:"key"`
}

Amazon S3 manifest file location.

TODO: EXAMPLE

type CfnDataSource_MariaDbParametersProperty 

type CfnDataSource_MariaDbParametersProperty struct {
	// Database.
	Database *string `json:"database" yaml:"database"`
	// Host.
	Host *string `json:"host" yaml:"host"`
	// Port.
	Port *float64 `json:"port" yaml:"port"`
}

The parameters for MariaDB.

TODO: EXAMPLE

type CfnDataSource_MySqlParametersProperty 

type CfnDataSource_MySqlParametersProperty struct {
	// Database.
	Database *string `json:"database" yaml:"database"`
	// Host.
	Host *string `json:"host" yaml:"host"`
	// Port.
	Port *float64 `json:"port" yaml:"port"`
}

The parameters for MySQL.

TODO: EXAMPLE

type CfnDataSource_OracleParametersProperty 

type CfnDataSource_OracleParametersProperty struct {
	// Database.
	Database *string `json:"database" yaml:"database"`
	// Host.
	Host *string `json:"host" yaml:"host"`
	// Port.
	Port *float64 `json:"port" yaml:"port"`
}

Oracle parameters.

TODO: EXAMPLE

type CfnDataSource_PostgreSqlParametersProperty 

type CfnDataSource_PostgreSqlParametersProperty struct {
	// Database.
	Database *string `json:"database" yaml:"database"`
	// Host.
	Host *string `json:"host" yaml:"host"`
	// Port.
	Port *float64 `json:"port" yaml:"port"`
}

The parameters for PostgreSQL.

TODO: EXAMPLE

type CfnDataSource_PrestoParametersProperty 

type CfnDataSource_PrestoParametersProperty struct {
	// Catalog.
	Catalog *string `json:"catalog" yaml:"catalog"`
	// Host.
	Host *string `json:"host" yaml:"host"`
	// Port.
	Port *float64 `json:"port" yaml:"port"`
}

The parameters for Presto.

TODO: EXAMPLE

type CfnDataSource_RdsParametersProperty 

type CfnDataSource_RdsParametersProperty struct {
	// Database.
	Database *string `json:"database" yaml:"database"`
	// Instance ID.
	InstanceId *string `json:"instanceId" yaml:"instanceId"`
}

The parameters for Amazon RDS.

TODO: EXAMPLE

type CfnDataSource_RedshiftParametersProperty 

type CfnDataSource_RedshiftParametersProperty struct {
	// Database.
	Database *string `json:"database" yaml:"database"`
	// Cluster ID.
	//
	// This field can be blank if the `Host` and `Port` are provided.
	ClusterId *string `json:"clusterId" yaml:"clusterId"`
	// Host.
	//
	// This field can be blank if `ClusterId` is provided.
	Host *string `json:"host" yaml:"host"`
	// Port.
	//
	// This field can be blank if the `ClusterId` is provided.
	Port *float64 `json:"port" yaml:"port"`
}

The parameters for Amazon Redshift.

The `ClusterId` field can be blank if `Host` and `Port` are both set. The `Host` and `Port` fields can be blank if the `ClusterId` field is set.

TODO: EXAMPLE

type CfnDataSource_ResourcePermissionProperty 

type CfnDataSource_ResourcePermissionProperty struct {
	// The IAM action to grant or revoke permissions on.
	Actions *[]*string `json:"actions" yaml:"actions"`
	// The Amazon Resource Name (ARN) of the principal. This can be one of the following:.
	//
	// - The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)
	// - The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)
	// - The ARN of an AWS account root: This is an IAM ARN rather than a Amazon QuickSight ARN. Use this option only to share resources (templates) across AWS accounts . (This is less common.)
	Principal *string `json:"principal" yaml:"principal"`
}

Permission for the resource.

TODO: EXAMPLE

type CfnDataSource_S3ParametersProperty 

type CfnDataSource_S3ParametersProperty struct {
	// Location of the Amazon S3 manifest file.
	//
	// This is NULL if the manifest file was uploaded into Amazon QuickSight.
	ManifestFileLocation interface{} `json:"manifestFileLocation" yaml:"manifestFileLocation"`
}

The parameters for S3.

TODO: EXAMPLE

type CfnDataSource_SnowflakeParametersProperty 

type CfnDataSource_SnowflakeParametersProperty struct {
	// Database.
	Database *string `json:"database" yaml:"database"`
	// Host.
	Host *string `json:"host" yaml:"host"`
	// Warehouse.
	Warehouse *string `json:"warehouse" yaml:"warehouse"`
}

The parameters for Snowflake.

TODO: EXAMPLE

type CfnDataSource_SparkParametersProperty 

type CfnDataSource_SparkParametersProperty struct {
	// Host.
	Host *string `json:"host" yaml:"host"`
	// Port.
	Port *float64 `json:"port" yaml:"port"`
}

The parameters for Spark.

TODO: EXAMPLE

type CfnDataSource_SqlServerParametersProperty 

type CfnDataSource_SqlServerParametersProperty struct {
	// Database.
	Database *string `json:"database" yaml:"database"`
	// Host.
	Host *string `json:"host" yaml:"host"`
	// Port.
	Port *float64 `json:"port" yaml:"port"`
}

The parameters for SQL Server.

TODO: EXAMPLE

type CfnDataSource_SslPropertiesProperty 

type CfnDataSource_SslPropertiesProperty struct {
	// A Boolean option to control whether SSL should be disabled.
	DisableSsl interface{} `json:"disableSsl" yaml:"disableSsl"`
}

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying data source.

TODO: EXAMPLE

type CfnDataSource_TeradataParametersProperty 

type CfnDataSource_TeradataParametersProperty struct {
	// Database.
	Database *string `json:"database" yaml:"database"`
	// Host.
	Host *string `json:"host" yaml:"host"`
	// Port.
	Port *float64 `json:"port" yaml:"port"`
}

The parameters for Teradata.

TODO: EXAMPLE

type CfnDataSource_VpcConnectionPropertiesProperty 

type CfnDataSource_VpcConnectionPropertiesProperty struct {
	// The Amazon Resource Name (ARN) for the VPC connection.
	VpcConnectionArn *string `json:"vpcConnectionArn" yaml:"vpcConnectionArn"`
}

VPC connection properties.

TODO: EXAMPLE

type CfnTemplate 

type CfnTemplate interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	AttrCreatedTime() *string
	AttrLastUpdatedTime() *string
	AwsAccountId() *string
	SetAwsAccountId(val *string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() constructs.Node
	Permissions() interface{}
	SetPermissions(val interface{})
	Ref() *string
	SourceEntity() interface{}
	SetSourceEntity(val interface{})
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	TemplateId() *string
	SetTemplateId(val *string)
	UpdatedProperites() *map[string]interface{}
	VersionDescription() *string
	SetVersionDescription(val *string)
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::QuickSight::Template`.

Creates a template from an existing Amazon QuickSight analysis or template. You can use the resulting template to create a dashboard.

A *template* is an entity in Amazon QuickSight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.

TODO: EXAMPLE

func NewCfnTemplate 

func NewCfnTemplate(scope constructs.Construct, id *string, props *CfnTemplateProps) CfnTemplate

Create a new `AWS::QuickSight::Template`.

type CfnTemplateProps 

type CfnTemplateProps struct {
	// The ID for the AWS account that the group is in.
	//
	// You use the ID for the AWS account that contains your Amazon QuickSight account.
	AwsAccountId *string `json:"awsAccountId" yaml:"awsAccountId"`
	// The entity that you are using as a source when you create the template.
	//
	// In `SourceEntity` , you specify the type of object you're using as source: `SourceTemplate` for a template or `SourceAnalysis` for an analysis. Both of these require an Amazon Resource Name (ARN). For `SourceTemplate` , specify the ARN of the source template. For `SourceAnalysis` , specify the ARN of the source analysis. The `SourceTemplate` ARN can contain any AWS account and any Amazon QuickSight-supported AWS Region .
	//
	// Use the `DataSetReferences` entity within `SourceTemplate` or `SourceAnalysis` to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.
	SourceEntity interface{} `json:"sourceEntity" yaml:"sourceEntity"`
	// An ID for the template that you want to create.
	//
	// This template is unique per AWS Region ; in each AWS account.
	TemplateId *string `json:"templateId" yaml:"templateId"`
	// A display name for the template.
	Name *string `json:"name" yaml:"name"`
	// A list of resource permissions to be set on the template.
	Permissions interface{} `json:"permissions" yaml:"permissions"`
	// Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
	// A description of the current template version being created.
	//
	// This API operation creates the first version of the template. Every time `UpdateTemplate` is called, a new version is created. Each version of the template maintains a description of the version in the `VersionDescription` field.
	VersionDescription *string `json:"versionDescription" yaml:"versionDescription"`
}

Properties for defining a `CfnTemplate`.

TODO: EXAMPLE

type CfnTemplate_DataSetReferenceProperty 

type CfnTemplate_DataSetReferenceProperty struct {
	// Dataset Amazon Resource Name (ARN).
	DataSetArn *string `json:"dataSetArn" yaml:"dataSetArn"`
	// Dataset placeholder.
	DataSetPlaceholder *string `json:"dataSetPlaceholder" yaml:"dataSetPlaceholder"`
}

Dataset reference.

TODO: EXAMPLE

type CfnTemplate_ResourcePermissionProperty 

type CfnTemplate_ResourcePermissionProperty struct {
	// The IAM action to grant or revoke permissions on.
	Actions *[]*string `json:"actions" yaml:"actions"`
	// The Amazon Resource Name (ARN) of the principal. This can be one of the following:.
	//
	// - The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)
	// - The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)
	// - The ARN of an AWS account root: This is an IAM ARN rather than a Amazon QuickSight ARN. Use this option only to share resources (templates) across AWS accounts . (This is less common.)
	Principal *string `json:"principal" yaml:"principal"`
}

Permission for the resource.

TODO: EXAMPLE

type CfnTemplate_TemplateSourceAnalysisProperty 

type CfnTemplate_TemplateSourceAnalysisProperty struct {
	// The Amazon Resource Name (ARN) of the resource.
	Arn *string `json:"arn" yaml:"arn"`
	// A structure containing information about the dataset references used as placeholders in the template.
	DataSetReferences interface{} `json:"dataSetReferences" yaml:"dataSetReferences"`
}

The source analysis of the template.

TODO: EXAMPLE

type CfnTemplate_TemplateSourceEntityProperty 

type CfnTemplate_TemplateSourceEntityProperty struct {
	// The source analysis, if it is based on an analysis.
	SourceAnalysis interface{} `json:"sourceAnalysis" yaml:"sourceAnalysis"`
	// The source template, if it is based on an template.
	SourceTemplate interface{} `json:"sourceTemplate" yaml:"sourceTemplate"`
}

The source entity of the template.

TODO: EXAMPLE

type CfnTemplate_TemplateSourceTemplateProperty 

type CfnTemplate_TemplateSourceTemplateProperty struct {
	// The Amazon Resource Name (ARN) of the resource.
	Arn *string `json:"arn" yaml:"arn"`
}

The source template of the template.

TODO: EXAMPLE

type CfnTheme 

type CfnTheme interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	AttrCreatedTime() *string
	AttrLastUpdatedTime() *string
	AttrType() *string
	AwsAccountId() *string
	SetAwsAccountId(val *string)
	BaseThemeId() *string
	SetBaseThemeId(val *string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	Configuration() interface{}
	SetConfiguration(val interface{})
	CreationStack() *[]*string
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() constructs.Node
	Permissions() interface{}
	SetPermissions(val interface{})
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	ThemeId() *string
	SetThemeId(val *string)
	UpdatedProperites() *map[string]interface{}
	VersionDescription() *string
	SetVersionDescription(val *string)
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::QuickSight::Theme`.

Creates a theme.

A *theme* is set of configuration options for color and layout. Themes apply to analyses and dashboards. For more information, see [Using Themes in Amazon QuickSight](https://docs.aws.amazon.com/quicksight/latest/user/themes-in-quicksight.html) in the *Amazon QuickSight User Guide* .

TODO: EXAMPLE

func NewCfnTheme 

func NewCfnTheme(scope constructs.Construct, id *string, props *CfnThemeProps) CfnTheme

Create a new `AWS::QuickSight::Theme`.

type CfnThemeProps 

type CfnThemeProps struct {
	// The ID of the AWS account where you want to store the new theme.
	AwsAccountId *string `json:"awsAccountId" yaml:"awsAccountId"`
	// An ID for the theme that you want to create.
	//
	// The theme ID is unique per AWS Region in each AWS account.
	ThemeId *string `json:"themeId" yaml:"themeId"`
	// The ID of the theme that a custom theme will inherit from.
	//
	// All themes inherit from one of the starting themes defined by Amazon QuickSight. For a list of the starting themes, use `ListThemes` or choose *Themes* from within an analysis.
	BaseThemeId *string `json:"baseThemeId" yaml:"baseThemeId"`
	// The theme configuration, which contains the theme display properties.
	Configuration interface{} `json:"configuration" yaml:"configuration"`
	// A display name for the theme.
	Name *string `json:"name" yaml:"name"`
	// A valid grouping of resource permissions to apply to the new theme.
	Permissions interface{} `json:"permissions" yaml:"permissions"`
	// A map of the key-value pairs for the resource tag or tags that you want to add to the resource.
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
	// A description of the first version of the theme that you're creating.
	//
	// Every time `UpdateTheme` is called, a new version is created. Each version of the theme has a description of the version in the `VersionDescription` field.
	VersionDescription *string `json:"versionDescription" yaml:"versionDescription"`
}

Properties for defining a `CfnTheme`.

TODO: EXAMPLE

type CfnTheme_BorderStyleProperty 

type CfnTheme_BorderStyleProperty struct {
	// The option to enable display of borders for visuals.
	Show interface{} `json:"show" yaml:"show"`
}

The display options for tile borders for visuals.

TODO: EXAMPLE

type CfnTheme_DataColorPaletteProperty 

type CfnTheme_DataColorPaletteProperty struct {
	// The hexadecimal codes for the colors.
	Colors *[]*string `json:"colors" yaml:"colors"`
	// The hexadecimal code of a color that applies to charts where a lack of data is highlighted.
	EmptyFillColor *string `json:"emptyFillColor" yaml:"emptyFillColor"`
	// The minimum and maximum hexadecimal codes that describe a color gradient.
	MinMaxGradient *[]*string `json:"minMaxGradient" yaml:"minMaxGradient"`
}

The theme colors that are used for data colors in charts.

The colors description is a hexadecimal color code that consists of six alphanumerical characters, prefixed with `#` , for example #37BFF5.

TODO: EXAMPLE

type CfnTheme_FontProperty 

type CfnTheme_FontProperty struct {
	// `CfnTheme.FontProperty.FontFamily`.
	FontFamily *string `json:"fontFamily" yaml:"fontFamily"`
}

TODO: EXAMPLE

type CfnTheme_GutterStyleProperty 

type CfnTheme_GutterStyleProperty struct {
	// This Boolean value controls whether to display a gutter space between sheet tiles.
	Show interface{} `json:"show" yaml:"show"`
}

The display options for gutter spacing between tiles on a sheet.

TODO: EXAMPLE

type CfnTheme_MarginStyleProperty 

type CfnTheme_MarginStyleProperty struct {
	// This Boolean value controls whether to display sheet margins.
	Show interface{} `json:"show" yaml:"show"`
}

The display options for margins around the outside edge of sheets.

TODO: EXAMPLE

type CfnTheme_ResourcePermissionProperty 

type CfnTheme_ResourcePermissionProperty struct {
	// The IAM action to grant or revoke permissions on.
	Actions *[]*string `json:"actions" yaml:"actions"`
	// The Amazon Resource Name (ARN) of the principal. This can be one of the following:.
	//
	// - The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)
	// - The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)
	// - The ARN of an AWS account root: This is an IAM ARN rather than a Amazon QuickSight ARN. Use this option only to share resources (templates) across AWS accounts . (This is less common.)
	Principal *string `json:"principal" yaml:"principal"`
}

Permission for the resource.

TODO: EXAMPLE

type CfnTheme_SheetStyleProperty 

type CfnTheme_SheetStyleProperty struct {
	// The display options for tiles.
	Tile interface{} `json:"tile" yaml:"tile"`
	// The layout options for tiles.
	TileLayout interface{} `json:"tileLayout" yaml:"tileLayout"`
}

The theme display options for sheets.

TODO: EXAMPLE

type CfnTheme_ThemeConfigurationProperty 

type CfnTheme_ThemeConfigurationProperty struct {
	// Color properties that apply to chart data colors.
	DataColorPalette interface{} `json:"dataColorPalette" yaml:"dataColorPalette"`
	// Display options related to sheets.
	Sheet interface{} `json:"sheet" yaml:"sheet"`
	// `CfnTheme.ThemeConfigurationProperty.Typography`.
	Typography interface{} `json:"typography" yaml:"typography"`
	// Color properties that apply to the UI and to charts, excluding the colors that apply to data.
	UiColorPalette interface{} `json:"uiColorPalette" yaml:"uiColorPalette"`
}

The theme configuration.

This configuration contains all of the display properties for a theme.

TODO: EXAMPLE

type CfnTheme_TileLayoutStyleProperty 

type CfnTheme_TileLayoutStyleProperty struct {
	// The gutter settings that apply between tiles.
	Gutter interface{} `json:"gutter" yaml:"gutter"`
	// The margin settings that apply around the outside edge of sheets.
	Margin interface{} `json:"margin" yaml:"margin"`
}

The display options for the layout of tiles on a sheet.

TODO: EXAMPLE

type CfnTheme_TileStyleProperty 

type CfnTheme_TileStyleProperty struct {
	// The border around a tile.
	Border interface{} `json:"border" yaml:"border"`
}

Display options related to tiles on a sheet.

TODO: EXAMPLE

type CfnTheme_TypographyProperty 

type CfnTheme_TypographyProperty struct {
	// `CfnTheme.TypographyProperty.FontFamilies`.
	FontFamilies interface{} `json:"fontFamilies" yaml:"fontFamilies"`
}

TODO: EXAMPLE

type CfnTheme_UIColorPaletteProperty 

type CfnTheme_UIColorPaletteProperty struct {
	// This color is that applies to selected states and buttons.
	Accent *string `json:"accent" yaml:"accent"`
	// The foreground color that applies to any text or other elements that appear over the accent color.
	AccentForeground *string `json:"accentForeground" yaml:"accentForeground"`
	// The color that applies to error messages.
	Danger *string `json:"danger" yaml:"danger"`
	// The foreground color that applies to any text or other elements that appear over the error color.
	DangerForeground *string `json:"dangerForeground" yaml:"dangerForeground"`
	// The color that applies to the names of fields that are identified as dimensions.
	Dimension *string `json:"dimension" yaml:"dimension"`
	// The foreground color that applies to any text or other elements that appear over the dimension color.
	DimensionForeground *string `json:"dimensionForeground" yaml:"dimensionForeground"`
	// The color that applies to the names of fields that are identified as measures.
	Measure *string `json:"measure" yaml:"measure"`
	// The foreground color that applies to any text or other elements that appear over the measure color.
	MeasureForeground *string `json:"measureForeground" yaml:"measureForeground"`
	// The background color that applies to visuals and other high emphasis UI.
	PrimaryBackground *string `json:"primaryBackground" yaml:"primaryBackground"`
	// The color of text and other foreground elements that appear over the primary background regions, such as grid lines, borders, table banding, icons, and so on.
	PrimaryForeground *string `json:"primaryForeground" yaml:"primaryForeground"`
	// The background color that applies to the sheet background and sheet controls.
	SecondaryBackground *string `json:"secondaryBackground" yaml:"secondaryBackground"`
	// The foreground color that applies to any sheet title, sheet control text, or UI that appears over the secondary background.
	SecondaryForeground *string `json:"secondaryForeground" yaml:"secondaryForeground"`
	// The color that applies to success messages, for example the check mark for a successful download.
	Success *string `json:"success" yaml:"success"`
	// The foreground color that applies to any text or other elements that appear over the success color.
	SuccessForeground *string `json:"successForeground" yaml:"successForeground"`
	// This color that applies to warning and informational messages.
	Warning *string `json:"warning" yaml:"warning"`
	// The foreground color that applies to any text or other elements that appear over the warning color.
	WarningForeground *string `json:"warningForeground" yaml:"warningForeground"`
}

The theme colors that apply to UI and to charts, excluding data colors.

The colors description is a hexadecimal color code that consists of six alphanumerical characters, prefixed with `#` , for example #37BFF5. For more information, see [Using Themes in Amazon QuickSight](https://docs.aws.amazon.com/quicksight/latest/user/themes-in-quicksight.html) in the *Amazon QuickSight User Guide.*

TODO: EXAMPLE

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.