Class CfnTheme
A CloudFormation AWS::QuickSight::Theme
.
Inherited Members
Namespace: Amazon.CDK.AWS.QuickSight
Assembly: Amazon.CDK.AWS.QuickSight.dll
Syntax (csharp)
public class CfnTheme : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnTheme
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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 .
CloudformationResource: AWS::QuickSight::Theme
Link: 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 cfnTheme = new CfnTheme(this, "MyCfnTheme", new CfnThemeProps {
AwsAccountId = "awsAccountId",
ThemeId = "themeId",
// the properties below are optional
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",
Permissions = new [] { new ResourcePermissionProperty {
Actions = new [] { "actions" },
Principal = "principal"
} },
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
VersionDescription = "versionDescription"
});
Synopsis
Constructors
CfnTheme(Construct, String, ICfnThemeProps) | Create a new |
CfnTheme(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnTheme(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrArn | The Amazon Resource Name (ARN) of the theme. |
AttrCreatedTime | The time the theme was created. |
AttrLastUpdatedTime | The time the theme was last updated. |
AttrType | Theme type. |
AttrVersionArn | |
AttrVersionBaseThemeId | |
AttrVersionCreatedTime | |
AttrVersionDescription | |
AttrVersionErrors | |
AttrVersionStatus | |
AttrVersionVersionNumber | |
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. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnTheme(Construct, String, ICfnThemeProps)
Create a new AWS::QuickSight::Theme
.
public CfnTheme(Construct scope, string id, ICfnThemeProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnThemeProps
- resource properties.
CfnTheme(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnTheme(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnTheme(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnTheme(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrArn
The Amazon Resource Name (ARN) of the theme.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrCreatedTime
The time the theme was created.
public virtual string AttrCreatedTime { get; }
Property Value
System.String
Remarks
CloudformationAttribute: CreatedTime
AttrLastUpdatedTime
The time the theme was last updated.
public virtual string AttrLastUpdatedTime { get; }
Property Value
System.String
Remarks
CloudformationAttribute: LastUpdatedTime
AttrType
Theme type.
public virtual string AttrType { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Type
AttrVersionArn
public virtual string AttrVersionArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Version.Arn
AttrVersionBaseThemeId
public virtual string AttrVersionBaseThemeId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Version.BaseThemeId
AttrVersionCreatedTime
public virtual string AttrVersionCreatedTime { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Version.CreatedTime
AttrVersionDescription
public virtual string AttrVersionDescription { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Version.Description
AttrVersionErrors
public virtual IResolvable AttrVersionErrors { get; }
Property Value
Remarks
CloudformationAttribute: Version.Errors
AttrVersionStatus
public virtual string AttrVersionStatus { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Version.Status
AttrVersionVersionNumber
public virtual IResolvable AttrVersionVersionNumber { get; }
Property Value
Remarks
CloudformationAttribute: Version.VersionNumber
AwsAccountId
The ID of the AWS account where you want to store the new theme.
public virtual string AwsAccountId { get; set; }
Property Value
System.String
Remarks
BaseThemeId
The ID of the theme that a custom theme will inherit from.
public virtual 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.
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Configuration
The theme configuration, which contains the theme display properties.
public virtual object Configuration { get; set; }
Property Value
System.Object
Remarks
Name
A display name for the theme.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
Permissions
A valid grouping of resource permissions to apply to the new theme.
public virtual 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 virtual TagManager Tags { get; }
Property Value
Remarks
ThemeId
An ID for the theme that you want to create.
public virtual 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 virtual 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.
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>