Class CfnTemplate
Creates a template from an existing Amazon QuickSight analysis or template.
Inherited Members
Namespace: Amazon.CDK.AWS.QuickSight
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnTemplate : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnTemplate
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
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.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-template.html
CloudformationResource: AWS::QuickSight::Template
ExampleMetadata: fixture=_generated
Synopsis
Constructors
CfnTemplate(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnTemplate(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnTemplate(Construct, String, ICfnTemplateProps) |
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 | |
AttrVersionCreatedTime | |
AttrVersionDataSetConfigurations | |
AttrVersionDescription | |
AttrVersionErrors | |
AttrVersionSheets | |
AttrVersionSourceEntityArn | |
AttrVersionStatus | |
AttrVersionThemeArn | |
AttrVersionVersionNumber | |
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 | |
Definition | |
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. |
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
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnTemplate(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnTemplate(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnTemplate(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnTemplate(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnTemplate(Construct, String, ICfnTemplateProps)
public CfnTemplate(Construct scope, string id, ICfnTemplateProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnTemplateProps
Resource properties.
Properties
AttrArn
The Amazon Resource Name (ARN) of the template.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrCreatedTime
The time this template was created.
public virtual string AttrCreatedTime { get; }
Property Value
System.String
Remarks
CloudformationAttribute: CreatedTime
AttrLastUpdatedTime
The time this template was last updated.
public virtual string AttrLastUpdatedTime { get; }
Property Value
System.String
Remarks
CloudformationAttribute: LastUpdatedTime
AttrVersion
public virtual IResolvable AttrVersion { get; }
Property Value
Remarks
CloudformationAttribute: Version
AttrVersionCreatedTime
public virtual string AttrVersionCreatedTime { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Version.CreatedTime
AttrVersionDataSetConfigurations
public virtual IResolvable AttrVersionDataSetConfigurations { get; }
Property Value
Remarks
CloudformationAttribute: Version.DataSetConfigurations
AttrVersionDescription
public virtual string AttrVersionDescription { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Version.Description
AttrVersionErrors
public virtual IResolvable AttrVersionErrors { get; }
Property Value
Remarks
CloudformationAttribute: Version.Errors
AttrVersionSheets
public virtual IResolvable AttrVersionSheets { get; }
Property Value
Remarks
CloudformationAttribute: Version.Sheets
AttrVersionSourceEntityArn
public virtual string AttrVersionSourceEntityArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Version.SourceEntityArn
AttrVersionStatus
public virtual string AttrVersionStatus { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Version.Status
AttrVersionThemeArn
public virtual string AttrVersionThemeArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Version.ThemeArn
AttrVersionVersionNumber
public virtual IResolvable AttrVersionVersionNumber { get; }
Property Value
Remarks
CloudformationAttribute: Version.VersionNumber
AwsAccountId
The ID for the AWS account that the group is in.
public virtual string AwsAccountId { get; set; }
Property Value
System.String
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Definition
public virtual object Definition { get; set; }
Property Value
System.Object
Name
A display name for the template.
public virtual string Name { get; set; }
Property Value
System.String
Permissions
A list of resource permissions to be set on the template.
public virtual object Permissions { get; set; }
Property Value
System.Object
SourceEntity
The entity that you are using as a source when you create the template.
public virtual object SourceEntity { get; set; }
Property Value
System.Object
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
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[]
TemplateId
An ID for the template that you want to create.
public virtual string TemplateId { get; set; }
Property Value
System.String
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
System.Object
VersionDescription
A description of the current template version being created.
public virtual string VersionDescription { get; set; }
Property Value
System.String
Methods
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.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>