CfnTemplate

class aws_cdk.aws_quicksight.CfnTemplate(scope, id, *, aws_account_id, source_entity, template_id, name=None, permissions=None, tags=None, version_description=None)

Bases: CfnResource

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.

CloudformationResource

AWS::QuickSight::Template

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-template.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

cfn_template = quicksight.CfnTemplate(self, "MyCfnTemplate",
    aws_account_id="awsAccountId",
    source_entity=quicksight.CfnTemplate.TemplateSourceEntityProperty(
        source_analysis=quicksight.CfnTemplate.TemplateSourceAnalysisProperty(
            arn="arn",
            data_set_references=[quicksight.CfnTemplate.DataSetReferenceProperty(
                data_set_arn="dataSetArn",
                data_set_placeholder="dataSetPlaceholder"
            )]
        ),
        source_template=quicksight.CfnTemplate.TemplateSourceTemplateProperty(
            arn="arn"
        )
    ),
    template_id="templateId",

    # the properties below are optional
    name="name",
    permissions=[quicksight.CfnTemplate.ResourcePermissionProperty(
        actions=["actions"],
        principal="principal"
    )],
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    version_description="versionDescription"
)

Create a new AWS::QuickSight::Template.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • aws_account_id (str) – 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.

  • source_entity (Union[TemplateSourceEntityProperty, Dict[str, Any], IResolvable]) – 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.

  • template_id (str) – An ID for the template that you want to create. This template is unique per AWS Region ; in each AWS account.

  • name (Optional[str]) – A display name for the template.

  • permissions (Union[IResolvable, Sequence[Union[ResourcePermissionProperty, Dict[str, Any], IResolvable]], None]) – A list of resource permissions to be set on the template.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

  • version_description (Optional[str]) – 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.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_dependency(target)

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.

Parameters

target (CfnResource) –

Return type

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters

target (CfnResource) –

Deprecated

use addDependency

Stability

deprecated

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

Return type

None

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.

add_override(path, 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:

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"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.

Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

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:

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type

None

get_att(attribute_name, type_hint=None)

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.

Parameters
  • attribute_name (str) – The name of the attribute.

  • type_hint (Optional[ResolutionTypeHint]) –

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

Return type

Any

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)

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Return type

None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type

List[Union[CfnResource, Stack]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type

List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

remove_dependency(target)

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.

Parameters

target (CfnResource) –

Return type

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters
Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Returns

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::QuickSight::Template'
attr_arn

The Amazon Resource Name (ARN) of the template.

CloudformationAttribute

Arn

attr_created_time

The time this template was created.

CloudformationAttribute

CreatedTime

attr_last_updated_time

The time this template was last updated.

CloudformationAttribute

LastUpdatedTime

attr_version_created_time

Version.CreatedTime

Type

cloudformationAttribute

attr_version_data_set_configurations

Version.DataSetConfigurations

Type

cloudformationAttribute

attr_version_description

Version.Description

Type

cloudformationAttribute

attr_version_errors

Version.Errors

Type

cloudformationAttribute

attr_version_sheets

Version.Sheets

Type

cloudformationAttribute

attr_version_source_entity_arn

Version.SourceEntityArn

Type

cloudformationAttribute

attr_version_status

Version.Status

Type

cloudformationAttribute

attr_version_theme_arn

Version.ThemeArn

Type

cloudformationAttribute

attr_version_version_number

Version.VersionNumber

Type

cloudformationAttribute

aws_account_id

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-template.html#cfn-quicksight-template-awsaccountid

cfn_options

Options for this resource, such as condition, update policy etc.

cfn_resource_type

AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

logical_id

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).

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

name

A display name for the template.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-template.html#cfn-quicksight-template-name

node

The tree node.

permissions

A list of resource permissions to be set on the template.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-template.html#cfn-quicksight-template-permissions

ref

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 }).

source_entity

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-template.html#cfn-quicksight-template-sourceentity

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags

Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-template.html#cfn-quicksight-template-tags

template_id

An ID for the template that you want to create.

This template is unique per AWS Region ; in each AWS account.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-template.html#cfn-quicksight-template-templateid

version_description

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-template.html#cfn-quicksight-template-versiondescription

Static Methods

classmethod is_cfn_element(x)

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.

Parameters

x (Any) –

Return type

bool

Returns

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

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

x (Any) – Any object.

Return type

bool

Returns

true if x is an object created from a class which extends Construct.

ColumnGroupColumnSchemaProperty

class CfnTemplate.ColumnGroupColumnSchemaProperty(*, name=None)

Bases: object

A structure describing the name, data type, and geographic role of the columns.

Parameters

name (Optional[str]) – The name of the column group’s column schema.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columngroupcolumnschema.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

