CfnTemplateProps

class aws_cdk.aws_quicksight.CfnTemplateProps(*, aws_account_id, template_id, definition=None, name=None, permissions=None, source_entity=None, tags=None, validation_strategy=None, version_description=None)

Bases: object

Properties for defining a CfnTemplate.

Parameters:

  • 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 Quick Sight account.

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

  • definition (Union[IResolvable, TemplateVersionDefinitionProperty, Dict[str, Any], None])

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

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

  • source_entity (Union[IResolvable, TemplateSourceEntityProperty, Dict[str, Any], None]) – 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 Quick Sight-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. Either a SourceEntity or a Definition must be provided in order for the request to be valid.

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

  • validation_strategy (Union[IResolvable, ValidationStrategyProperty, Dict[str, Any], None]) – The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to LENIENT , validation is skipped for specific errors.

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

See:

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

ExampleMetadata:

fixture=_generated

Example:

.. rubric:: Attributes
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 Quick Sight account.

See:

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

definition

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

Type:

see

name

A display name for the template.

See:

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

permissions

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

See:

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

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 Quick Sight-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.

Either a SourceEntity or a Definition must be provided in order for the request to be valid.

See:

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

tags

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

See:

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.

See:

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

validation_strategy

The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects.

When you set this value to LENIENT , validation is skipped for specific errors.

See:

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

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.

See:

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