Class CfnTemplate

Creates a template from an existing Quick analysis or template.

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnTemplate
Implements
IConstruct
IDependable
Inherited Members
Namespace: Amazon.CDK.AWS.QuickSight
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnTemplate : CfnResource, IInspectable, ITemplateRef, IConstruct, IDependable, IEnvironmentAware, ITaggable
Syntax (vb)
Public Class CfnTemplate Inherits CfnResource Implements IInspectable, ITemplateRef, IConstruct, IDependable, IEnvironmentAware, ITaggable
Remarks

You can use the resulting template to create a dashboard.

A template is an entity in Quick 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.

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

CloudformationResource: AWS::QuickSight::Template

ExampleMetadata: fixture=_generated

Synopsis

Constructors

CfnTemplate(Construct, string, ICfnTemplateProps)

Create a new AWS::QuickSight::Template.

Properties

AttrArn

The Amazon Resource Name (ARN) of the template.
AttrCreatedTime

The time this template was created.
AttrLastUpdatedTime

The time this template was last updated.
AttrVersion

<p>A version of a template.</p>.
AttrVersionCreatedTime

Creates a template from an existing Quick analysis or template.
AttrVersionDataSetConfigurations

Creates a template from an existing Quick analysis or template.
AttrVersionDescription

Creates a template from an existing Quick analysis or template.
AttrVersionErrors

Creates a template from an existing Quick analysis or template.
AttrVersionSheets

Creates a template from an existing Quick analysis or template.
AttrVersionSourceEntityArn

Creates a template from an existing Quick analysis or template.
AttrVersionStatus

Creates a template from an existing Quick analysis or template.
AttrVersionThemeArn

Creates a template from an existing Quick analysis or template.
AttrVersionVersionNumber

Creates a template from an existing Quick analysis or template.
AwsAccountId

The ID for the AWS account that the group is in.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties

Creates a template from an existing Quick analysis or template.
CfnPropertyNames

Creates a template from an existing Quick analysis or template.
Definition

Creates a template from an existing Quick analysis or template.
Name

A display name for the template.
Permissions

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

The entity that you are using as a source when you create the template.
Tags

Tag Manager which manages the tags for this resource.
TagsRaw

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

An ID for the template that you want to create.
TemplateRef

A reference to a Template resource.
ValidationStrategy

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

A description of the current template version being created.

Methods

ArnForTemplate(ITemplateRef)

Creates a template from an existing Quick analysis or template.
Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
IsCfnTemplate(object)

Checks whether the given object is a CfnTemplate.
RenderProperties(IDictionary<string, object>)

Creates a template from an existing Quick analysis or template.

Constructors

CfnTemplate(Construct, string, ICfnTemplateProps)

Create a new AWS::QuickSight::Template.

public CfnTemplate(Construct scope, string id, ICfnTemplateProps props)
Parameters
scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnTemplateProps

Resource properties.

Remarks

You can use the resulting template to create a dashboard.

A template is an entity in Quick 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.

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

CloudformationResource: AWS::QuickSight::Template

ExampleMetadata: fixture=_generated

Properties

AttrArn

The Amazon Resource Name (ARN) of the template.

public virtual string AttrArn { get; }
Property Value

string

Remarks

CloudformationAttribute: Arn

AttrCreatedTime

The time this template was created.

public virtual string AttrCreatedTime { get; }
Property Value

string

Remarks

CloudformationAttribute: CreatedTime

AttrLastUpdatedTime

The time this template was last updated.

public virtual string AttrLastUpdatedTime { get; }
Property Value

string

Remarks

CloudformationAttribute: LastUpdatedTime

AttrVersion

<p>A version of a template.</p>.

public virtual IResolvable AttrVersion { get; }
Property Value

IResolvable

Remarks

CloudformationAttribute: Version

AttrVersionCreatedTime

Creates a template from an existing Quick analysis or template.

public virtual string AttrVersionCreatedTime { get; }
Property Value

string

Remarks

CloudformationAttribute: Version.CreatedTime

AttrVersionDataSetConfigurations

Creates a template from an existing Quick analysis or template.

public virtual IResolvable AttrVersionDataSetConfigurations { get; }
Property Value

IResolvable

Remarks

CloudformationAttribute: Version.DataSetConfigurations

AttrVersionDescription

Creates a template from an existing Quick analysis or template.

public virtual string AttrVersionDescription { get; }
Property Value

string

Remarks

CloudformationAttribute: Version.Description

AttrVersionErrors

Creates a template from an existing Quick analysis or template.

public virtual IResolvable AttrVersionErrors { get; }
Property Value

IResolvable

Remarks

CloudformationAttribute: Version.Errors

AttrVersionSheets

Creates a template from an existing Quick analysis or template.

public virtual IResolvable AttrVersionSheets { get; }
Property Value

IResolvable

Remarks

CloudformationAttribute: Version.Sheets

AttrVersionSourceEntityArn

Creates a template from an existing Quick analysis or template.

public virtual string AttrVersionSourceEntityArn { get; }
Property Value

string

Remarks

CloudformationAttribute: Version.SourceEntityArn

AttrVersionStatus

Creates a template from an existing Quick analysis or template.

public virtual string AttrVersionStatus { get; }
Property Value

string

Remarks