column_group_column_schema_property = quicksight.CfnTemplate.ColumnGroupColumnSchemaProperty(
    name="name"
)

Attributes

name

The name of the column group’s column schema.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columngroupcolumnschema.html#cfn-quicksight-template-columngroupcolumnschema-name

ColumnGroupSchemaProperty

class CfnTemplate.ColumnGroupSchemaProperty(*, column_group_column_schema_list=None, name=None)

Bases: object

The column group schema.

Parameters
  • column_group_column_schema_list (Union[IResolvable, Sequence[Union[ColumnGroupColumnSchemaProperty, Dict[str, Any], IResolvable]], None]) – A structure containing the list of schemas for column group columns.

  • name (Optional[str]) – The name of the column group schema.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columngroupschema.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

column_group_schema_property = quicksight.CfnTemplate.ColumnGroupSchemaProperty(
    column_group_column_schema_list=[quicksight.CfnTemplate.ColumnGroupColumnSchemaProperty(
        name="name"
    )],
    name="name"
)

Attributes

column_group_column_schema_list

A structure containing the list of schemas for column group columns.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columngroupschema.html#cfn-quicksight-template-columngroupschema-columngroupcolumnschemalist

name

The name of the column group schema.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columngroupschema.html#cfn-quicksight-template-columngroupschema-name

ColumnSchemaProperty

class CfnTemplate.ColumnSchemaProperty(*, data_type=None, geographic_role=None, name=None)

Bases: object

The column schema.

Parameters
  • data_type (Optional[str]) – The data type of the column schema.

  • geographic_role (Optional[str]) – The geographic role of the column schema.

  • name (Optional[str]) – The name of the column schema.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columnschema.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

column_schema_property = quicksight.CfnTemplate.ColumnSchemaProperty(
    data_type="dataType",
    geographic_role="geographicRole",
    name="name"
)

Attributes

data_type

The data type of the column schema.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columnschema.html#cfn-quicksight-template-columnschema-datatype

geographic_role

The geographic role of the column schema.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columnschema.html#cfn-quicksight-template-columnschema-geographicrole

name

The name of the column schema.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-columnschema.html#cfn-quicksight-template-columnschema-name

DataSetConfigurationProperty

class CfnTemplate.DataSetConfigurationProperty(*, column_group_schema_list=None, data_set_schema=None, placeholder=None)

Bases: object

Dataset configuration.

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datasetconfiguration.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

data_set_configuration_property = quicksight.CfnTemplate.DataSetConfigurationProperty(
    column_group_schema_list=[quicksight.CfnTemplate.ColumnGroupSchemaProperty(
        column_group_column_schema_list=[quicksight.CfnTemplate.ColumnGroupColumnSchemaProperty(
            name="name"
        )],
        name="name"
    )],
    data_set_schema=quicksight.CfnTemplate.DataSetSchemaProperty(
        column_schema_list=[quicksight.CfnTemplate.ColumnSchemaProperty(
            data_type="dataType",
            geographic_role="geographicRole",
            name="name"
        )]
    ),
    placeholder="placeholder"
)

Attributes

column_group_schema_list

A structure containing the list of column group schemas.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datasetconfiguration.html#cfn-quicksight-template-datasetconfiguration-columngroupschemalist

data_set_schema

Dataset schema.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datasetconfiguration.html#cfn-quicksight-template-datasetconfiguration-datasetschema

placeholder

Placeholder.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datasetconfiguration.html#cfn-quicksight-template-datasetconfiguration-placeholder

DataSetReferenceProperty

class CfnTemplate.DataSetReferenceProperty(*, data_set_arn, data_set_placeholder)

Bases: object

Dataset reference.

Parameters
  • data_set_arn (str) – Dataset Amazon Resource Name (ARN).

  • data_set_placeholder (str) – Dataset placeholder.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datasetreference.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

data_set_reference_property = quicksight.CfnTemplate.DataSetReferenceProperty(
    data_set_arn="dataSetArn",
    data_set_placeholder="dataSetPlaceholder"
)

Attributes

data_set_arn

Dataset Amazon Resource Name (ARN).

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datasetreference.html#cfn-quicksight-template-datasetreference-datasetarn

data_set_placeholder

Dataset placeholder.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datasetreference.html#cfn-quicksight-template-datasetreference-datasetplaceholder

DataSetSchemaProperty

class CfnTemplate.DataSetSchemaProperty(*, column_schema_list=None)

Bases: object

Dataset schema.

Parameters

column_schema_list (Union[IResolvable, Sequence[Union[ColumnSchemaProperty, Dict[str, Any], IResolvable]], None]) – A structure containing the list of column schemas.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datasetschema.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

