Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. quicksight
  5. getTemplate

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.24.0 published on Wednesday, Jan 15, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.quicksight.getTemplate

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.24.0 published on Wednesday, Jan 15, 2025 by Pulumi
pulumi/pulumi-aws-native

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

    Using getTemplate

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getTemplate(args: GetTemplateArgs, opts?: InvokeOptions): Promise<GetTemplateResult>
function getTemplateOutput(args: GetTemplateOutputArgs, opts?: InvokeOptions): Output<GetTemplateResult>
    def get_template(aws_account_id: Optional[str] = None,
                 template_id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetTemplateResult
def get_template_output(aws_account_id: Optional[pulumi.Input[str]] = None,
                 template_id: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetTemplateResult]
    func LookupTemplate(ctx *Context, args *LookupTemplateArgs, opts ...InvokeOption) (*LookupTemplateResult, error)
func LookupTemplateOutput(ctx *Context, args *LookupTemplateOutputArgs, opts ...InvokeOption) LookupTemplateResultOutput

    > Note: This function is named LookupTemplate in the Go SDK.

    public static class GetTemplate 
{
    public static Task<GetTemplateResult> InvokeAsync(GetTemplateArgs args, InvokeOptions? opts = null)
    public static Output<GetTemplateResult> Invoke(GetTemplateInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetTemplateResult> getTemplate(GetTemplateArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws-native:quicksight:getTemplate
  arguments:
    # arguments dictionary

    The following arguments are supported:

    AwsAccountId string
    The ID for the AWS account that the group is in. You use the ID for the AWS account that contains your Amazon QuickSight account.
    TemplateId string
    An ID for the template that you want to create. This template is unique per AWS Region ; in each AWS account.
    AwsAccountId string
    The ID for the AWS account that the group is in. You use the ID for the AWS account that contains your Amazon QuickSight account.
    TemplateId string
    An ID for the template that you want to create. This template is unique per AWS Region ; in each AWS account.
    awsAccountId String
    The ID for the AWS account that the group is in. You use the ID for the AWS account that contains your Amazon QuickSight account.
    templateId String
    An ID for the template that you want to create. This template is unique per AWS Region ; in each AWS account.
    awsAccountId string
    The ID for the AWS account that the group is in. You use the ID for the AWS account that contains your Amazon QuickSight account.
    templateId string
    An ID for the template that you want to create. This template is unique per AWS Region ; in each AWS account.
    aws_account_id str
    The ID for the AWS account that the group is in. You use the ID for the AWS account that contains your Amazon QuickSight account.
    template_id str
    An ID for the template that you want to create. This template is unique per AWS Region ; in each AWS account.
    awsAccountId String
    The ID for the AWS account that the group is in. You use the ID for the AWS account that contains your Amazon QuickSight account.
    templateId String
    An ID for the template that you want to create. This template is unique per AWS Region ; in each AWS account.

    getTemplate Result

    The following output properties are available:

    Arn string
    CreatedTime string
    LastUpdatedTime string
    Name string
    A display name for the template.
    Permissions List<Pulumi.AwsNative.QuickSight.Outputs.TemplateResourcePermission>
    A list of resource permissions to be set on the template.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
    Version Pulumi.AwsNative.QuickSight.Outputs.TemplateVersion
    Arn string
    CreatedTime string
    LastUpdatedTime string
    Name string
    A display name for the template.
    Permissions []TemplateResourcePermission
    A list of resource permissions to be set on the template.
    Tags Tag
    Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
    Version TemplateVersion
    arn String
    createdTime String
    lastUpdatedTime String
    name String
    A display name for the template.
    permissions List<TemplateResourcePermission>
    A list of resource permissions to be set on the template.
    tags List<Tag>
    Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
    version TemplateVersion
    arn string
    createdTime string
    lastUpdatedTime string
    name string
    A display name for the template.
    permissions TemplateResourcePermission[]
    A list of resource permissions to be set on the template.
    tags Tag[]
    Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
    version TemplateVersion
    arn str
    created_time str
    last_updated_time str
    name str
    A display name for the template.
    permissions Sequence[TemplateResourcePermission]
    A list of resource permissions to be set on the template.
    tags Sequence[root_Tag]
    Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
    version TemplateVersion
    arn String
    createdTime String
    lastUpdatedTime String
    name String
    A display name for the template.
    permissions List<Property Map>
    A list of resource permissions to be set on the template.
    tags List<Property Map>
    Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
    version Property Map

    Supporting Types

    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 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

    TemplateColumnGroupColumnSchema

    Name string
    Name string
    name String
    name string
    name str
    name String

    TemplateColumnGroupSchema

    TemplateColumnIdentifier

    ColumnName string
    The name of the column.
    DataSetIdentifier string
    The data set that the column belongs to.
    ColumnName string
    The name of the column.
    DataSetIdentifier string
    The data set that the column belongs to.
    columnName String
    The name of the column.
    dataSetIdentifier String
    The data set that the column belongs to.
    columnName string
    The name of the column.
    dataSetIdentifier string
    The data set that the column belongs to.
    column_name str
    The name of the column.
    data_set_identifier str
    The data set that the column belongs to.
    columnName String
    The name of the column.
    dataSetIdentifier String
    The data set that the column belongs to.

    TemplateColumnSchema

    DataType string
    GeographicRole string
    Name string
    DataType string
    GeographicRole string
    Name string
    dataType String
    geographicRole String
    name String
    dataType string
    geographicRole string
    name string
    dataType String
    geographicRole String
    name String

    TemplateCustomActionNavigationOperation

    LocalNavigationConfiguration TemplateLocalNavigationConfiguration
    The configuration that chooses the navigation target.
    localNavigationConfiguration TemplateLocalNavigationConfiguration
    The configuration that chooses the navigation target.
    localNavigationConfiguration TemplateLocalNavigationConfiguration
    The configuration that chooses the navigation target.
    local_navigation_configuration TemplateLocalNavigationConfiguration
    The configuration that chooses the navigation target.
    localNavigationConfiguration Property Map
    The configuration that chooses the navigation target.

    TemplateCustomActionSetParametersOperation

    ParameterValueConfigurations []TemplateSetParameterValueConfiguration
    The parameter that determines the value configuration.
    parameterValueConfigurations List<TemplateSetParameterValueConfiguration>
    The parameter that determines the value configuration.
    parameterValueConfigurations TemplateSetParameterValueConfiguration[]
    The parameter that determines the value configuration.
    parameter_value_configurations Sequence[TemplateSetParameterValueConfiguration]
    The parameter that determines the value configuration.
    parameterValueConfigurations List<Property Map>
    The parameter that determines the value configuration.

    TemplateCustomActionUrlOperation

    UrlTarget Pulumi.AwsNative.QuickSight.TemplateUrlTargetConfiguration

    The target of the CustomActionURLOperation .

    Valid values are defined as follows:

    • NEW_TAB : Opens the target URL in a new browser tab.
    • NEW_WINDOW : Opens the target URL in a new browser window.
    • SAME_TAB : Opens the target URL in the same browser tab.
    UrlTemplate string
    THe URL link of the CustomActionURLOperation .
    UrlTarget TemplateUrlTargetConfiguration

    The target of the CustomActionURLOperation .

    Valid values are defined as follows:

    • NEW_TAB : Opens the target URL in a new browser tab.
    • NEW_WINDOW : Opens the target URL in a new browser window.
    • SAME_TAB : Opens the target URL in the same browser tab.
    UrlTemplate string
    THe URL link of the CustomActionURLOperation .
    urlTarget TemplateUrlTargetConfiguration

    The target of the CustomActionURLOperation .

    Valid values are defined as follows:

    • NEW_TAB : Opens the target URL in a new browser tab.
    • NEW_WINDOW : Opens the target URL in a new browser window.
    • SAME_TAB : Opens the target URL in the same browser tab.
    urlTemplate String
    THe URL link of the CustomActionURLOperation .
    urlTarget TemplateUrlTargetConfiguration

    The target of the CustomActionURLOperation .

    Valid values are defined as follows:

    • NEW_TAB : Opens the target URL in a new browser tab.
    • NEW_WINDOW : Opens the target URL in a new browser window.
    • SAME_TAB : Opens the target URL in the same browser tab.
    urlTemplate string
    THe URL link of the CustomActionURLOperation .
    url_target TemplateUrlTargetConfiguration

    The target of the CustomActionURLOperation .

    Valid values are defined as follows:

    • NEW_TAB : Opens the target URL in a new browser tab.
    • NEW_WINDOW : Opens the target URL in a new browser window.
    • SAME_TAB : Opens the target URL in the same browser tab.
    url_template str
    THe URL link of the CustomActionURLOperation .
    urlTarget "NEW_TAB" | "NEW_WINDOW" | "SAME_TAB"

    The target of the CustomActionURLOperation .

    Valid values are defined as follows:

    • NEW_TAB : Opens the target URL in a new browser tab.
    • NEW_WINDOW : Opens the target URL in a new browser window.
    • SAME_TAB : Opens the target URL in the same browser tab.
    urlTemplate String
    THe URL link of the CustomActionURLOperation .

    TemplateCustomParameterValues

    DateTimeValues List<string>
    A list of datetime-type parameter values.
    DecimalValues List<double>
    A list of decimal-type parameter values.
    IntegerValues List<double>
    A list of integer-type parameter values.
    StringValues List<string>
    A list of string-type parameter values.
    DateTimeValues []string
    A list of datetime-type parameter values.
    DecimalValues []float64
    A list of decimal-type parameter values.
    IntegerValues []float64
    A list of integer-type parameter values.
    StringValues []string
    A list of string-type parameter values.
    dateTimeValues List<String>
    A list of datetime-type parameter values.
    decimalValues List<Double>
    A list of decimal-type parameter values.
    integerValues List<Double>
    A list of integer-type parameter values.
    stringValues List<String>
    A list of string-type parameter values.
    dateTimeValues string[]
    A list of datetime-type parameter values.
    decimalValues number[]
    A list of decimal-type parameter values.
    integerValues number[]
    A list of integer-type parameter values.
    stringValues string[]
    A list of string-type parameter values.
    date_time_values Sequence[str]
    A list of datetime-type parameter values.
    decimal_values Sequence[float]
    A list of decimal-type parameter values.
    integer_values Sequence[float]
    A list of integer-type parameter values.
    string_values Sequence[str]
    A list of string-type parameter values.
    dateTimeValues List<String>
    A list of datetime-type parameter values.
    decimalValues List<Number>
    A list of decimal-type parameter values.
    integerValues List<Number>
    A list of integer-type parameter values.
    stringValues List<String>
    A list of string-type parameter values.

    TemplateCustomValuesConfiguration

    CustomValues Pulumi.AwsNative.QuickSight.Inputs.TemplateCustomParameterValues
    IncludeNullValue bool
    Includes the null value in custom action parameter values.
    CustomValues TemplateCustomParameterValues
    IncludeNullValue bool
    Includes the null value in custom action parameter values.
    customValues TemplateCustomParameterValues
    includeNullValue Boolean
    Includes the null value in custom action parameter values.
    customValues TemplateCustomParameterValues
    includeNullValue boolean
    Includes the null value in custom action parameter values.
    custom_values TemplateCustomParameterValues
    include_null_value bool
    Includes the null value in custom action parameter values.
    customValues Property Map
    includeNullValue Boolean
    Includes the null value in custom action parameter values.

    TemplateDataSetConfiguration

    TemplateDataSetSchema

    TemplateDestinationParameterValueConfiguration

    CustomValuesConfiguration Pulumi.AwsNative.QuickSight.Inputs.TemplateCustomValuesConfiguration
    The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
    SelectAllValueOptions Pulumi.AwsNative.QuickSight.TemplateSelectAllValueOptions
    The configuration that selects all options.
    SourceColumn Pulumi.AwsNative.QuickSight.Inputs.TemplateColumnIdentifier
    A column of a data set.
    SourceField string
    The source field ID of the destination parameter.
    SourceParameterName string
    The source parameter name of the destination parameter.
    CustomValuesConfiguration TemplateCustomValuesConfiguration
    The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
    SelectAllValueOptions TemplateSelectAllValueOptions
    The configuration that selects all options.
    SourceColumn TemplateColumnIdentifier
    A column of a data set.
    SourceField string
    The source field ID of the destination parameter.
    SourceParameterName string
    The source parameter name of the destination parameter.
    customValuesConfiguration TemplateCustomValuesConfiguration
    The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
    selectAllValueOptions TemplateSelectAllValueOptions
    The configuration that selects all options.
    sourceColumn TemplateColumnIdentifier
    A column of a data set.
    sourceField String
    The source field ID of the destination parameter.
    sourceParameterName String
    The source parameter name of the destination parameter.
    customValuesConfiguration TemplateCustomValuesConfiguration
    The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
    selectAllValueOptions TemplateSelectAllValueOptions
    The configuration that selects all options.
    sourceColumn TemplateColumnIdentifier
    A column of a data set.
    sourceField string
    The source field ID of the destination parameter.
    sourceParameterName string
    The source parameter name of the destination parameter.
    custom_values_configuration TemplateCustomValuesConfiguration
    The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
    select_all_value_options TemplateSelectAllValueOptions
    The configuration that selects all options.
    source_column TemplateColumnIdentifier
    A column of a data set.
    source_field str
    The source field ID of the destination parameter.
    source_parameter_name str
    The source parameter name of the destination parameter.
    customValuesConfiguration Property Map
    The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
    selectAllValueOptions "ALL_VALUES"
    The configuration that selects all options.
    sourceColumn Property Map
    A column of a data set.
    sourceField String
    The source field ID of the destination parameter.
    sourceParameterName String
    The source parameter name of the destination parameter.

    TemplateEntity

    Path string
    The hierarchical path of the entity within the analysis, template, or dashboard definition tree.
    Path string
    The hierarchical path of the entity within the analysis, template, or dashboard definition tree.
    path String
    The hierarchical path of the entity within the analysis, template, or dashboard definition tree.
    path string
    The hierarchical path of the entity within the analysis, template, or dashboard definition tree.
    path str
    The hierarchical path of the entity within the analysis, template, or dashboard definition tree.
    path String
    The hierarchical path of the entity within the analysis, template, or dashboard definition tree.

    TemplateError

    TemplateErrorType

    TemplateImageCustomAction

    ActionOperations List<Pulumi.AwsNative.QuickSight.Inputs.TemplateImageCustomActionOperation>

    A list of ImageCustomActionOperations .

    This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

    CustomActionId string
    The ID of the custom action.
    Name string
    The name of the custom action.
    Trigger Pulumi.AwsNative.QuickSight.TemplateImageCustomActionTrigger

    The trigger of the VisualCustomAction .

    Valid values are defined as follows:

    • CLICK : Initiates a custom action by a left pointer click on a data point.
    • MENU : Initiates a custom action by right pointer click from the menu.
    Status Pulumi.AwsNative.QuickSight.TemplateWidgetStatus
    The status of the custom action.
    ActionOperations []TemplateImageCustomActionOperation

    A list of ImageCustomActionOperations .

    This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

    CustomActionId string
    The ID of the custom action.
    Name string
    The name of the custom action.
    Trigger TemplateImageCustomActionTrigger

    The trigger of the VisualCustomAction .

    Valid values are defined as follows:

    • CLICK : Initiates a custom action by a left pointer click on a data point.
    • MENU : Initiates a custom action by right pointer click from the menu.
    Status TemplateWidgetStatus
    The status of the custom action.
    actionOperations List<TemplateImageCustomActionOperation>

    A list of ImageCustomActionOperations .

    This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

    customActionId String
    The ID of the custom action.
    name String
    The name of the custom action.
    trigger TemplateImageCustomActionTrigger

    The trigger of the VisualCustomAction .

    Valid values are defined as follows:

    • CLICK : Initiates a custom action by a left pointer click on a data point.
    • MENU : Initiates a custom action by right pointer click from the menu.
    status TemplateWidgetStatus
    The status of the custom action.
    actionOperations TemplateImageCustomActionOperation[]

    A list of ImageCustomActionOperations .

    This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

    customActionId string
    The ID of the custom action.
    name string
    The name of the custom action.
    trigger TemplateImageCustomActionTrigger

    The trigger of the VisualCustomAction .

    Valid values are defined as follows:

    • CLICK : Initiates a custom action by a left pointer click on a data point.
    • MENU : Initiates a custom action by right pointer click from the menu.
    status TemplateWidgetStatus
    The status of the custom action.
    action_operations Sequence[TemplateImageCustomActionOperation]

    A list of ImageCustomActionOperations .

    This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

    custom_action_id str
    The ID of the custom action.
    name str
    The name of the custom action.
    trigger TemplateImageCustomActionTrigger

    The trigger of the VisualCustomAction .

    Valid values are defined as follows:

    • CLICK : Initiates a custom action by a left pointer click on a data point.
    • MENU : Initiates a custom action by right pointer click from the menu.
    status TemplateWidgetStatus
    The status of the custom action.
    actionOperations List<Property Map>

    A list of ImageCustomActionOperations .

    This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

    customActionId String
    The ID of the custom action.
    name String
    The name of the custom action.
    trigger "CLICK" | "MENU"

    The trigger of the VisualCustomAction .

    Valid values are defined as follows:

    • CLICK : Initiates a custom action by a left pointer click on a data point.
    • MENU : Initiates a custom action by right pointer click from the menu.
    status "ENABLED" | "DISABLED"
    The status of the custom action.

    TemplateImageCustomActionOperation

    TemplateImageCustomActionTrigger

    TemplateImageInteractionOptions

    ImageMenuOption TemplateImageMenuOption
    The menu options for the image.
    imageMenuOption TemplateImageMenuOption
    The menu options for the image.
    imageMenuOption TemplateImageMenuOption
    The menu options for the image.
    image_menu_option TemplateImageMenuOption
    The menu options for the image.
    imageMenuOption Property Map
    The menu options for the image.

    TemplateImageMenuOption

    AvailabilityStatus object
    The availability status of the image menu. If the value of this property is set to ENABLED , dashboard readers can interact with the image menu.
    AvailabilityStatus interface{}
    The availability status of the image menu. If the value of this property is set to ENABLED , dashboard readers can interact with the image menu.
    availabilityStatus Object
    The availability status of the image menu. If the value of this property is set to ENABLED , dashboard readers can interact with the image menu.
    availabilityStatus any
    The availability status of the image menu. If the value of this property is set to ENABLED , dashboard readers can interact with the image menu.
    availability_status Any
    The availability status of the image menu. If the value of this property is set to ENABLED , dashboard readers can interact with the image menu.
    availabilityStatus Any
    The availability status of the image menu. If the value of this property is set to ENABLED , dashboard readers can interact with the image menu.

    TemplateLocalNavigationConfiguration

    TargetSheetId string
    The sheet that is targeted for navigation in the same analysis.
    TargetSheetId string
    The sheet that is targeted for navigation in the same analysis.
    targetSheetId String
    The sheet that is targeted for navigation in the same analysis.
    targetSheetId string
    The sheet that is targeted for navigation in the same analysis.
    target_sheet_id str
    The sheet that is targeted for navigation in the same analysis.
    targetSheetId String
    The sheet that is targeted for navigation in the same analysis.

    TemplateResourcePermission

    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

    TemplateResourceStatus

    TemplateSelectAllValueOptions

    TemplateSetParameterValueConfiguration

    DestinationParameterName string
    The destination parameter name of the SetParameterValueConfiguration .
    Value Pulumi.AwsNative.QuickSight.Inputs.TemplateDestinationParameterValueConfiguration
    DestinationParameterName string
    The destination parameter name of the SetParameterValueConfiguration .
    Value TemplateDestinationParameterValueConfiguration
    destinationParameterName String
    The destination parameter name of the SetParameterValueConfiguration .
    value TemplateDestinationParameterValueConfiguration
    destinationParameterName string
    The destination parameter name of the SetParameterValueConfiguration .
    value TemplateDestinationParameterValueConfiguration
    destination_parameter_name str
    The destination parameter name of the SetParameterValueConfiguration .
    value TemplateDestinationParameterValueConfiguration
    destinationParameterName String
    The destination parameter name of the SetParameterValueConfiguration .
    value Property Map

    TemplateSheet

    Images []TemplateSheetImage
    A list of images on a sheet.
    Name string
    SheetId string
    images List<TemplateSheetImage>
    A list of images on a sheet.
    name String
    sheetId String
    images TemplateSheetImage[]
    A list of images on a sheet.
    name string
    sheetId string
    images Sequence[TemplateSheetImage]
    A list of images on a sheet.
    name str
    sheet_id str
    images List<Property Map>
    A list of images on a sheet.
    name String
    sheetId String

    TemplateSheetImage

    SheetImageId string
    The ID of the sheet image.
    Source Pulumi.AwsNative.QuickSight.Inputs.TemplateSheetImageSource
    The source of the image.
    Actions List<Pulumi.AwsNative.QuickSight.Inputs.TemplateImageCustomAction>
    A list of custom actions that are configured for an image.
    ImageContentAltText string
    The alt text for the image.
    Interactions Pulumi.AwsNative.QuickSight.Inputs.TemplateImageInteractionOptions
    The general image interactions setup for an image.
    Scaling Pulumi.AwsNative.QuickSight.Inputs.TemplateSheetImageScalingConfiguration
    Determines how the image is scaled.
    Tooltip Pulumi.AwsNative.QuickSight.Inputs.TemplateSheetImageTooltipConfiguration
    The tooltip to be shown when hovering over the image.
    SheetImageId string
    The ID of the sheet image.
    Source TemplateSheetImageSource
    The source of the image.
    Actions []TemplateImageCustomAction
    A list of custom actions that are configured for an image.
    ImageContentAltText string
    The alt text for the image.
    Interactions TemplateImageInteractionOptions
    The general image interactions setup for an image.
    Scaling TemplateSheetImageScalingConfiguration
    Determines how the image is scaled.
    Tooltip TemplateSheetImageTooltipConfiguration
    The tooltip to be shown when hovering over the image.
    sheetImageId String
    The ID of the sheet image.
    source TemplateSheetImageSource
    The source of the image.
    actions List<TemplateImageCustomAction>
    A list of custom actions that are configured for an image.
    imageContentAltText String
    The alt text for the image.
    interactions TemplateImageInteractionOptions
    The general image interactions setup for an image.
    scaling TemplateSheetImageScalingConfiguration
    Determines how the image is scaled.
    tooltip TemplateSheetImageTooltipConfiguration
    The tooltip to be shown when hovering over the image.
    sheetImageId string
    The ID of the sheet image.
    source TemplateSheetImageSource
    The source of the image.
    actions TemplateImageCustomAction[]
    A list of custom actions that are configured for an image.
    imageContentAltText string
    The alt text for the image.
    interactions TemplateImageInteractionOptions
    The general image interactions setup for an image.
    scaling TemplateSheetImageScalingConfiguration
    Determines how the image is scaled.
    tooltip TemplateSheetImageTooltipConfiguration
    The tooltip to be shown when hovering over the image.
    sheet_image_id str
    The ID of the sheet image.
    source TemplateSheetImageSource
    The source of the image.
    actions Sequence[TemplateImageCustomAction]
    A list of custom actions that are configured for an image.
    image_content_alt_text str
    The alt text for the image.
    interactions TemplateImageInteractionOptions
    The general image interactions setup for an image.
    scaling TemplateSheetImageScalingConfiguration
    Determines how the image is scaled.
    tooltip TemplateSheetImageTooltipConfiguration
    The tooltip to be shown when hovering over the image.
    sheetImageId String
    The ID of the sheet image.
    source Property Map
    The source of the image.
    actions List<Property Map>
    A list of custom actions that are configured for an image.
    imageContentAltText String
    The alt text for the image.
    interactions Property Map
    The general image interactions setup for an image.
    scaling Property Map
    Determines how the image is scaled.
    tooltip Property Map
    The tooltip to be shown when hovering over the image.

    TemplateSheetImageScalingConfiguration

    ScalingType Pulumi.AwsNative.QuickSight.TemplateSheetImageScalingType

    The scaling option to use when fitting the image inside the container.

    Valid values are defined as follows:

    • SCALE_TO_WIDTH : The image takes up the entire width of the container. The image aspect ratio is preserved.
    • SCALE_TO_HEIGHT : The image takes up the entire height of the container. The image aspect ratio is preserved.
    • SCALE_TO_CONTAINER : The image takes up the entire width and height of the container. The image aspect ratio is not preserved.
    • SCALE_NONE : The image is displayed in its original size and is not scaled to the container.
    ScalingType TemplateSheetImageScalingType

    The scaling option to use when fitting the image inside the container.

    Valid values are defined as follows:

    • SCALE_TO_WIDTH : The image takes up the entire width of the container. The image aspect ratio is preserved.
    • SCALE_TO_HEIGHT : The image takes up the entire height of the container. The image aspect ratio is preserved.
    • SCALE_TO_CONTAINER : The image takes up the entire width and height of the container. The image aspect ratio is not preserved.
    • SCALE_NONE : The image is displayed in its original size and is not scaled to the container.
    scalingType TemplateSheetImageScalingType

    The scaling option to use when fitting the image inside the container.

    Valid values are defined as follows:

    • SCALE_TO_WIDTH : The image takes up the entire width of the container. The image aspect ratio is preserved.
    • SCALE_TO_HEIGHT : The image takes up the entire height of the container. The image aspect ratio is preserved.
    • SCALE_TO_CONTAINER : The image takes up the entire width and height of the container. The image aspect ratio is not preserved.
    • SCALE_NONE : The image is displayed in its original size and is not scaled to the container.
    scalingType TemplateSheetImageScalingType

    The scaling option to use when fitting the image inside the container.

    Valid values are defined as follows:

    • SCALE_TO_WIDTH : The image takes up the entire width of the container. The image aspect ratio is preserved.
    • SCALE_TO_HEIGHT : The image takes up the entire height of the container. The image aspect ratio is preserved.
    • SCALE_TO_CONTAINER : The image takes up the entire width and height of the container. The image aspect ratio is not preserved.
    • SCALE_NONE : The image is displayed in its original size and is not scaled to the container.
    scaling_type TemplateSheetImageScalingType

    The scaling option to use when fitting the image inside the container.

    Valid values are defined as follows:

    • SCALE_TO_WIDTH : The image takes up the entire width of the container. The image aspect ratio is preserved.
    • SCALE_TO_HEIGHT : The image takes up the entire height of the container. The image aspect ratio is preserved.
    • SCALE_TO_CONTAINER : The image takes up the entire width and height of the container. The image aspect ratio is not preserved.
    • SCALE_NONE : The image is displayed in its original size and is not scaled to the container.
    scalingType "SCALE_TO_WIDTH" | "SCALE_TO_HEIGHT" | "SCALE_TO_CONTAINER" | "SCALE_NONE"

    The scaling option to use when fitting the image inside the container.

    Valid values are defined as follows:

    • SCALE_TO_WIDTH : The image takes up the entire width of the container. The image aspect ratio is preserved.
    • SCALE_TO_HEIGHT : The image takes up the entire height of the container. The image aspect ratio is preserved.
    • SCALE_TO_CONTAINER : The image takes up the entire width and height of the container. The image aspect ratio is not preserved.
    • SCALE_NONE : The image is displayed in its original size and is not scaled to the container.

    TemplateSheetImageScalingType

    TemplateSheetImageSource

    SheetImageStaticFileSource TemplateSheetImageStaticFileSource
    The source of the static file that contains the image.
    sheetImageStaticFileSource TemplateSheetImageStaticFileSource
    The source of the static file that contains the image.
    sheetImageStaticFileSource TemplateSheetImageStaticFileSource
    The source of the static file that contains the image.
    sheet_image_static_file_source TemplateSheetImageStaticFileSource
    The source of the static file that contains the image.
    sheetImageStaticFileSource Property Map
    The source of the static file that contains the image.

    TemplateSheetImageStaticFileSource

    StaticFileId string
    The ID of the static file that contains the image.
    StaticFileId string
    The ID of the static file that contains the image.
    staticFileId String
    The ID of the static file that contains the image.
    staticFileId string
    The ID of the static file that contains the image.
    static_file_id str
    The ID of the static file that contains the image.
    staticFileId String
    The ID of the static file that contains the image.

    TemplateSheetImageTooltipConfiguration

    TooltipText Pulumi.AwsNative.QuickSight.Inputs.TemplateSheetImageTooltipText
    The text that appears in the tooltip.
    Visibility object
    The visibility of the tooltip.
    TooltipText TemplateSheetImageTooltipText
    The text that appears in the tooltip.
    Visibility interface{}
    The visibility of the tooltip.
    tooltipText TemplateSheetImageTooltipText
    The text that appears in the tooltip.
    visibility Object
    The visibility of the tooltip.
    tooltipText TemplateSheetImageTooltipText
    The text that appears in the tooltip.
    visibility any
    The visibility of the tooltip.
    tooltip_text TemplateSheetImageTooltipText
    The text that appears in the tooltip.
    visibility Any
    The visibility of the tooltip.
    tooltipText Property Map
    The text that appears in the tooltip.
    visibility Any
    The visibility of the tooltip.

    TemplateSheetImageTooltipText

    PlainText string
    The plain text format.
    PlainText string
    The plain text format.
    plainText String
    The plain text format.
    plainText string
    The plain text format.
    plain_text str
    The plain text format.
    plainText String
    The plain text format.

    TemplateUrlTargetConfiguration

    TemplateVersion

    CreatedTime string
    DataSetConfigurations []TemplateDataSetConfiguration
    Description string
    Errors []TemplateError
    Sheets []TemplateSheet
    SourceEntityArn string
    Status TemplateResourceStatus
    The status that is associated with the template.

    • CREATION_IN_PROGRESS
    • CREATION_SUCCESSFUL
    • CREATION_FAILED
    • UPDATE_IN_PROGRESS
    • UPDATE_SUCCESSFUL
    • UPDATE_FAILED
    • DELETED
    ThemeArn string
    VersionNumber float64
    createdTime String
    dataSetConfigurations List<TemplateDataSetConfiguration>
    description String
    errors List<TemplateError>
    sheets List<TemplateSheet>
    sourceEntityArn String
    status TemplateResourceStatus
    The status that is associated with the template.

    • CREATION_IN_PROGRESS
    • CREATION_SUCCESSFUL
    • CREATION_FAILED
    • UPDATE_IN_PROGRESS
    • UPDATE_SUCCESSFUL
    • UPDATE_FAILED
    • DELETED
    themeArn String
    versionNumber Double
    createdTime string
    dataSetConfigurations TemplateDataSetConfiguration[]
    description string
    errors TemplateError[]
    sheets TemplateSheet[]
    sourceEntityArn string
    status TemplateResourceStatus
    The status that is associated with the template.

    • CREATION_IN_PROGRESS
    • CREATION_SUCCESSFUL
    • CREATION_FAILED
    • UPDATE_IN_PROGRESS
    • UPDATE_SUCCESSFUL
    • UPDATE_FAILED
    • DELETED
    themeArn string
    versionNumber number
    created_time str
    data_set_configurations Sequence[TemplateDataSetConfiguration]
    description str
    errors Sequence[TemplateError]
    sheets Sequence[TemplateSheet]
    source_entity_arn str
    status TemplateResourceStatus
    The status that is associated with the template.

    • CREATION_IN_PROGRESS
    • CREATION_SUCCESSFUL
    • CREATION_FAILED
    • UPDATE_IN_PROGRESS
    • UPDATE_SUCCESSFUL
    • UPDATE_FAILED
    • DELETED
    theme_arn str
    version_number float
    createdTime String
    dataSetConfigurations List<Property Map>
    description String
    errors List<Property Map>
    sheets List<Property Map>
    sourceEntityArn String
    status "CREATION_IN_PROGRESS" | "CREATION_SUCCESSFUL" | "CREATION_FAILED" | "UPDATE_IN_PROGRESS" | "UPDATE_SUCCESSFUL" | "UPDATE_FAILED" | "DELETED"
    The status that is associated with the template.

    • CREATION_IN_PROGRESS
    • CREATION_SUCCESSFUL
    • CREATION_FAILED
    • UPDATE_IN_PROGRESS
    • UPDATE_SUCCESSFUL
    • UPDATE_FAILED
    • DELETED
    themeArn String
    versionNumber Number

    TemplateWidgetStatus

    Package Details

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

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.24.0 published on Wednesday, Jan 15, 2025 by Pulumi
    pulumi/pulumi-aws-native