class CfnTheme (construct)

Language	Type name
.NET	Amazon.CDK.AWS.QuickSight.CfnTheme
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnTheme
Java	software.amazon.awscdk.services.quicksight.CfnTheme
Python	aws_cdk.aws_quicksight.CfnTheme
TypeScript	aws-cdk-lib » aws_quicksight » CfnTheme

Implements IConstruct, IDependable, IInspectable, ITaggable

Creates a theme.

A theme is set of configuration options for color and layout. Themes apply to analyses and dashboards. For more information, see Using Themes in Amazon QuickSight in the Amazon QuickSight User Guide .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-theme.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_quicksight as quicksight } from 'aws-cdk-lib';
const cfnTheme = new quicksight.CfnTheme(this, 'MyCfnTheme', {
  awsAccountId: 'awsAccountId',
  baseThemeId: 'baseThemeId',
  configuration: {
    dataColorPalette: {
      colors: ['colors'],
      emptyFillColor: 'emptyFillColor',
      minMaxGradient: ['minMaxGradient'],
    },
    sheet: {
      tile: {
        border: {
          show: false,
        },
      },
      tileLayout: {
        gutter: {
          show: false,
        },
        margin: {
          show: false,
        },
      },
    },
    typography: {
      fontFamilies: [{
        fontFamily: 'fontFamily',
      }],
    },
    uiColorPalette: {
      accent: 'accent',
      accentForeground: 'accentForeground',
      danger: 'danger',
      dangerForeground: 'dangerForeground',
      dimension: 'dimension',
      dimensionForeground: 'dimensionForeground',
      measure: 'measure',
      measureForeground: 'measureForeground',
      primaryBackground: 'primaryBackground',
      primaryForeground: 'primaryForeground',
      secondaryBackground: 'secondaryBackground',
      secondaryForeground: 'secondaryForeground',
      success: 'success',
      successForeground: 'successForeground',
      warning: 'warning',
      warningForeground: 'warningForeground',
    },
  },
  name: 'name',
  themeId: 'themeId',

  // the properties below are optional
  permissions: [{
    actions: ['actions'],
    principal: 'principal',

    // the properties below are optional
    resource: 'resource',
  }],
  tags: [{
    key: 'key',
    value: 'value',
  }],
  versionDescription: 'versionDescription',
});

Initializer

new CfnTheme(scope: Construct, id: string, props: CfnThemeProps)

Parameters

• scope Construct — Scope in which this resource is defined.
• id string — Construct identifier for this resource (unique in its scope).
• props CfnThemeProps — Resource properties.

Construct Props

Name	Type	Description
awsAccountId	string	The ID of the AWS account where you want to store the new theme.
baseThemeId	string	The ID of the theme that a custom theme will inherit from.
configuration	IResolvable | ThemeConfigurationProperty	The theme configuration, which contains the theme display properties.
name	string	A display name for the theme.
themeId	string	An ID for the theme that you want to create.
permissions?	IResolvable | IResolvable | ResourcePermissionProperty[]	A valid grouping of resource permissions to apply to the new theme.
tags?	CfnTag[]	A map of the key-value pairs for the resource tag or tags that you want to add to the resource.
versionDescription?	string	A description of the first version of the theme that you're creating.

---

awsAccountId

Type: string

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

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

---

baseThemeId

Type: string

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

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

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

---

configuration

Type: IResolvable | ThemeConfigurationProperty

The theme configuration, which contains the theme display properties.

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

---

name

Type: string

A display name for the theme.

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

---

themeId

Type: string

An ID for the theme that you want to create.

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

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

---

permissions?

Type: IResolvable | IResolvable | ResourcePermissionProperty[] (optional)

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

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

---

tags?

Type: CfnTag[] (optional)

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

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

---

versionDescription?

Type: string (optional)

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.

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

Properties