CloudformationAttribute: Version.Status

AttrVersionThemeArn

Creates a template from an existing Quick analysis or template.

public virtual string AttrVersionThemeArn { get; }
Property Value

string

Remarks

CloudformationAttribute: Version.ThemeArn

AttrVersionVersionNumber

Creates a template from an existing Quick analysis or template.

public virtual IResolvable AttrVersionVersionNumber { get; }
Property Value

IResolvable

Remarks

CloudformationAttribute: Version.VersionNumber

AwsAccountId

The ID for the AWS account that the group is in.

public virtual string AwsAccountId { get; set; }
Property Value

string

Remarks

You can use the resulting template to create a dashboard.

A template is an entity in Quick 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.

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

CloudformationResource: AWS::QuickSight::Template

ExampleMetadata: fixture=_generated

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

string

Remarks

You can use the resulting template to create a dashboard.

A template is an entity in Quick 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.

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

CloudformationResource: AWS::QuickSight::Template

ExampleMetadata: fixture=_generated

CfnProperties

Creates a template from an existing Quick analysis or template.

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

IDictionary<string, object>

Overrides
Remarks

You can use the resulting template to create a dashboard.

A template is an entity in Quick 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.

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

CloudformationResource: AWS::QuickSight::Template

ExampleMetadata: fixture=_generated

CfnPropertyNames

Creates a template from an existing Quick analysis or template.

protected override IDictionary<string, string> CfnPropertyNames { get; }
Property Value

IDictionary<string, string>

Overrides
Remarks

You can use the resulting template to create a dashboard.

A template is an entity in Quick 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.

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

CloudformationResource: AWS::QuickSight::Template

ExampleMetadata: fixture=_generated

Definition

Creates a template from an existing Quick analysis or template.

public virtual object? Definition { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or CfnTemplate.ITemplateVersionDefinitionProperty

Name

A display name for the template.

public virtual string? Name { get; set; }
Property Value

string

Remarks

You can use the resulting template to create a dashboard.

A template is an entity in Quick 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.

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

CloudformationResource: AWS::QuickSight::Template

ExampleMetadata: fixture=_generated

Permissions

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

public virtual object? Permissions { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or (either IResolvable or CfnTemplate.IResourcePermissionProperty)[]

SourceEntity

The entity that you are using as a source when you create the template.

public virtual object? SourceEntity { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or CfnTemplate.ITemplateSourceEntityProperty

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }
Property Value

TagManager

Remarks

You can use the resulting template to create a dashboard.

A template is an entity in Quick 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.

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

CloudformationResource: AWS::QuickSight::Template

ExampleMetadata: fixture=_generated

TagsRaw

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

public virtual ICfnTag[]? TagsRaw { get; set; }
Property Value

ICfnTag[]

Remarks

You can use the resulting template to create a dashboard.

A template is an entity in Quick 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.

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

CloudformationResource: AWS::QuickSight::Template

ExampleMetadata: fixture=_generated

TemplateId

An ID for the template that you want to create.

public virtual string TemplateId { get; set; }
Property Value

string

Remarks

You can use the resulting template to create a dashboard.

A template is an entity in Quick 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.

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

CloudformationResource: AWS::QuickSight::Template

ExampleMetadata: fixture=_generated

TemplateRef

A reference to a Template resource.

public virtual ITemplateReference TemplateRef { get; }
Property Value

ITemplateReference

Remarks

You can use the resulting template to create a dashboard.

A template is an entity in Quick 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.

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

CloudformationResource: AWS::QuickSight::Template

ExampleMetadata: fixture=_generated

ValidationStrategy

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

public virtual object? ValidationStrategy { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or CfnTemplate.IValidationStrategyProperty

VersionDescription

A description of the current template version being created.

public virtual string? VersionDescription { get; set; }
Property Value

string

Remarks

You can use the resulting template to create a dashboard.

A template is an entity in Quick 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.

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

CloudformationResource: AWS::QuickSight::Template

ExampleMetadata: fixture=_generated

Methods

ArnForTemplate(ITemplateRef)

Creates a template from an existing Quick analysis or template.

public static string ArnForTemplate(ITemplateRef resource)
Parameters
resource ITemplateRef
Returns

string

Remarks

You can use the resulting template to create a dashboard.

A template is an entity in Quick 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.

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

CloudformationResource: AWS::QuickSight::Template

ExampleMetadata: fixture=_generated

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

You can use the resulting template to create a dashboard.

A template is an entity in Quick 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.

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

CloudformationResource: AWS::QuickSight::Template

ExampleMetadata: fixture=_generated

IsCfnTemplate(object)

Checks whether the given object is a CfnTemplate.

public static bool IsCfnTemplate(object x)
Parameters
x object
Returns

bool

Remarks

You can use the resulting template to create a dashboard.

A template is an entity in Quick 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.

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

CloudformationResource: AWS::QuickSight::Template

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Creates a template from an existing Quick analysis or template.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props IDictionary<string, object>
Returns

IDictionary<string, object>

Overrides
Remarks

You can use the resulting template to create a dashboard.

A template is an entity in Quick 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.

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

CloudformationResource: AWS::QuickSight::Template

ExampleMetadata: fixture=_generated

Implements

Constructs.IConstruct
Constructs.IDependable