data_set_schema_property = quicksight.CfnTemplate.DataSetSchemaProperty(
    column_schema_list=[quicksight.CfnTemplate.ColumnSchemaProperty(
        data_type="dataType",
        geographic_role="geographicRole",
        name="name"
    )]
)

Attributes

column_schema_list

A structure containing the list of column schemas.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-datasetschema.html#cfn-quicksight-template-datasetschema-columnschemalist

ResourcePermissionProperty

class CfnTemplate.ResourcePermissionProperty(*, actions, principal)

Bases: object

Permission for the resource.

Parameters
  • actions (Sequence[str]) – The IAM action to grant or revoke permissions on.

  • principal (str) – 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.)

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-resourcepermission.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

resource_permission_property = quicksight.CfnTemplate.ResourcePermissionProperty(
    actions=["actions"],
    principal="principal"
)

Attributes

actions

The IAM action to grant or revoke permissions on.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-resourcepermission.html#cfn-quicksight-template-resourcepermission-actions

principal

.

  • 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.)

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-resourcepermission.html#cfn-quicksight-template-resourcepermission-principal

Type

The Amazon Resource Name (ARN) of the principal. This can be one of the following

SheetProperty

class CfnTemplate.SheetProperty(*, name=None, sheet_id=None)

Bases: object

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.

Parameters
  • name (Optional[str]) – The name of a sheet. This name is displayed on the sheet’s tab in the Amazon QuickSight console.

  • sheet_id (Optional[str]) – The unique identifier associated with a sheet.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheet.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

sheet_property = quicksight.CfnTemplate.SheetProperty(
    name="name",
    sheet_id="sheetId"
)

Attributes

name

The name of a sheet.

This name is displayed on the sheet’s tab in the Amazon QuickSight console.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheet.html#cfn-quicksight-template-sheet-name

sheet_id

The unique identifier associated with a sheet.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-sheet.html#cfn-quicksight-template-sheet-sheetid

TemplateErrorProperty

class CfnTemplate.TemplateErrorProperty(*, message=None, type=None)

Bases: object

List of errors that occurred when the template version creation failed.

Parameters
  • message (Optional[str]) – Description of the error type.

  • type (Optional[str]) – Type of error.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateerror.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

template_error_property = quicksight.CfnTemplate.TemplateErrorProperty(
    message="message",
    type="type"
)

Attributes

message

Description of the error type.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateerror.html#cfn-quicksight-template-templateerror-message

type

Type of error.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateerror.html#cfn-quicksight-template-templateerror-type

TemplateSourceAnalysisProperty

class CfnTemplate.TemplateSourceAnalysisProperty(*, arn, data_set_references)

Bases: object

The source analysis of the template.

Parameters
  • arn (str) – The Amazon Resource Name (ARN) of the resource.

  • data_set_references (Union[IResolvable, Sequence[Union[DataSetReferenceProperty, Dict[str, Any], IResolvable]]]) – A structure containing information about the dataset references used as placeholders in the template.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templatesourceanalysis.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

template_source_analysis_property = quicksight.CfnTemplate.TemplateSourceAnalysisProperty(
    arn="arn",
    data_set_references=[quicksight.CfnTemplate.DataSetReferenceProperty(
        data_set_arn="dataSetArn",
        data_set_placeholder="dataSetPlaceholder"
    )]
)

Attributes

arn

The Amazon Resource Name (ARN) of the resource.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templatesourceanalysis.html#cfn-quicksight-template-templatesourceanalysis-arn

data_set_references

A structure containing information about the dataset references used as placeholders in the template.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templatesourceanalysis.html#cfn-quicksight-template-templatesourceanalysis-datasetreferences

TemplateSourceEntityProperty

class CfnTemplate.TemplateSourceEntityProperty(*, source_analysis=None, source_template=None)

Bases: object

The source entity of the template.

Parameters
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templatesourceentity.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

template_source_entity_property = quicksight.CfnTemplate.TemplateSourceEntityProperty(
    source_analysis=quicksight.CfnTemplate.TemplateSourceAnalysisProperty(
        arn="arn",
        data_set_references=[quicksight.CfnTemplate.DataSetReferenceProperty(
            data_set_arn="dataSetArn",
            data_set_placeholder="dataSetPlaceholder"
        )]
    ),
    source_template=quicksight.CfnTemplate.TemplateSourceTemplateProperty(
        arn="arn"
    )
)

Attributes

source_analysis

The source analysis, if it is based on an analysis.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templatesourceentity.html#cfn-quicksight-template-templatesourceentity-sourceanalysis

source_template

The source template, if it is based on an template.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templatesourceentity.html#cfn-quicksight-template-templatesourceentity-sourcetemplate

