@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
date="2023-01-31T18:36:49.795Z")
public interface CfnTemplateProps
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();
Modifier and Type | Interface and Description |
---|---|
static class |
CfnTemplateProps.Builder
A builder for
CfnTemplateProps |
static class |
CfnTemplateProps.Jsii$Proxy
An implementation for
CfnTemplateProps |
Modifier and Type | Method and Description |
---|---|
static CfnTemplateProps.Builder |
builder() |
java.lang.String |
getAwsAccountId()
The ID for the AWS account that the group is in.
|
default java.lang.String |
getName()
A display name for the template.
|
default 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.
|
default java.util.List<CfnTag> |
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.
|
default java.lang.String |
getVersionDescription()
A description of the current template version being created.
|
java.lang.String getAwsAccountId()
You use the ID for the AWS account that contains your Amazon QuickSight account.
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.
java.lang.String getTemplateId()
This template is unique per AWS Region ; in each AWS account.
default java.lang.String getName()
default java.lang.Object getPermissions()
default java.util.List<CfnTag> getTags()
default 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.
static CfnTemplateProps.Builder builder()
CfnTemplateProps.Builder
of CfnTemplateProps