software.amazon.awscdk.services.quicksight

Class CfnTemplate

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.quicksight.CfnTemplate

All Implemented Interfaces:

IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-17T17:31:11.805Z")
 @Stability(value=Stable)
public class CfnTemplate
extends CfnResource
implements IInspectable

A CloudFormation `AWS::QuickSight::Template`.

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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnTemplate.Builder A fluent builder for CfnTemplate.
static interface	CfnTemplate.DataSetReferenceProperty Dataset reference.
static interface	CfnTemplate.ResourcePermissionProperty Permission for the resource.
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.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnTemplate(Construct scope, 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)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The Amazon Resource Name (ARN) of the template.
String	getAttrCreatedTime() The time this template was created.
String	getAttrLastUpdatedTime() The time this template was last updated.
String	getAwsAccountId() The ID for the AWS account that the group is in.
protected Map<String,Object>	getCfnProperties()
String	getName() A display name for the template.
Object	getPermissions() A list of resource permissions to be set on the template.
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.
String	getTemplateId() An ID for the template that you want to create.
String	getVersionDescription() A description of the current template version being created.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAwsAccountId(String value) The ID for the AWS account that the group is in.
void	setName(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(List<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(String value) An ID for the template that you want to create.
void	setVersionDescription(String value) A description of the current template version being created.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnTemplate

protected CfnTemplate(software.amazon.jsii.JsiiObjectRef objRef)

CfnTemplate

protected CfnTemplate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnTemplate

@Stability(value=Stable)
public CfnTemplate(@NotNull
                                            Construct scope,
                                            @NotNull
                                            String id,
                                            @NotNull
                                            CfnTemplateProps props)

Create a new `AWS::QuickSight::Template`.

Parameters:

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.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

The Amazon Resource Name (ARN) of the template.

getAttrCreatedTime

@Stability(value=Stable)
 @NotNull
public String getAttrCreatedTime()

The time this template was created.

getAttrLastUpdatedTime

@Stability(value=Stable)
 @NotNull
public String getAttrLastUpdatedTime()

The time this template was last updated.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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

getAwsAccountId

@Stability(value=Stable)
 @NotNull
public String getAwsAccountId()

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

You use the ID for the AWS account that contains your Amazon QuickSight account.

setAwsAccountId

@Stability(value=Stable)
public void setAwsAccountId(@NotNull
                                                     String value)

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

You use the ID for the AWS account that contains your Amazon QuickSight account.

getSourceEntity

@Stability(value=Stable)
 @NotNull
public Object getSourceEntity()

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

setSourceEntity

@Stability(value=Stable)
public void setSourceEntity(@NotNull
                                                     IResolvable value)

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

setSourceEntity

@Stability(value=Stable)
public void setSourceEntity(@NotNull
                                                     CfnTemplate.TemplateSourceEntityProperty value)

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

getTemplateId

@Stability(value=Stable)
 @NotNull
public String getTemplateId()

An ID for the template that you want to create.

This template is unique per AWS Region ; in each AWS account.

setTemplateId

@Stability(value=Stable)
public void setTemplateId(@NotNull
                                                   String value)

An ID for the template that you want to create.

This template is unique per AWS Region ; in each AWS account.

getName

@Stability(value=Stable)
 @Nullable
public String getName()

A display name for the template.

setName

@Stability(value=Stable)
public void setName(@Nullable
                                             String value)

A display name for the template.

getPermissions

@Stability(value=Stable)
 @Nullable
public Object getPermissions()

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

setPermissions

@Stability(value=Stable)
public void setPermissions(@Nullable
                                                    IResolvable value)

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

setPermissions

@Stability(value=Stable)
public void setPermissions(@Nullable
                                                    List<Object> value)

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

getVersionDescription

@Stability(value=Stable)
 @Nullable
public String getVersionDescription()

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.

setVersionDescription

@Stability(value=Stable)
public void setVersionDescription(@Nullable
                                                           String value)

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.