software.amazon.awscdk.services.quicksight

Interface CfnTemplateProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTemplateProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:37.760Z")
 @Stability(value=Stable)
public interface CfnTemplateProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnTemplate`.

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.*;
 CfnTemplateProps cfnTemplateProps = CfnTemplateProps.builder()
         .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	Interface and Description
static class	CfnTemplateProps.Builder A builder for CfnTemplateProps
static class	CfnTemplateProps.Jsii$Proxy An implementation for CfnTemplateProps

Method Summary

Modifier and Type	Method and Description
static CfnTemplateProps.Builder	builder()
String	getAwsAccountId() The ID for the AWS account that the group is in.
default String	getName() A display name for the template.
default 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.
default List<CfnTag>	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.
default String	getVersionDescription() A description of the current template version being created.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAwsAccountId

@Stability(value=Stable)
 @NotNull
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.

getSourceEntity

@Stability(value=Stable)
 @NotNull
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.

getTemplateId

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

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
default String getName()

A display name for the template.

getPermissions

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

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

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

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

getVersionDescription

@Stability(value=Stable)
 @Nullable
default 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.

builder

@Stability(value=Stable)
static CfnTemplateProps.Builder builder()

Returns:

a CfnTemplateProps.Builder of CfnTemplateProps