TemplateSourceTemplateProperty

class CfnTemplate.TemplateSourceTemplateProperty(*, arn)

Bases: object

The source template of the template.

Parameters

arn (str) – The Amazon Resource Name (ARN) of the resource.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templatesourcetemplate.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

template_source_template_property = quicksight.CfnTemplate.TemplateSourceTemplateProperty(
    arn="arn"
)

Attributes

arn

The Amazon Resource Name (ARN) of the resource.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templatesourcetemplate.html#cfn-quicksight-template-templatesourcetemplate-arn

TemplateVersionProperty

class CfnTemplate.TemplateVersionProperty(*, created_time=None, data_set_configurations=None, description=None, errors=None, sheets=None, source_entity_arn=None, status=None, theme_arn=None, version_number=None)

Bases: object

A version of a template.

Parameters
  • created_time (Optional[str]) – The time that this template version was created.

  • data_set_configurations (Union[IResolvable, Sequence[Union[DataSetConfigurationProperty, Dict[str, Any], IResolvable]], None]) – Schema of the dataset identified by the placeholder. Any dashboard created from this template should be bound to new datasets matching the same schema described through this API operation.

  • description (Optional[str]) – The description of the template.

  • errors (Union[IResolvable, Sequence[Union[TemplateErrorProperty, Dict[str, Any], IResolvable]], None]) – Errors associated with this template version.

  • sheets (Union[IResolvable, Sequence[Union[SheetProperty, Dict[str, Any], IResolvable]], None]) – A list of the associated sheets with the unique identifier and name of each sheet.

  • source_entity_arn (Optional[str]) – The Amazon Resource Name (ARN) of an analysis or template that was used to create this template.

  • status (Optional[str]) – The status that is associated with the template. - CREATION_IN_PROGRESS - CREATION_SUCCESSFUL - CREATION_FAILED - UPDATE_IN_PROGRESS - UPDATE_SUCCESSFUL - UPDATE_FAILED - DELETED

  • theme_arn (Optional[str]) – The ARN of the theme associated with this version of the template.

  • version_number (Union[int, float, None]) – The version number of the template version.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateversion.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

template_version_property = quicksight.CfnTemplate.TemplateVersionProperty(
    created_time="createdTime",
    data_set_configurations=[quicksight.CfnTemplate.DataSetConfigurationProperty(
        column_group_schema_list=[quicksight.CfnTemplate.ColumnGroupSchemaProperty(
            column_group_column_schema_list=[quicksight.CfnTemplate.ColumnGroupColumnSchemaProperty(
                name="name"
            )],
            name="name"
        )],
        data_set_schema=quicksight.CfnTemplate.DataSetSchemaProperty(
            column_schema_list=[quicksight.CfnTemplate.ColumnSchemaProperty(
                data_type="dataType",
                geographic_role="geographicRole",
                name="name"
            )]
        ),
        placeholder="placeholder"
    )],
    description="description",
    errors=[quicksight.CfnTemplate.TemplateErrorProperty(
        message="message",
        type="type"
    )],
    sheets=[quicksight.CfnTemplate.SheetProperty(
        name="name",
        sheet_id="sheetId"
    )],
    source_entity_arn="sourceEntityArn",
    status="status",
    theme_arn="themeArn",
    version_number=123
)

Attributes

created_time

The time that this template version was created.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateversion.html#cfn-quicksight-template-templateversion-createdtime

data_set_configurations

Schema of the dataset identified by the placeholder.

Any dashboard created from this template should be bound to new datasets matching the same schema described through this API operation.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateversion.html#cfn-quicksight-template-templateversion-datasetconfigurations

description

The description of the template.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateversion.html#cfn-quicksight-template-templateversion-description

errors

Errors associated with this template version.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateversion.html#cfn-quicksight-template-templateversion-errors

sheets

A list of the associated sheets with the unique identifier and name of each sheet.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateversion.html#cfn-quicksight-template-templateversion-sheets

source_entity_arn

The Amazon Resource Name (ARN) of an analysis or template that was used to create this template.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateversion.html#cfn-quicksight-template-templateversion-sourceentityarn

status

The status that is associated with the template.

  • CREATION_IN_PROGRESS

  • CREATION_SUCCESSFUL

  • CREATION_FAILED

  • UPDATE_IN_PROGRESS

  • UPDATE_SUCCESSFUL

  • UPDATE_FAILED

  • DELETED

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateversion.html#cfn-quicksight-template-templateversion-status

theme_arn

The ARN of the theme associated with this version of the template.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateversion.html#cfn-quicksight-template-templateversion-themearn

version_number

The version number of the template version.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-templateversion.html#cfn-quicksight-template-templateversion-versionnumber