Name	Type	Description
attrArn	string	The Amazon Resource Name (ARN) of the theme.
attrCreatedTime	string	The time the theme was created.
attrLastUpdatedTime	string	The time the theme was last updated.
attrType	string	Theme type.
attrVersion	IResolvable	A version of a theme. .
attrVersionArn	string
attrVersionBaseThemeId	string
attrVersionConfiguration	IResolvable
attrVersionConfigurationDataColorPalette	IResolvable
attrVersionConfigurationSheet	IResolvable
attrVersionConfigurationTypography	IResolvable
attrVersionConfigurationUiColorPalette	IResolvable
attrVersionCreatedTime	string
attrVersionDescription	string
attrVersionErrors	IResolvable
attrVersionStatus	string
attrVersionVersionNumber	IResolvable
awsAccountId	string	The ID of the AWS account where you want to store the new theme.
baseThemeId	string	The ID of the theme that a custom theme will inherit from.
cfnOptions	ICfnResourceOptions	Options for this resource, such as condition, update policy etc.
cfnProperties	{ [string]: any }
cfnResourceType	string	AWS resource type.
configuration	IResolvable | ThemeConfigurationProperty	The theme configuration, which contains the theme display properties.
creationStack	string[]
logicalId	string	The logical ID for this CloudFormation stack element.
name	string	A display name for the theme.
node	Node	The tree node.
ref	string	Return a string that will be resolved to a CloudFormation { Ref } for this element.
stack	Stack	The stack in which this element is defined.
tags	TagManager	Tag Manager which manages the tags for this resource.
themeId	string	An ID for the theme that you want to create.
permissions?	IResolvable | IResolvable | ResourcePermissionProperty[]	A valid grouping of resource permissions to apply to the new theme.
tagsRaw?	CfnTag[]	A map of the key-value pairs for the resource tag or tags that you want to add to the resource.
versionDescription?	string	A description of the first version of the theme that you're creating.
static CFN_RESOURCE_TYPE_NAME	string	The CloudFormation resource type name for this resource class.

---

attrArn

Type: string

The Amazon Resource Name (ARN) of the theme.

---

attrCreatedTime

Type: string

The time the theme was created.

---

attrLastUpdatedTime

Type: string

The time the theme was last updated.

---

attrType

Type: string

Theme type.

---

attrVersion

Type: IResolvable

<p>A version of a theme.

.

---

attrVersionArn

Type: string

---

attrVersionBaseThemeId

Type: string

---

attrVersionConfiguration

Type: IResolvable

---

attrVersionConfigurationDataColorPalette

Type: IResolvable

---

attrVersionConfigurationSheet

Type: IResolvable

---

attrVersionConfigurationTypography

Type: IResolvable

---

attrVersionConfigurationUiColorPalette

Type: IResolvable

---

attrVersionCreatedTime

Type: string

---

attrVersionDescription

Type: string

---

attrVersionErrors

Type: IResolvable

---

attrVersionStatus

Type: string

---

attrVersionVersionNumber

Type: IResolvable

---

awsAccountId

Type: string

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

---

baseThemeId

Type: string

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

---

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

---

cfnProperties

Type: { [string]: any }

---

cfnResourceType

Type: string

AWS resource type.

---

configuration

Type: IResolvable | ThemeConfigurationProperty

The theme configuration, which contains the theme display properties.

---

creationStack

Type: string[]

---

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

---

name

Type: string

A display name for the theme.

---

node

Type: Node

The tree node.

---

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

---

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

---

tags

Type: TagManager

Tag Manager which manages the tags for this resource.

---

themeId

Type: string

An ID for the theme that you want to create.

---

permissions?

Type: IResolvable | IResolvable | ResourcePermissionProperty[] (optional)

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

---

tagsRaw?

Type: CfnTag[] (optional)

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

---

versionDescription?

Type: string (optional)

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

---

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for addOverride(path, undefined).
addDependency(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
obtainDependencies()	Retrieves an array of resources this resource depends on.
obtainResourceDependencies()	Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)	Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)	Replaces one dependency with another.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

---

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

• path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

---

addDependency(target)

public addDependency(target: CfnResource): void

Parameters

• target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

---

addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

• target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

---

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

• key string
• value any

Add a value to the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

---

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

• path string — - The path of the property, you can use dot notation to override values in complex types.
• value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

---

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

• propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

---

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

• propertyPath string — The path of the property.
• value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

---

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

• policy RemovalPolicy
• options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

---

getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

• attributeName string — The name of the attribute.
• typeHint ResolutionTypeHint

Returns

• Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

---

getMetadata(key)

public getMetadata(key: string): any

Parameters

• key string

Returns

• any

Retrieve a value value from the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

---

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

• inspector TreeInspector — tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

---

obtainDependencies()

public obtainDependencies(): Stack | CfnResource[]

Returns

• Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

---

obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

• CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.

---

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

• newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

---

removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

• target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

---

replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

• target CfnResource — The dependency to replace.
• newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

• props { [string]: any }

Returns

• { [string]: any }