@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
date="2023-01-25T18:28:59.914Z")
public class CfnTemplate
extends CfnResource
implements IInspectable
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.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.quicksight.*;
CfnTemplate cfnTemplate = CfnTemplate.Builder.create(this, "MyCfnTemplate")
.awsAccountId("awsAccountId")
.sourceEntity(TemplateSourceEntityProperty.builder()
.sourceAnalysis(TemplateSourceAnalysisProperty.builder()
.arn("arn")
.dataSetReferences(List.of(DataSetReferenceProperty.builder()
.dataSetArn("dataSetArn")
.dataSetPlaceholder("dataSetPlaceholder")
.build()))
.build())
.sourceTemplate(TemplateSourceTemplateProperty.builder()
.arn("arn")
.build())
.build())
.templateId("templateId")
// the properties below are optional
.name("name")
.permissions(List.of(ResourcePermissionProperty.builder()
.actions(List.of("actions"))
.principal("principal")
.build()))
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.versionDescription("versionDescription")
.build();
| Modifier and Type | Class and Description |
|---|---|
static class |
CfnTemplate.Builder
A fluent builder for
CfnTemplate. |
static interface |
CfnTemplate.ColumnGroupColumnSchemaProperty
A structure describing the name, data type, and geographic role of the columns.
|
static interface |
CfnTemplate.ColumnGroupSchemaProperty
The column group schema.
|
static interface |
CfnTemplate.ColumnSchemaProperty
The column schema.
|
static interface |
CfnTemplate.DataSetConfigurationProperty
Dataset configuration.
|
static interface |
CfnTemplate.DataSetReferenceProperty
Dataset reference.
|
static interface |
CfnTemplate.DataSetSchemaProperty
Dataset schema.
|
static interface |
CfnTemplate.ResourcePermissionProperty
Permission for the resource.
|
static interface |
CfnTemplate.SheetProperty
A *sheet* , which is an object that contains a set of visuals that are viewed together on one page in Amazon QuickSight.
|
static interface |
CfnTemplate.TemplateErrorProperty
List of errors that occurred when the template version creation failed.
|
static interface |
CfnTemplate.TemplateSourceAnalysisProperty
The source analysis of the template.
|
static interface |
CfnTemplate.TemplateSourceEntityProperty
The source entity of the template.
|
static interface |
CfnTemplate.TemplateSourceTemplateProperty
The source template of the template.
|
static interface |
CfnTemplate.TemplateVersionProperty
A version of a template.
|
IInspectable.Jsii$Default, IInspectable.Jsii$ProxyIConstruct.Jsii$Default| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
| Modifier | Constructor and Description |
|---|---|
|
CfnTemplate(Construct scope,
java.lang.String id,
CfnTemplateProps props)
Create a new `AWS::QuickSight::Template`.
|
protected |
CfnTemplate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnTemplate(software.amazon.jsii.JsiiObjectRef objRef) |
| Modifier and Type | Method and Description |
|---|---|
java.lang.String |
getAttrArn()
The Amazon Resource Name (ARN) of the template.
|
java.lang.String |
getAttrCreatedTime()
The time this template was created.
|
java.lang.String |
getAttrLastUpdatedTime()
The time this template was last updated.
|
java.lang.String |
getAttrVersionCreatedTime() |
IResolvable |
getAttrVersionDataSetConfigurations() |
java.lang.String |
getAttrVersionDescription() |
IResolvable |
getAttrVersionErrors() |
IResolvable |
getAttrVersionSheets() |
java.lang.String |
getAttrVersionSourceEntityArn() |
java.lang.String |
getAttrVersionStatus() |
java.lang.String |
getAttrVersionThemeArn() |
IResolvable |
getAttrVersionVersionNumber() |
java.lang.String |
getAwsAccountId()
The ID for the AWS account that the group is in.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getName()
A display name for the template.
|
java.lang.Object |
getPermissions()
A list of resource permissions to be set on the template.
|
java.lang.Object |
getSourceEntity()
The entity that you are using as a source when you create the template.
|
TagManager |
getTags()
Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
|
java.lang.String |
getTemplateId()
An ID for the template that you want to create.
|
java.lang.String |
getVersionDescription()
A description of the current template version being created.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setAwsAccountId(java.lang.String value)
The ID for the AWS account that the group is in.
|
void |
setName(java.lang.String value)
A display name for the template.
|
void |
setPermissions(IResolvable value)
A list of resource permissions to be set on the template.
|
void |
setPermissions(java.util.List<java.lang.Object> value)
A list of resource permissions to be set on the template.
|
void |
setSourceEntity(CfnTemplate.TemplateSourceEntityProperty value)
The entity that you are using as a source when you create the template.
|
void |
setSourceEntity(IResolvable value)
The entity that you are using as a source when you create the template.
|
void |
setTemplateId(java.lang.String value)
An ID for the template that you want to create.
|
void |
setVersionDescription(java.lang.String value)
A description of the current template version being created.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validatePropertiesgetRefgetCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdgetNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validatepublic static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnTemplate(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnTemplate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnTemplate(Construct scope, java.lang.String id, CfnTemplateProps props)
scope - - scope in which this resource is defined. This parameter is required.id - - scoped id of the resource. This parameter is required.props - - resource properties. This parameter is required.public void inspect(TreeInspector inspector)
inspect in interface IInspectableinspector - - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties in class CfnResourceprops - This parameter is required.public java.lang.String getAttrArn()
public java.lang.String getAttrCreatedTime()
public java.lang.String getAttrLastUpdatedTime()
public java.lang.String getAttrVersionCreatedTime()
public IResolvable getAttrVersionDataSetConfigurations()
public java.lang.String getAttrVersionDescription()
public IResolvable getAttrVersionErrors()
public IResolvable getAttrVersionSheets()
public java.lang.String getAttrVersionSourceEntityArn()
public java.lang.String getAttrVersionStatus()
public java.lang.String getAttrVersionThemeArn()
public IResolvable getAttrVersionVersionNumber()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties in class CfnResourcepublic TagManager getTags()
public java.lang.String getAwsAccountId()
You use the ID for the AWS account that contains your Amazon QuickSight account.
public void setAwsAccountId(java.lang.String value)
You use the ID for the AWS account that contains your Amazon QuickSight account.
public java.lang.Object getSourceEntity()
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.
public void setSourceEntity(IResolvable value)
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.
public void setSourceEntity(CfnTemplate.TemplateSourceEntityProperty value)
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.
public java.lang.String getTemplateId()
This template is unique per AWS Region ; in each AWS account.
public void setTemplateId(java.lang.String value)
This template is unique per AWS Region ; in each AWS account.
public java.lang.String getName()
public void setName(java.lang.String value)
public java.lang.Object getPermissions()
public void setPermissions(IResolvable value)
public void setPermissions(java.util.List<java.lang.Object> value)
public java.lang.String getVersionDescription()
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.
public void setVersionDescription(java.lang.String value)
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.