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

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

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::Dashboard Resource Type.

    Using getDashboard

    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 getDashboard(args: GetDashboardArgs, opts?: InvokeOptions): Promise<GetDashboardResult>
function getDashboardOutput(args: GetDashboardOutputArgs, opts?: InvokeOptions): Output<GetDashboardResult>
    def get_dashboard(aws_account_id: Optional[str] = None,
                  dashboard_id: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetDashboardResult
def get_dashboard_output(aws_account_id: Optional[pulumi.Input[str]] = None,
                  dashboard_id: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetDashboardResult]
    func LookupDashboard(ctx *Context, args *LookupDashboardArgs, opts ...InvokeOption) (*LookupDashboardResult, error)
func LookupDashboardOutput(ctx *Context, args *LookupDashboardOutputArgs, opts ...InvokeOption) LookupDashboardResultOutput

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

    public static class GetDashboard 
{
    public static Task<GetDashboardResult> InvokeAsync(GetDashboardArgs args, InvokeOptions? opts = null)
    public static Output<GetDashboardResult> Invoke(GetDashboardInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetDashboardResult> getDashboard(GetDashboardArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

    The following arguments are supported:

    AwsAccountId string
    The ID of the AWS account where you want to create the dashboard.
    DashboardId string
    The ID for the dashboard, also added to the IAM policy.
    AwsAccountId string
    The ID of the AWS account where you want to create the dashboard.
    DashboardId string
    The ID for the dashboard, also added to the IAM policy.
    awsAccountId String
    The ID of the AWS account where you want to create the dashboard.
    dashboardId String
    The ID for the dashboard, also added to the IAM policy.
    awsAccountId string
    The ID of the AWS account where you want to create the dashboard.
    dashboardId string
    The ID for the dashboard, also added to the IAM policy.
    aws_account_id str
    The ID of the AWS account where you want to create the dashboard.
    dashboard_id str
    The ID for the dashboard, also added to the IAM policy.
    awsAccountId String
    The ID of the AWS account where you want to create the dashboard.
    dashboardId String
    The ID for the dashboard, also added to the IAM policy.

    getDashboard Result

    The following output properties are available:

    Arn string
    CreatedTime string
    LastPublishedTime string
    LastUpdatedTime string
    LinkEntities List<string>
    A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.
    Name string
    The display name of the dashboard.
    Permissions List<Pulumi.AwsNative.QuickSight.Outputs.DashboardResourcePermission>

    A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.

    To specify no permissions, omit the permissions list.

    Tags List<Pulumi.AwsNative.Outputs.Tag>
    Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
    Version Pulumi.AwsNative.QuickSight.Outputs.DashboardVersion
    Arn string
    CreatedTime string
    LastPublishedTime string
    LastUpdatedTime string
    LinkEntities []string
    A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.
    Name string
    The display name of the dashboard.
    Permissions []DashboardResourcePermission

    A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.

    To specify no permissions, omit the permissions list.

    Tags Tag
    Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
    Version DashboardVersion
    arn String
    createdTime String
    lastPublishedTime String
    lastUpdatedTime String
    linkEntities List<String>
    A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.
    name String
    The display name of the dashboard.
    permissions List<DashboardResourcePermission>

    A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.

    To specify no permissions, omit the permissions list.

    tags List<Tag>
    Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
    version DashboardVersion
    arn string
    createdTime string
    lastPublishedTime string
    lastUpdatedTime string
    linkEntities string[]
    A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.
    name string
    The display name of the dashboard.
    permissions DashboardResourcePermission[]

    A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.

    To specify no permissions, omit the permissions list.

    tags Tag[]
    Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
    version DashboardVersion
    arn str
    created_time str
    last_published_time str
    last_updated_time str
    link_entities Sequence[str]
    A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.
    name str
    The display name of the dashboard.
    permissions Sequence[DashboardResourcePermission]

    A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.

    To specify no permissions, omit the permissions list.

    tags Sequence[root_Tag]
    Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
    version DashboardVersion
    arn String
    createdTime String
    lastPublishedTime String
    lastUpdatedTime String
    linkEntities List<String>
    A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.
    name String
    The display name of the dashboard.
    permissions List<Property Map>

    A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.

    To specify no permissions, omit the permissions list.

    tags List<Property Map>
    Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
    version Property Map

    Supporting Types

    DashboardBehavior

    DashboardColumnIdentifier

    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.

    DashboardCustomActionNavigationOperation

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

    DashboardCustomActionSetParametersOperation

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

    DashboardCustomActionUrlOperation

    UrlTarget Pulumi.AwsNative.QuickSight.DashboardUrlTargetConfiguration

    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 DashboardUrlTargetConfiguration

    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 DashboardUrlTargetConfiguration

    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 DashboardUrlTargetConfiguration

    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 DashboardUrlTargetConfiguration

    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 .

    DashboardCustomParameterValues

    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.

    DashboardCustomValuesConfiguration

    CustomValues Pulumi.AwsNative.QuickSight.Inputs.DashboardCustomParameterValues
    IncludeNullValue bool
    Includes the null value in custom action parameter values.
    CustomValues DashboardCustomParameterValues
    IncludeNullValue bool
    Includes the null value in custom action parameter values.
    customValues DashboardCustomParameterValues
    includeNullValue Boolean
    Includes the null value in custom action parameter values.
    customValues DashboardCustomParameterValues
    includeNullValue boolean
    Includes the null value in custom action parameter values.
    custom_values DashboardCustomParameterValues
    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.

    DashboardDestinationParameterValueConfiguration

    CustomValuesConfiguration Pulumi.AwsNative.QuickSight.Inputs.DashboardCustomValuesConfiguration
    The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
    SelectAllValueOptions Pulumi.AwsNative.QuickSight.DashboardSelectAllValueOptions
    The configuration that selects all options.
    SourceColumn Pulumi.AwsNative.QuickSight.Inputs.DashboardColumnIdentifier
    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 DashboardCustomValuesConfiguration
    The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
    SelectAllValueOptions DashboardSelectAllValueOptions
    The configuration that selects all options.
    SourceColumn DashboardColumnIdentifier
    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 DashboardCustomValuesConfiguration
    The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
    selectAllValueOptions DashboardSelectAllValueOptions
    The configuration that selects all options.
    sourceColumn DashboardColumnIdentifier
    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 DashboardCustomValuesConfiguration
    The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
    selectAllValueOptions DashboardSelectAllValueOptions
    The configuration that selects all options.
    sourceColumn DashboardColumnIdentifier
    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 DashboardCustomValuesConfiguration
    The configuration of custom values for destination parameter in DestinationParameterValueConfiguration .
    select_all_value_options DashboardSelectAllValueOptions
    The configuration that selects all options.
    source_column DashboardColumnIdentifier
    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.

    DashboardEntity

    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.

    DashboardError

    DashboardErrorType

    DashboardImageCustomAction

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

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

    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.DashboardWidgetStatus
    The status of the custom action.
    ActionOperations []DashboardImageCustomActionOperation

    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 DashboardImageCustomActionTrigger

    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 DashboardWidgetStatus
    The status of the custom action.
    actionOperations List<DashboardImageCustomActionOperation>

    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 DashboardImageCustomActionTrigger

    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 DashboardWidgetStatus
    The status of the custom action.
    actionOperations DashboardImageCustomActionOperation[]

    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 DashboardImageCustomActionTrigger

    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 DashboardWidgetStatus
    The status of the custom action.
    action_operations Sequence[DashboardImageCustomActionOperation]

    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 DashboardImageCustomActionTrigger

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

    DashboardImageCustomActionOperation

    DashboardImageCustomActionTrigger

    DashboardImageInteractionOptions

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

    DashboardImageMenuOption

    AvailabilityStatus Pulumi.AwsNative.QuickSight.DashboardBehavior
    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 DashboardBehavior
    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 DashboardBehavior
    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 DashboardBehavior
    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 DashboardBehavior
    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 "ENABLED" | "DISABLED"
    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.

    DashboardLocalNavigationConfiguration

    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.

    DashboardResourcePermission

    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

    DashboardResourceStatus

    DashboardSelectAllValueOptions

    DashboardSetParameterValueConfiguration

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

    DashboardSheet

    Images []DashboardSheetImage
    A list of images on a sheet.
    Name string
    SheetId string
    images List<DashboardSheetImage>
    A list of images on a sheet.
    name String
    sheetId String
    images DashboardSheetImage[]
    A list of images on a sheet.
    name string
    sheetId string
    images Sequence[DashboardSheetImage]
    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

    DashboardSheetImage

    SheetImageId string
    The ID of the sheet image.
    Source Pulumi.AwsNative.QuickSight.Inputs.DashboardSheetImageSource
    The source of the image.
    Actions List<Pulumi.AwsNative.QuickSight.Inputs.DashboardImageCustomAction>
    A list of custom actions that are configured for an image.
    ImageContentAltText string
    The alt text for the image.
    Interactions Pulumi.AwsNative.QuickSight.Inputs.DashboardImageInteractionOptions
    The general image interactions setup for an image.
    Scaling Pulumi.AwsNative.QuickSight.Inputs.DashboardSheetImageScalingConfiguration
    Determines how the image is scaled.
    Tooltip Pulumi.AwsNative.QuickSight.Inputs.DashboardSheetImageTooltipConfiguration
    The tooltip to be shown when hovering over the image.
    SheetImageId string
    The ID of the sheet image.
    Source DashboardSheetImageSource
    The source of the image.
    Actions []DashboardImageCustomAction
    A list of custom actions that are configured for an image.
    ImageContentAltText string
    The alt text for the image.
    Interactions DashboardImageInteractionOptions
    The general image interactions setup for an image.
    Scaling DashboardSheetImageScalingConfiguration
    Determines how the image is scaled.
    Tooltip DashboardSheetImageTooltipConfiguration
    The tooltip to be shown when hovering over the image.
    sheetImageId String
    The ID of the sheet image.
    source DashboardSheetImageSource
    The source of the image.
    actions List<DashboardImageCustomAction>
    A list of custom actions that are configured for an image.
    imageContentAltText String
    The alt text for the image.
    interactions DashboardImageInteractionOptions
    The general image interactions setup for an image.
    scaling DashboardSheetImageScalingConfiguration
    Determines how the image is scaled.
    tooltip DashboardSheetImageTooltipConfiguration
    The tooltip to be shown when hovering over the image.
    sheetImageId string
    The ID of the sheet image.
    source DashboardSheetImageSource
    The source of the image.
    actions DashboardImageCustomAction[]
    A list of custom actions that are configured for an image.
    imageContentAltText string
    The alt text for the image.
    interactions DashboardImageInteractionOptions
    The general image interactions setup for an image.
    scaling DashboardSheetImageScalingConfiguration
    Determines how the image is scaled.
    tooltip DashboardSheetImageTooltipConfiguration
    The tooltip to be shown when hovering over the image.
    sheet_image_id str
    The ID of the sheet image.
    source DashboardSheetImageSource
    The source of the image.
    actions Sequence[DashboardImageCustomAction]
    A list of custom actions that are configured for an image.
    image_content_alt_text str
    The alt text for the image.
    interactions DashboardImageInteractionOptions
    The general image interactions setup for an image.
    scaling DashboardSheetImageScalingConfiguration
    Determines how the image is scaled.
    tooltip DashboardSheetImageTooltipConfiguration
    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.

    DashboardSheetImageScalingConfiguration

    ScalingType Pulumi.AwsNative.QuickSight.DashboardSheetImageScalingType

    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 DashboardSheetImageScalingType

    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 DashboardSheetImageScalingType

    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 DashboardSheetImageScalingType

    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 DashboardSheetImageScalingType

    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.

    DashboardSheetImageScalingType

    DashboardSheetImageSource

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

    DashboardSheetImageStaticFileSource

    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.

    DashboardSheetImageTooltipConfiguration

    TooltipText DashboardSheetImageTooltipText
    The text that appears in the tooltip.
    Visibility DashboardVisibility
    The visibility of the tooltip.
    tooltipText DashboardSheetImageTooltipText
    The text that appears in the tooltip.
    visibility DashboardVisibility
    The visibility of the tooltip.
    tooltipText DashboardSheetImageTooltipText
    The text that appears in the tooltip.
    visibility DashboardVisibility
    The visibility of the tooltip.
    tooltip_text DashboardSheetImageTooltipText
    The text that appears in the tooltip.
    visibility DashboardVisibility
    The visibility of the tooltip.
    tooltipText Property Map
    The text that appears in the tooltip.
    visibility "HIDDEN" | "VISIBLE"
    The visibility of the tooltip.

    DashboardSheetImageTooltipText

    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.

    DashboardUrlTargetConfiguration

    DashboardVersion

    DashboardVisibility

    DashboardWidgetStatus

    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

    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