Package software.amazon.awscdk.cfnpropertymixins.services.quicksight

Class CfnTemplateMixinProps.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.quicksight.CfnTemplateMixinProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnTemplateMixinProps>

Enclosing interface:

CfnTemplateMixinProps

@Stability(Stable)
public static final class CfnTemplateMixinProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnTemplateMixinProps>

A builder for CfnTemplateMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnTemplateMixinProps.Builder	awsAccountId(String awsAccountId)	Sets the value of CfnTemplateMixinProps.getAwsAccountId()
CfnTemplateMixinProps	build()	Builds the configured instance.
CfnTemplateMixinProps.Builder	definition(CfnTemplatePropsMixin.TemplateVersionDefinitionProperty definition)	Sets the value of CfnTemplateMixinProps.getDefinition()
CfnTemplateMixinProps.Builder	definition(IResolvable definition)	Sets the value of CfnTemplateMixinProps.getDefinition()
CfnTemplateMixinProps.Builder	name(String name)	Sets the value of CfnTemplateMixinProps.getName()
CfnTemplateMixinProps.Builder	permissions(List<? extends Object> permissions)	Sets the value of CfnTemplateMixinProps.getPermissions()
CfnTemplateMixinProps.Builder	permissions(IResolvable permissions)	Sets the value of CfnTemplateMixinProps.getPermissions()
CfnTemplateMixinProps.Builder	sourceEntity(CfnTemplatePropsMixin.TemplateSourceEntityProperty sourceEntity)	Sets the value of CfnTemplateMixinProps.getSourceEntity()
CfnTemplateMixinProps.Builder	sourceEntity(IResolvable sourceEntity)	Sets the value of CfnTemplateMixinProps.getSourceEntity()
CfnTemplateMixinProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnTemplateMixinProps.getTags()
CfnTemplateMixinProps.Builder	templateId(String templateId)	Sets the value of CfnTemplateMixinProps.getTemplateId()
CfnTemplateMixinProps.Builder	validationStrategy(CfnTemplatePropsMixin.ValidationStrategyProperty validationStrategy)	Sets the value of CfnTemplateMixinProps.getValidationStrategy()
CfnTemplateMixinProps.Builder	validationStrategy(IResolvable validationStrategy)	Sets the value of CfnTemplateMixinProps.getValidationStrategy()
CfnTemplateMixinProps.Builder	versionDescription(String versionDescription)	Sets the value of CfnTemplateMixinProps.getVersionDescription()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

awsAccountId

@Stability(Stable)
public CfnTemplateMixinProps.Builder awsAccountId(String awsAccountId)

Sets the value of CfnTemplateMixinProps.getAwsAccountId()

Parameters:

awsAccountId - The ID for the AWS account that the group is in. You use the ID for the AWS account that contains your Amazon Quick Sight account.

Returns:

this

definition

@Stability(Stable)
public CfnTemplateMixinProps.Builder definition(IResolvable definition)

Sets the value of CfnTemplateMixinProps.getDefinition()

Parameters:

definition - the value to be set.

Returns:

this

definition

@Stability(Stable)
public CfnTemplateMixinProps.Builder definition(CfnTemplatePropsMixin.TemplateVersionDefinitionProperty definition)

Sets the value of CfnTemplateMixinProps.getDefinition()

Parameters:

definition - the value to be set.

Returns:

this

name

@Stability(Stable)
public CfnTemplateMixinProps.Builder name(String name)

Sets the value of CfnTemplateMixinProps.getName()

Parameters:

name - A display name for the template.

Returns:

this

permissions

@Stability(Stable)
public CfnTemplateMixinProps.Builder permissions(IResolvable permissions)

Sets the value of CfnTemplateMixinProps.getPermissions()

Parameters:

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

Returns:

this

permissions

@Stability(Stable)
public CfnTemplateMixinProps.Builder permissions(List<? extends Object> permissions)

Sets the value of CfnTemplateMixinProps.getPermissions()

Parameters:

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

Returns:

this

sourceEntity

@Stability(Stable)
public CfnTemplateMixinProps.Builder sourceEntity(IResolvable sourceEntity)

Sets the value of CfnTemplateMixinProps.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 Quick Sight-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 CfnTemplateMixinProps.Builder sourceEntity(CfnTemplatePropsMixin.TemplateSourceEntityProperty sourceEntity)

Sets the value of CfnTemplateMixinProps.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 Quick Sight-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 CfnTemplateMixinProps.Builder tags(List<? extends CfnTag> tags)

Sets the value of CfnTemplateMixinProps.getTags()

Parameters:

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

Returns:

this

templateId

@Stability(Stable)
public CfnTemplateMixinProps.Builder templateId(String templateId)

Sets the value of CfnTemplateMixinProps.getTemplateId()

Parameters:

templateId - An ID for the template that you want to create. This template is unique per AWS Region ; in each AWS account.

Returns:

this

validationStrategy

@Stability(Stable)
public CfnTemplateMixinProps.Builder validationStrategy(IResolvable validationStrategy)

Sets the value of CfnTemplateMixinProps.getValidationStrategy()

Parameters:

validationStrategy - 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.

Returns:

this

validationStrategy

@Stability(Stable)
public CfnTemplateMixinProps.Builder validationStrategy(CfnTemplatePropsMixin.ValidationStrategyProperty validationStrategy)

Sets the value of CfnTemplateMixinProps.getValidationStrategy()

Parameters:

validationStrategy - 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.

Returns:

this

versionDescription

@Stability(Stable)
public CfnTemplateMixinProps.Builder versionDescription(String versionDescription)

Sets the value of CfnTemplateMixinProps.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 CfnTemplateMixinProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnTemplateMixinProps>

Returns:

a new instance of CfnTemplateMixinProps

Throws:

NullPointerException - if any required attribute was not provided