Package software.amazon.awscdk.services.quicksight

Class CfnTheme.Builder

java.lang.Object

software.amazon.awscdk.services.quicksight.CfnTheme.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnTheme>

Enclosing class:

CfnTheme

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

A fluent builder for CfnTheme.

Method Summary

Modifier and Type	Method	Description
CfnTheme.Builder	awsAccountId(String awsAccountId)	The ID of the AWS account where you want to store the new theme.
CfnTheme.Builder	baseThemeId(String baseThemeId)	The ID of the theme that a custom theme will inherit from.
CfnTheme	build()
CfnTheme.Builder	configuration(IResolvable configuration)	The theme configuration, which contains the theme display properties.
CfnTheme.Builder	configuration(CfnTheme.ThemeConfigurationProperty configuration)	The theme configuration, which contains the theme display properties.
static CfnTheme.Builder	create(software.constructs.Construct scope, String id)
CfnTheme.Builder	name(String name)	A display name for the theme.
CfnTheme.Builder	permissions(List<? extends Object> permissions)	A valid grouping of resource permissions to apply to the new theme.
CfnTheme.Builder	permissions(IResolvable permissions)	A valid grouping of resource permissions to apply to the new theme.
CfnTheme.Builder	tags(List<? extends CfnTag> tags)	A map of the key-value pairs for the resource tag or tags that you want to add to the resource.
CfnTheme.Builder	themeId(String themeId)	An ID for the theme that you want to create.
CfnTheme.Builder	versionDescription(String versionDescription)	A description of the first version of the theme that you're creating.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnTheme.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnTheme.Builder.

awsAccountId

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

The ID of the AWS account where you want to store the new theme.

Parameters:

awsAccountId - The ID of the AWS account where you want to store the new theme. This parameter is required.

Returns:

this

See Also:

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

baseThemeId

@Stability(Stable)
public CfnTheme.Builder baseThemeId(String baseThemeId)

The ID of the theme that a custom theme will inherit from.

All themes inherit from one of the starting themes defined by Amazon Quick Sight. For a list of the starting themes, use ListThemes or choose Themes from within an analysis.

Parameters:

baseThemeId - The ID of the theme that a custom theme will inherit from. This parameter is required.

Returns:

this

See Also:

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

configuration

@Stability(Stable)
public CfnTheme.Builder configuration(IResolvable configuration)

The theme configuration, which contains the theme display properties.

Parameters:

configuration - The theme configuration, which contains the theme display properties. This parameter is required.

Returns:

this

See Also:

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

configuration

@Stability(Stable)
public CfnTheme.Builder configuration(CfnTheme.ThemeConfigurationProperty configuration)

The theme configuration, which contains the theme display properties.

Parameters:

configuration - The theme configuration, which contains the theme display properties. This parameter is required.

Returns:

this

See Also:

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

name

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

A display name for the theme.

Parameters:

name - A display name for the theme. This parameter is required.

Returns:

this

See Also:

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

themeId

@Stability(Stable)
public CfnTheme.Builder themeId(String themeId)

An ID for the theme that you want to create.

The theme ID is unique per AWS Region in each AWS account.

Parameters:

themeId - An ID for the theme that you want to create. This parameter is required.

Returns:

this

See Also:

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

permissions

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

A valid grouping of resource permissions to apply to the new theme.

Parameters:

permissions - A valid grouping of resource permissions to apply to the new theme. This parameter is required.

Returns:

this

See Also:

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

permissions

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

A valid grouping of resource permissions to apply to the new theme.

Parameters:

permissions - A valid grouping of resource permissions to apply to the new theme. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnTheme.Builder tags(List<? extends CfnTag> tags)

A map of the key-value pairs for the resource tag or tags that you want to add to the resource.

Parameters:

tags - A map of the key-value pairs for the resource tag or tags that you want to add to the resource. This parameter is required.

Returns:

this

See Also:

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

versionDescription

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

A description of the first version of the theme that you're creating.

Every time UpdateTheme is called, a new version is created. Each version of the theme has a description of the version in the VersionDescription field.

Parameters:

versionDescription - A description of the first version of the theme that you're creating. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnTheme build()

Specified by:

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

Returns:

a newly built instance of CfnTheme.