@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
118 lines (117 loc) • 5.14 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* Definition of the AWS::QuickSight::Theme Resource Type.
*/
export declare class Theme extends pulumi.CustomResource {
/**
* Get an existing Theme resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): Theme;
/**
* Returns true if the given object is an instance of Theme. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Theme;
/**
* <p>The Amazon Resource Name (ARN) of the theme.</p>
*/
readonly arn: pulumi.Output<string>;
/**
* The ID of the AWS account where you want to store the new theme.
*/
readonly awsAccountId: pulumi.Output<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 Quick Sight. For a list of the starting themes, use `ListThemes` or choose *Themes* from within an analysis.
*/
readonly baseThemeId: pulumi.Output<string>;
/**
* The theme configuration, which contains the theme display properties.
*/
readonly configuration: pulumi.Output<outputs.quicksight.ThemeConfiguration>;
/**
* <p>The date and time that the theme was created.</p>
*/
readonly createdTime: pulumi.Output<string>;
/**
* <p>The date and time that the theme was last updated.</p>
*/
readonly lastUpdatedTime: pulumi.Output<string>;
/**
* A display name for the theme.
*/
readonly name: pulumi.Output<string>;
/**
* A valid grouping of resource permissions to apply to the new theme.
*/
readonly permissions: pulumi.Output<outputs.quicksight.ThemeResourcePermission[] | undefined>;
/**
* A map of the key-value pairs for the resource tag or tags that you want to add to the resource.
*/
readonly tags: pulumi.Output<outputs.Tag[] | undefined>;
/**
* An ID for the theme that you want to create. The theme ID is unique per AWS Region in each AWS account.
*/
readonly themeId: pulumi.Output<string>;
/**
* Theme type.
*/
readonly type: pulumi.Output<enums.quicksight.ThemeType>;
readonly version: pulumi.Output<outputs.quicksight.ThemeVersion>;
/**
* 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.
*/
readonly versionDescription: pulumi.Output<string | undefined>;
/**
* Create a Theme resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: ThemeArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a Theme resource.
*/
export interface ThemeArgs {
/**
* The ID of the AWS account where you want to store the new theme.
*/
awsAccountId: pulumi.Input<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 Quick Sight. For a list of the starting themes, use `ListThemes` or choose *Themes* from within an analysis.
*/
baseThemeId: pulumi.Input<string>;
/**
* The theme configuration, which contains the theme display properties.
*/
configuration: pulumi.Input<inputs.quicksight.ThemeConfigurationArgs>;
/**
* A display name for the theme.
*/
name?: pulumi.Input<string>;
/**
* A valid grouping of resource permissions to apply to the new theme.
*/
permissions?: pulumi.Input<pulumi.Input<inputs.quicksight.ThemeResourcePermissionArgs>[]>;
/**
* A map of the key-value pairs for the resource tag or tags that you want to add to the resource.
*/
tags?: pulumi.Input<pulumi.Input<inputs.TagArgs>[]>;
/**
* An ID for the theme that you want to create. The theme ID is unique per AWS Region in each AWS account.
*/
themeId: pulumi.Input<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.
*/
versionDescription?: pulumi.Input<string>;
}