Interface CfnTemplateProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnTemplateProps.Jsii$Proxy
CfnTemplate
.
Example:
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnTemplateProps
static final class
An implementation forCfnTemplateProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnTemplateProps.Builder
builder()
The ID for the AWS account that the group is in.default Object
default String
getName()
A display name for the template.default Object
A list of resource permissions to be set on the template.default Object
The entity that you are using as a source when you create the template.getTags()
Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.An ID for the template that you want to create.default Object
The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects.default String
A description of the current template version being created.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
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.
- See Also:
-
getTemplateId
An ID for the template that you want to create.This template is unique per AWS Region ; in each AWS account.
- See Also:
-
getDefinition
- See Also:
-
getName
A display name for the template.- See Also:
-
getPermissions
A list of resource permissions to be set on the template.- See Also:
-
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 orSourceAnalysis
for an analysis. Both of these require an Amazon Resource Name (ARN). ForSourceTemplate
, specify the ARN of the source template. ForSourceAnalysis
, specify the ARN of the source analysis. TheSourceTemplate
ARN can contain any AWS account and any Amazon QuickSight-supported AWS Region .Use the
DataSetReferences
entity withinSourceTemplate
orSourceAnalysis
to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.Either a
SourceEntity
or aDefinition
must be provided in order for the request to be valid.- See Also:
-
getTags
Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.- See Also:
-
getValidationStrategy
The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects.When you set this value to
LENIENT
, validation is skipped for specific errors.- See Also:
-
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 theVersionDescription
field.- See Also:
-
builder
- Returns:
- a
CfnTemplateProps.Builder
ofCfnTemplateProps
-