Package software.amazon.awscdk.services.quicksight

Class CfnTemplate

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.quicksight.CfnTemplate
All Implemented Interfaces:
IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)", date="2024-10-04T00:39:37.306Z") @Stability(Stable) public class CfnTemplate extends CfnResource implements IInspectable, ITaggable
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:

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnTemplate

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

    • CfnTemplate

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

    • CfnTemplate

      @Stability(Stable) public CfnTemplate(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnTemplateProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(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(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(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the template.

    • getAttrCreatedTime

      @Stability(Stable) @NotNull public String getAttrCreatedTime()
      The time this template was created.

    • getAttrLastUpdatedTime

      @Stability(Stable) @NotNull public String getAttrLastUpdatedTime()
      The time this template was last updated.

    • getAttrVersion

      @Stability(Stable) @NotNull public IResolvable getAttrVersion()

      A version of a template.

      .

    • getAttrVersionCreatedTime

      @Stability(Stable) @NotNull public String getAttrVersionCreatedTime()

    • getAttrVersionDataSetConfigurations

      @Stability(Stable) @NotNull public IResolvable getAttrVersionDataSetConfigurations()

    • getAttrVersionDescription

      @Stability(Stable) @NotNull public String getAttrVersionDescription()

    • getAttrVersionErrors

      @Stability(Stable) @NotNull public IResolvable getAttrVersionErrors()

    • getAttrVersionSheets

      @Stability(Stable) @NotNull public IResolvable getAttrVersionSheets()

    • getAttrVersionSourceEntityArn

      @Stability(Stable) @NotNull public String getAttrVersionSourceEntityArn()

    • getAttrVersionStatus

      @Stability(Stable) @NotNull public String getAttrVersionStatus()

    • getAttrVersionThemeArn

      @Stability(Stable) @NotNull public String getAttrVersionThemeArn()

    • getAttrVersionVersionNumber

      @Stability(Stable) @NotNull public IResolvable getAttrVersionVersionNumber()

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getAwsAccountId

      @Stability(Stable) @NotNull public String getAwsAccountId()
      The ID for the AWS account that the group is in.

    • setAwsAccountId

      @Stability(Stable) public void setAwsAccountId(@NotNull String value)
      The ID for the AWS account that the group is in.

    • getTemplateId

      @Stability(Stable) @NotNull public String getTemplateId()
      An ID for the template that you want to create.

    • setTemplateId

      @Stability(Stable) public void setTemplateId(@NotNull String value)
      An ID for the template that you want to create.

    • getDefinition

      @Stability(Stable) @Nullable public Object getDefinition()

    • setDefinition

      @Stability(Stable) public void setDefinition(@Nullable IResolvable value)

    • setDefinition

      @Stability(Stable) public void setDefinition(@Nullable CfnTemplate.TemplateVersionDefinitionProperty value)

    • getName

      @Stability(Stable) @Nullable public String getName()
      A display name for the template.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      A display name for the template.

    • getPermissions

      @Stability(Stable) @Nullable public Object getPermissions()
      A list of resource permissions to be set on the template.

    • setPermissions

      @Stability(Stable) public void setPermissions(@Nullable IResolvable value)
      A list of resource permissions to be set on the template.

    • setPermissions

      @Stability(Stable) public void setPermissions(@Nullable List<Object> value)
      A list of resource permissions to be set on the template.

    • getSourceEntity

      @Stability(Stable) @Nullable public Object getSourceEntity()
      The entity that you are using as a source when you create the template.

    • setSourceEntity

      @Stability(Stable) public void setSourceEntity(@Nullable IResolvable value)
      The entity that you are using as a source when you create the template.

    • setSourceEntity

      @Stability(Stable) public void setSourceEntity(@Nullable CfnTemplate.TemplateSourceEntityProperty value)
      The entity that you are using as a source when you create the template.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

    • getValidationStrategy

      @Stability(Stable) @Nullable public Object getValidationStrategy()
      The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects.

    • setValidationStrategy

      @Stability(Stable) public void setValidationStrategy(@Nullable IResolvable value)
      The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects.

    • setValidationStrategy

      @Stability(Stable) public void setValidationStrategy(@Nullable CfnTemplate.ValidationStrategyProperty value)
      The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects.

    • getVersionDescription

      @Stability(Stable) @Nullable public String getVersionDescription()
      A description of the current template version being created.

    • setVersionDescription

      @Stability(Stable) public void setVersionDescription(@Nullable String value)
      A description of the current template version being created.