Package software.amazon.awscdk.services.quicksight

Class CfnTemplate.Builder

java.lang.Object
software.amazon.awscdk.services.quicksight.CfnTemplate.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnTemplate>
Enclosing class:
CfnTemplate
@Stability(Stable) public static final class CfnTemplate.Builder extends Object implements software.amazon.jsii.Builder<CfnTemplate>
A fluent builder for CfnTemplate.

  • Method Details

    • create

      @Stability(Stable) public static CfnTemplate.Builder create(Construct scope, String id)
      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      Returns:
      a new instance of CfnTemplate.Builder.

    • awsAccountId

      @Stability(Stable) public CfnTemplate.Builder awsAccountId(String awsAccountId)
      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.

      Parameters:
      awsAccountId - The ID for the AWS account that the group is in. This parameter is required.
      Returns:
      this

    • templateId

      @Stability(Stable) public CfnTemplate.Builder templateId(String templateId)
      An ID for the template that you want to create.

      This template is unique per AWS Region ; in each AWS account.

      Parameters:
      templateId - An ID for the template that you want to create. This parameter is required.
      Returns:
      this

    • definition

      @Stability(Stable) public CfnTemplate.Builder definition(IResolvable definition)
      AWS::QuickSight::Template.Definition.

      Parameters:
      definition - AWS::QuickSight::Template.Definition. This parameter is required.
      Returns:
      this

    • definition

      @Stability(Stable) public CfnTemplate.Builder definition(CfnTemplate.TemplateVersionDefinitionProperty definition)
      AWS::QuickSight::Template.Definition.

      Parameters:
      definition - AWS::QuickSight::Template.Definition. This parameter is required.
      Returns:
      this

    • name

      @Stability(Stable) public CfnTemplate.Builder name(String name)
      A display name for the template.

      Parameters:
      name - A display name for the template. This parameter is required.
      Returns:
      this

    • permissions

      @Stability(Stable) public CfnTemplate.Builder permissions(IResolvable permissions)
      A list of resource permissions to be set on the template.

      Parameters:
      permissions - A list of resource permissions to be set on the template. This parameter is required.
      Returns:
      this

    • permissions

      @Stability(Stable) public CfnTemplate.Builder permissions(List<? extends Object> permissions)
      A list of resource permissions to be set on the template.

      Parameters:
      permissions - A list of resource permissions to be set on the template. This parameter is required.
      Returns:
      this

    • sourceEntity

      @Stability(Stable) public CfnTemplate.Builder sourceEntity(IResolvable sourceEntity)
      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.

      Parameters:
      sourceEntity - The entity that you are using as a source when you create the template. This parameter is required.
      Returns:
      this

    • sourceEntity

      @Stability(Stable) public CfnTemplate.Builder sourceEntity(CfnTemplate.TemplateSourceEntityProperty sourceEntity)
      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.

      Parameters:
      sourceEntity - The entity that you are using as a source when you create the template. This parameter is required.
      Returns:
      this

    • tags

      @Stability(Stable) public CfnTemplate.Builder tags(List<? extends CfnTag> tags)
      Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

      Parameters:
      tags - Contains a map of the key-value pairs for the resource tag or tags assigned to the resource. This parameter is required.
      Returns:
      this

    • versionDescription

      @Stability(Stable) public CfnTemplate.Builder versionDescription(String versionDescription)
      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.

      Parameters:
      versionDescription - A description of the current template version being created. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public CfnTemplate build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnTemplate>
      Returns:
      a newly built instance of CfnTemplate.