Package 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.98.0 (build 00b106d)",
           date="2024-05-02T15:58:32.002Z")
@Stability(Stable)
public interface CfnTemplateProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnTemplate.

Example:

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-template.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnTemplateProps.Builder	A builder for CfnTemplateProps
static final class	CfnTemplateProps.Jsii$Proxy	An implementation for CfnTemplateProps

Method Summary

Modifier and Type	Method	Description
static CfnTemplateProps.Builder	builder()
String	getAwsAccountId()	The ID for the AWS account that the group is in.
default Object	getDefinition()
default String	getName()	A display name for the template.
default Object	getPermissions()	A list of resource permissions to be set on the template.
default 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 Object	getValidationStrategy()	The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects.
default String	getVersionDescription()	A description of the current template version being created.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAwsAccountId

@Stability(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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-template.html#cfn-quicksight-template-awsaccountid

getTemplateId

@Stability(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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-template.html#cfn-quicksight-template-templateid

getDefinition

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-template.html#cfn-quicksight-template-definition

getName

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

A display name for the template.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-template.html#cfn-quicksight-template-name

getPermissions

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-template.html#cfn-quicksight-template-permissions

getSourceEntity

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

Either a SourceEntity or a Definition must be provided in order for the request to be valid.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-template.html#cfn-quicksight-template-sourceentity

getTags

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-template.html#cfn-quicksight-template-tags

getValidationStrategy

@Stability(Stable)
@Nullable
default Object 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-template.html#cfn-quicksight-template-validationstrategy

getVersionDescription

@Stability(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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-template.html#cfn-quicksight-template-versiondescription

builder

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

Returns:

a CfnTemplateProps.Builder of CfnTemplateProps