Class CfnTemplateProps
Properties for defining a CfnTemplate
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.QuickSight
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnTemplateProps : Object, ICfnTemplateProps
Syntax (vb)
Public Class CfnTemplateProps
Inherits Object
Implements ICfnTemplateProps
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-template.html
ExampleMetadata: fixture=_generated
Synopsis
Constructors
CfnTemplateProps() |
Properties
AwsAccountId | The ID for the AWS account that the group is in. |
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 | 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. |
Constructors
CfnTemplateProps()
public CfnTemplateProps()
Properties
AwsAccountId
The ID for the AWS account that the group is in.
public string AwsAccountId { get; set; }
Property Value
System.String
Remarks
You use the ID for the AWS account that contains your Amazon QuickSight account.
Definition
public object Definition { get; set; }
Property Value
System.Object
Remarks
Name
A display name for the template.
public string Name { get; set; }
Property Value
System.String
Remarks
Permissions
A list of resource permissions to be set on the template.
public object Permissions { get; set; }
Property Value
System.Object
Remarks
SourceEntity
The entity that you are using as a source when you create the template.
public object SourceEntity { get; set; }
Property Value
System.Object
Remarks
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.
Either a SourceEntity
or a Definition
must be provided in order for the request to be valid.
Tags
Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
public ICfnTag[] Tags { get; set; }
Property Value
ICfnTag[]
Remarks
TemplateId
An ID for the template that you want to create.
public string TemplateId { get; set; }
Property Value
System.String
Remarks
This template is unique per AWS Region ; in each AWS account.
ValidationStrategy
The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects.
public object ValidationStrategy { get; set; }
Property Value
System.Object
Remarks
When you set this value to LENIENT
, validation is skipped for specific errors.
VersionDescription
A description of the current template version being created.
public string VersionDescription { get; set; }
Property Value
System.String
Remarks
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.