Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. quicksight
  5. Theme

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.quicksight.Theme

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

    Definition of the AWS::QuickSight::Theme Resource Type.

    Create Theme Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Theme(name: string, args: ThemeArgs, opts?: CustomResourceOptions);
    @overload
def Theme(resource_name: str,
          args: ThemeArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Theme(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          aws_account_id: Optional[str] = None,
          base_theme_id: Optional[str] = None,
          configuration: Optional[ThemeConfigurationArgs] = None,
          theme_id: Optional[str] = None,
          name: Optional[str] = None,
          permissions: Optional[Sequence[ThemeResourcePermissionArgs]] = None,
          tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
          version_description: Optional[str] = None)
    func NewTheme(ctx *Context, name string, args ThemeArgs, opts ...ResourceOption) (*Theme, error)
    public Theme(string name, ThemeArgs args, CustomResourceOptions? opts = null)
    public Theme(String name, ThemeArgs args)
public Theme(String name, ThemeArgs args, CustomResourceOptions options)

    type: aws-native:quicksight:Theme
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ThemeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ThemeArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ThemeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ThemeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ThemeArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Theme Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Theme resource accepts the following input properties:

    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. 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 Pulumi.AwsNative.QuickSight.Inputs.ThemeConfiguration
    The theme configuration, which contains the theme display properties.
    ThemeId string
    An ID for the theme that you want to create. The theme ID is unique per AWS Region in each AWS account.
    Name string
    A display name for the theme.
    Permissions List<Pulumi.AwsNative.QuickSight.Inputs.ThemeResourcePermission>
    A valid grouping of resource permissions to apply to the new theme.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    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. 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.
    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. 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 ThemeConfigurationArgs
    The theme configuration, which contains the theme display properties.
    ThemeId string
    An ID for the theme that you want to create. The theme ID is unique per AWS Region in each AWS account.
    Name string
    A display name for the theme.
    Permissions []ThemeResourcePermissionArgs
    A valid grouping of resource permissions to apply to the new theme.
    Tags TagArgs
    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. 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.
    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. 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 ThemeConfiguration
    The theme configuration, which contains the theme display properties.
    themeId String
    An ID for the theme that you want to create. The theme ID is unique per AWS Region in each AWS account.
    name String
    A display name for the theme.
    permissions List<ThemeResourcePermission>
    A valid grouping of resource permissions to apply to the new theme.
    tags List<Tag>
    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. 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.
    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. 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 ThemeConfiguration
    The theme configuration, which contains the theme display properties.
    themeId string
    An ID for the theme that you want to create. The theme ID is unique per AWS Region in each AWS account.
    name string
    A display name for the theme.
    permissions ThemeResourcePermission[]
    A valid grouping of resource permissions to apply to the new theme.
    tags Tag[]
    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. 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.
    aws_account_id str
    The ID of the AWS account where you want to store the new theme.
    base_theme_id str
    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.
    configuration ThemeConfigurationArgs
    The theme configuration, which contains the theme display properties.
    theme_id str
    An ID for the theme that you want to create. The theme ID is unique per AWS Region in each AWS account.
    name str
    A display name for the theme.
    permissions Sequence[ThemeResourcePermissionArgs]
    A valid grouping of resource permissions to apply to the new theme.
    tags Sequence[TagArgs]
    A map of the key-value pairs for the resource tag or tags that you want to add to the resource.
    version_description str
    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.
    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. 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 Property Map
    The theme configuration, which contains the theme display properties.
    themeId String
    An ID for the theme that you want to create. The theme ID is unique per AWS Region in each AWS account.
    name String
    A display name for the theme.
    permissions List<Property Map>
    A valid grouping of resource permissions to apply to the new theme.
    tags List<Property Map>
    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. 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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Theme resource produces the following output properties:

    Arn string
    CreatedTime string
    Id string
    The provider-assigned unique ID for this managed resource.
    LastUpdatedTime string
    Type Pulumi.AwsNative.QuickSight.ThemeType
    Theme type.
    Version Pulumi.AwsNative.QuickSight.Outputs.ThemeVersion
    Arn string
    CreatedTime string
    Id string
    The provider-assigned unique ID for this managed resource.
    LastUpdatedTime string
    Type ThemeType
    Theme type.
    Version ThemeVersion
    arn String
    createdTime String
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdatedTime String
    type ThemeType
    Theme type.
    version ThemeVersion
    arn string
    createdTime string
    id string
    The provider-assigned unique ID for this managed resource.
    lastUpdatedTime string
    type ThemeType
    Theme type.
    version ThemeVersion
    arn str
    created_time str
    id str
    The provider-assigned unique ID for this managed resource.
    last_updated_time str
    type ThemeType
    Theme type.
    version ThemeVersion
    arn String
    createdTime String
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdatedTime String
    type "QUICKSIGHT" | "CUSTOM" | "ALL"
    Theme type.
    version Property Map

    Supporting Types

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    ThemeBorderStyle, ThemeBorderStyleArgs

    Show bool
    Show bool
    show Boolean
    show boolean
    show bool
    show Boolean

    ThemeConfiguration, ThemeConfigurationArgs

    DataColorPalette Pulumi.AwsNative.QuickSight.Inputs.ThemeDataColorPalette
    Color properties that apply to chart data colors.
    Sheet Pulumi.AwsNative.QuickSight.Inputs.ThemeSheetStyle
    Display options related to sheets.
    Typography Pulumi.AwsNative.QuickSight.Inputs.ThemeTypography
    UiColorPalette Pulumi.AwsNative.QuickSight.Inputs.ThemeUiColorPalette
    Color properties that apply to the UI and to charts, excluding the colors that apply to data.
    DataColorPalette ThemeDataColorPalette
    Color properties that apply to chart data colors.
    Sheet ThemeSheetStyle
    Display options related to sheets.
    Typography ThemeTypography
    UiColorPalette ThemeUiColorPalette
    Color properties that apply to the UI and to charts, excluding the colors that apply to data.
    dataColorPalette ThemeDataColorPalette
    Color properties that apply to chart data colors.
    sheet ThemeSheetStyle
    Display options related to sheets.
    typography ThemeTypography
    uiColorPalette ThemeUiColorPalette
    Color properties that apply to the UI and to charts, excluding the colors that apply to data.
    dataColorPalette ThemeDataColorPalette
    Color properties that apply to chart data colors.
    sheet ThemeSheetStyle
    Display options related to sheets.
    typography ThemeTypography
    uiColorPalette ThemeUiColorPalette
    Color properties that apply to the UI and to charts, excluding the colors that apply to data.
    data_color_palette ThemeDataColorPalette
    Color properties that apply to chart data colors.
    sheet ThemeSheetStyle
    Display options related to sheets.
    typography ThemeTypography
    ui_color_palette ThemeUiColorPalette
    Color properties that apply to the UI and to charts, excluding the colors that apply to data.
    dataColorPalette Property Map
    Color properties that apply to chart data colors.
    sheet Property Map
    Display options related to sheets.
    typography Property Map
    uiColorPalette Property Map
    Color properties that apply to the UI and to charts, excluding the colors that apply to data.

    ThemeDataColorPalette, ThemeDataColorPaletteArgs

    Colors List<string>
    EmptyFillColor string
    MinMaxGradient List<string>
    Colors []string
    EmptyFillColor string
    MinMaxGradient []string
    colors List<String>
    emptyFillColor String
    minMaxGradient List<String>
    colors string[]
    emptyFillColor string
    minMaxGradient string[]
    colors Sequence[str]
    empty_fill_color str
    min_max_gradient Sequence[str]
    colors List<String>
    emptyFillColor String
    minMaxGradient List<String>

    ThemeError, ThemeErrorArgs

    Message string
    Type ThemeErrorType
    The type of error.
    message String
    type ThemeErrorType
    The type of error.
    message string
    type ThemeErrorType
    The type of error.
    message str
    type ThemeErrorType
    The type of error.
    message String
    type "INTERNAL_FAILURE"
    The type of error.

    ThemeErrorType, ThemeErrorTypeArgs

    InternalFailure
    INTERNAL_FAILURE
    ThemeErrorTypeInternalFailure
    INTERNAL_FAILURE
    InternalFailure
    INTERNAL_FAILURE
    InternalFailure
    INTERNAL_FAILURE
    INTERNAL_FAILURE
    INTERNAL_FAILURE
    "INTERNAL_FAILURE"
    INTERNAL_FAILURE

    ThemeFont, ThemeFontArgs

    FontFamily string
    Determines the font family settings.
    FontFamily string
    Determines the font family settings.
    fontFamily String
    Determines the font family settings.
    fontFamily string
    Determines the font family settings.
    font_family str
    Determines the font family settings.
    fontFamily String
    Determines the font family settings.

    ThemeGutterStyle, ThemeGutterStyleArgs

    Show bool
    Show bool
    show Boolean
    show boolean
    show bool
    show Boolean

    ThemeMarginStyle, ThemeMarginStyleArgs

    Show bool
    Show bool
    show Boolean
    show boolean
    show bool
    show Boolean

    ThemeResourcePermission, ThemeResourcePermissionArgs

    Actions List<string>
    Principal string
    Actions []string
    Principal string
    actions List<String>
    principal String
    actions string[]
    principal string
    actions Sequence[str]
    principal str
    actions List<String>
    principal String

    ThemeResourceStatus, ThemeResourceStatusArgs

    CreationInProgress
    CREATION_IN_PROGRESS
    CreationSuccessful
    CREATION_SUCCESSFUL
    CreationFailed
    CREATION_FAILED
    UpdateInProgress
    UPDATE_IN_PROGRESS
    UpdateSuccessful
    UPDATE_SUCCESSFUL
    UpdateFailed
    UPDATE_FAILED
    Deleted
    DELETED
    ThemeResourceStatusCreationInProgress
    CREATION_IN_PROGRESS
    ThemeResourceStatusCreationSuccessful
    CREATION_SUCCESSFUL
    ThemeResourceStatusCreationFailed
    CREATION_FAILED
    ThemeResourceStatusUpdateInProgress
    UPDATE_IN_PROGRESS
    ThemeResourceStatusUpdateSuccessful
    UPDATE_SUCCESSFUL
    ThemeResourceStatusUpdateFailed
    UPDATE_FAILED
    ThemeResourceStatusDeleted
    DELETED
    CreationInProgress
    CREATION_IN_PROGRESS
    CreationSuccessful
    CREATION_SUCCESSFUL
    CreationFailed
    CREATION_FAILED
    UpdateInProgress
    UPDATE_IN_PROGRESS
    UpdateSuccessful
    UPDATE_SUCCESSFUL
    UpdateFailed
    UPDATE_FAILED
    Deleted
    DELETED
    CreationInProgress
    CREATION_IN_PROGRESS
    CreationSuccessful
    CREATION_SUCCESSFUL
    CreationFailed
    CREATION_FAILED
    UpdateInProgress
    UPDATE_IN_PROGRESS
    UpdateSuccessful
    UPDATE_SUCCESSFUL
    UpdateFailed
    UPDATE_FAILED
    Deleted
    DELETED
    CREATION_IN_PROGRESS
    CREATION_IN_PROGRESS
    CREATION_SUCCESSFUL
    CREATION_SUCCESSFUL
    CREATION_FAILED
    CREATION_FAILED
    UPDATE_IN_PROGRESS
    UPDATE_IN_PROGRESS
    UPDATE_SUCCESSFUL
    UPDATE_SUCCESSFUL
    UPDATE_FAILED
    UPDATE_FAILED
    DELETED
    DELETED
    "CREATION_IN_PROGRESS"
    CREATION_IN_PROGRESS
    "CREATION_SUCCESSFUL"
    CREATION_SUCCESSFUL
    "CREATION_FAILED"
    CREATION_FAILED
    "UPDATE_IN_PROGRESS"
    UPDATE_IN_PROGRESS
    "UPDATE_SUCCESSFUL"
    UPDATE_SUCCESSFUL
    "UPDATE_FAILED"
    UPDATE_FAILED
    "DELETED"
    DELETED

    ThemeSheetStyle, ThemeSheetStyleArgs

    Tile ThemeTileStyle
    The display options for tiles.
    TileLayout ThemeTileLayoutStyle
    The layout options for tiles.
    tile ThemeTileStyle
    The display options for tiles.
    tileLayout ThemeTileLayoutStyle
    The layout options for tiles.
    tile ThemeTileStyle
    The display options for tiles.
    tileLayout ThemeTileLayoutStyle
    The layout options for tiles.
    tile ThemeTileStyle
    The display options for tiles.
    tile_layout ThemeTileLayoutStyle
    The layout options for tiles.
    tile Property Map
    The display options for tiles.
    tileLayout Property Map
    The layout options for tiles.

    ThemeTileLayoutStyle, ThemeTileLayoutStyleArgs

    Gutter Pulumi.AwsNative.QuickSight.Inputs.ThemeGutterStyle
    The gutter settings that apply between tiles.
    Margin Pulumi.AwsNative.QuickSight.Inputs.ThemeMarginStyle
    The margin settings that apply around the outside edge of sheets.
    Gutter ThemeGutterStyle
    The gutter settings that apply between tiles.
    Margin ThemeMarginStyle
    The margin settings that apply around the outside edge of sheets.
    gutter ThemeGutterStyle
    The gutter settings that apply between tiles.
    margin ThemeMarginStyle
    The margin settings that apply around the outside edge of sheets.
    gutter ThemeGutterStyle
    The gutter settings that apply between tiles.
    margin ThemeMarginStyle
    The margin settings that apply around the outside edge of sheets.
    gutter ThemeGutterStyle
    The gutter settings that apply between tiles.
    margin ThemeMarginStyle
    The margin settings that apply around the outside edge of sheets.
    gutter Property Map
    The gutter settings that apply between tiles.
    margin Property Map
    The margin settings that apply around the outside edge of sheets.

    ThemeTileStyle, ThemeTileStyleArgs

    Border ThemeBorderStyle
    The border around a tile.
    border ThemeBorderStyle
    The border around a tile.
    border ThemeBorderStyle
    The border around a tile.
    border ThemeBorderStyle
    The border around a tile.
    border Property Map
    The border around a tile.

    ThemeType, ThemeTypeArgs

    Quicksight
    QUICKSIGHT
    Custom
    CUSTOM
    All
    ALL
    ThemeTypeQuicksight
    QUICKSIGHT
    ThemeTypeCustom
    CUSTOM
    ThemeTypeAll
    ALL
    Quicksight
    QUICKSIGHT
    Custom
    CUSTOM
    All
    ALL
    Quicksight
    QUICKSIGHT
    Custom
    CUSTOM
    All
    ALL
    QUICKSIGHT
    QUICKSIGHT
    CUSTOM
    CUSTOM
    ALL
    ALL
    "QUICKSIGHT"
    QUICKSIGHT
    "CUSTOM"
    CUSTOM
    "ALL"
    ALL

    ThemeTypography, ThemeTypographyArgs

    FontFamilies []ThemeFont
    Determines the list of font families.
    fontFamilies List<ThemeFont>
    Determines the list of font families.
    fontFamilies ThemeFont[]
    Determines the list of font families.
    font_families Sequence[ThemeFont]
    Determines the list of font families.
    fontFamilies List<Property Map>
    Determines the list of font families.

    ThemeUiColorPalette, ThemeUiColorPaletteArgs

    ThemeVersion, ThemeVersionArgs

    Arn string
    BaseThemeId string
    Configuration ThemeConfiguration
    The theme configuration, which contains all the theme display properties.
    CreatedTime string
    Description string
    Errors []ThemeError
    Status ThemeResourceStatus
    The status of the theme version.
    VersionNumber float64
    arn String
    baseThemeId String
    configuration ThemeConfiguration
    The theme configuration, which contains all the theme display properties.
    createdTime String
    description String
    errors List<ThemeError>
    status ThemeResourceStatus
    The status of the theme version.
    versionNumber Double
    arn string
    baseThemeId string
    configuration ThemeConfiguration
    The theme configuration, which contains all the theme display properties.
    createdTime string
    description string
    errors ThemeError[]
    status ThemeResourceStatus
    The status of the theme version.
    versionNumber number
    arn str
    base_theme_id str
    configuration ThemeConfiguration
    The theme configuration, which contains all the theme display properties.
    created_time str
    description str
    errors Sequence[ThemeError]
    status ThemeResourceStatus
    The status of the theme version.
    version_number float

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-aws-native