Package software.amazon.awscdk.services.quicksight

Class CfnTemplateProps.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • awsAccountId

      @Stability(Stable) public CfnTemplateProps.Builder awsAccountId(String awsAccountId)
      Sets the value of CfnTemplateProps.getAwsAccountId()
      Parameters:
      awsAccountId - The ID for the AWS account that the group is in. This parameter is required. You use the ID for the AWS account that contains your Amazon QuickSight account.
      Returns:
      this

    • templateId

      @Stability(Stable) public CfnTemplateProps.Builder templateId(String templateId)
      Sets the value of CfnTemplateProps.getTemplateId()
      Parameters:
      templateId - An ID for the template that you want to create. This parameter is required. This template is unique per AWS Region ; in each AWS account.
      Returns:
      this

    • definition

      @Stability(Stable) public CfnTemplateProps.Builder definition(IResolvable definition)
      Sets the value of CfnTemplateProps.getDefinition()
      Parameters:
      definition - AWS::QuickSight::Template.Definition.
      Returns:
      this

    • definition

      @Stability(Stable) public CfnTemplateProps.Builder definition(CfnTemplate.TemplateVersionDefinitionProperty definition)
      Sets the value of CfnTemplateProps.getDefinition()
      Parameters:
      definition - AWS::QuickSight::Template.Definition.
      Returns:
      this

    • name

      @Stability(Stable) public CfnTemplateProps.Builder name(String name)
      Sets the value of CfnTemplateProps.getName()
      Parameters:
      name - A display name for the template.
      Returns:
      this

    • permissions

      @Stability(Stable) public CfnTemplateProps.Builder permissions(IResolvable permissions)
      Sets the value of CfnTemplateProps.getPermissions()
      Parameters:
      permissions - A list of resource permissions to be set on the template.
      Returns:
      this

    • permissions

      @Stability(Stable) public CfnTemplateProps.Builder permissions(List<? extends Object> permissions)
      Sets the value of CfnTemplateProps.getPermissions()
      Parameters:
      permissions - A list of resource permissions to be set on the template.
      Returns:
      this

    • sourceEntity

      @Stability(Stable) public CfnTemplateProps.Builder sourceEntity(IResolvable sourceEntity)
      Sets the value of CfnTemplateProps.getSourceEntity()
      Parameters:
      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.

      Returns:
      this

    • sourceEntity

      @Stability(Stable) public CfnTemplateProps.Builder sourceEntity(CfnTemplate.TemplateSourceEntityProperty sourceEntity)
      Sets the value of CfnTemplateProps.getSourceEntity()
      Parameters:
      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.

      Returns:
      this

    • tags

      @Stability(Stable) public CfnTemplateProps.Builder tags(List<? extends CfnTag> tags)
      Sets the value of CfnTemplateProps.getTags()
      Parameters:
      tags - Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
      Returns:
      this

    • versionDescription

      @Stability(Stable) public CfnTemplateProps.Builder versionDescription(String versionDescription)
      Sets the value of CfnTemplateProps.getVersionDescription()
      Parameters:
      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.
      Returns:
      this

    • build

      @Stability(Stable) public CfnTemplateProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnTemplateProps>
      Returns:
      a new instance of CfnTemplateProps
      Throws:
      NullPointerException - if any required attribute was not provided