Class CfnThemeProps
Properties for defining a CfnTheme
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.QuickSight
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnThemeProps : Object, ICfnThemeProps
Syntax (vb)
Public Class CfnThemeProps
Inherits Object
Implements ICfnThemeProps
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-theme.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.QuickSight;
var cfnThemeProps = new CfnThemeProps {
AwsAccountId = "awsAccountId",
BaseThemeId = "baseThemeId",
Configuration = new ThemeConfigurationProperty {
DataColorPalette = new DataColorPaletteProperty {
Colors = new [] { "colors" },
EmptyFillColor = "emptyFillColor",
MinMaxGradient = new [] { "minMaxGradient" }
},
Sheet = new SheetStyleProperty {
Tile = new TileStyleProperty {
Border = new BorderStyleProperty {
Show = false
}
},
TileLayout = new TileLayoutStyleProperty {
Gutter = new GutterStyleProperty {
Show = false
},
Margin = new MarginStyleProperty {
Show = false
}
}
},
Typography = new TypographyProperty {
FontFamilies = new [] { new FontProperty {
FontFamily = "fontFamily"
} }
},
UiColorPalette = new UIColorPaletteProperty {
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 = new [] { new ResourcePermissionProperty {
Actions = new [] { "actions" },
Principal = "principal",
// the properties below are optional
Resource = "resource"
} },
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
VersionDescription = "versionDescription"
};
Synopsis
Constructors
CfnThemeProps() |
Properties
AwsAccountId | The ID of the AWS account where you want to store the new theme. |
BaseThemeId | The ID of the theme that a custom theme will inherit from. |
Configuration | The theme configuration, which contains the theme display properties. |
Name | A display name for the theme. |
Permissions | A valid grouping of resource permissions to apply to the new theme. |
Tags | A map of the key-value pairs for the resource tag or tags that you want to add to the resource. |
ThemeId | An ID for the theme that you want to create. |
VersionDescription | A description of the first version of the theme that you're creating. |
Constructors
CfnThemeProps()
public CfnThemeProps()
Properties
AwsAccountId
The ID of the AWS account where you want to store the new theme.
public string AwsAccountId { get; set; }
Property Value
System.String
Remarks
BaseThemeId
The ID of the theme that a custom theme will inherit from.
public string BaseThemeId { get; set; }
Property Value
System.String
Remarks
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.
Configuration
The theme configuration, which contains the theme display properties.
public object Configuration { get; set; }
Property Value
System.Object
Remarks
Name
A display name for the theme.
public string Name { get; set; }
Property Value
System.String
Remarks
Permissions
A valid grouping of resource permissions to apply to the new theme.
public object Permissions { get; set; }
Property Value
System.Object
Remarks
Tags
A map of the key-value pairs for the resource tag or tags that you want to add to the resource.
public ICfnTag[] Tags { get; set; }
Property Value
ICfnTag[]
Remarks
ThemeId
An ID for the theme that you want to create.
public string ThemeId { get; set; }
Property Value
System.String
Remarks
The theme ID is unique per AWS Region in each AWS account.
VersionDescription
A description of the first version of the theme that you're creating.
public string VersionDescription { get; set; }
Property Value
System.String
Remarks
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.