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.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:18.791Z")
 @Stability(value=Stable)
public interface CfnTemplateProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::QuickSight::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.*;
 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() `AWS::QuickSight::Template.AwsAccountId`.
default String	getName() `AWS::QuickSight::Template.Name`.
default Object	getPermissions() `AWS::QuickSight::Template.Permissions`.
Object	getSourceEntity() `AWS::QuickSight::Template.SourceEntity`.
default List<CfnTag>	getTags() `AWS::QuickSight::Template.Tags`.
String	getTemplateId() `AWS::QuickSight::Template.TemplateId`.
default String	getVersionDescription() `AWS::QuickSight::Template.VersionDescription`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAwsAccountId

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

`AWS::QuickSight::Template.AwsAccountId`.

getName

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

`AWS::QuickSight::Template.Name`.

getPermissions

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

`AWS::QuickSight::Template.Permissions`.

getSourceEntity

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

`AWS::QuickSight::Template.SourceEntity`.

getTags

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

`AWS::QuickSight::Template.Tags`.

getTemplateId

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

`AWS::QuickSight::Template.TemplateId`.

getVersionDescription

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

`AWS::QuickSight::Template.VersionDescription`.

builder

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

Returns:

a CfnTemplateProps.Builder of CfnTemplateProps