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

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

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.cloudtrail.getDashboard

Explore with Pulumi AI

aws-native logo

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

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

    The Amazon CloudTrail dashboard resource allows customers to manage managed dashboards and create custom dashboards. You can manually refresh custom and managed dashboards. For custom dashboards, you can also set up an automatic refresh schedule and modify dashboard widgets.

    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(dashboard_arn: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetDashboardResult
def get_dashboard_output(dashboard_arn: 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)
public static Output<GetDashboardResult> getDashboard(GetDashboardArgs args, InvokeOptions options)

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

    The following arguments are supported:

    DashboardArn string
    The ARN of the dashboard.
    DashboardArn string
    The ARN of the dashboard.
    dashboardArn String
    The ARN of the dashboard.
    dashboardArn string
    The ARN of the dashboard.
    dashboard_arn str
    The ARN of the dashboard.
    dashboardArn String
    The ARN of the dashboard.

    getDashboard Result

    The following output properties are available:

    CreatedTimestamp string
    The timestamp of the dashboard creation.
    DashboardArn string
    The ARN of the dashboard.
    Name string
    The name of the dashboard.
    RefreshSchedule Pulumi.AwsNative.CloudTrail.Outputs.DashboardRefreshSchedule
    Configures the automatic refresh schedule for the dashboard. Includes the frequency unit (DAYS or HOURS) and value, as well as the status (ENABLED or DISABLED) of the refresh schedule.
    Status Pulumi.AwsNative.CloudTrail.DashboardStatus
    The status of the dashboard. Values are CREATING, CREATED, UPDATING, UPDATED and DELETING.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    A list of tags.
    TerminationProtectionEnabled bool
    Indicates whether the dashboard is protected from termination.
    Type Pulumi.AwsNative.CloudTrail.DashboardType
    The type of the dashboard. Values are CUSTOM and MANAGED.
    UpdatedTimestamp string
    The timestamp showing when the dashboard was updated, if applicable. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp.
    Widgets List<Pulumi.AwsNative.CloudTrail.Outputs.DashboardWidget>
    List of widgets on the dashboard
    CreatedTimestamp string
    The timestamp of the dashboard creation.
    DashboardArn string
    The ARN of the dashboard.
    Name string
    The name of the dashboard.
    RefreshSchedule DashboardRefreshSchedule
    Configures the automatic refresh schedule for the dashboard. Includes the frequency unit (DAYS or HOURS) and value, as well as the status (ENABLED or DISABLED) of the refresh schedule.
    Status DashboardStatus
    The status of the dashboard. Values are CREATING, CREATED, UPDATING, UPDATED and DELETING.
    Tags Tag
    A list of tags.
    TerminationProtectionEnabled bool
    Indicates whether the dashboard is protected from termination.
    Type DashboardType
    The type of the dashboard. Values are CUSTOM and MANAGED.
    UpdatedTimestamp string
    The timestamp showing when the dashboard was updated, if applicable. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp.
    Widgets []DashboardWidget
    List of widgets on the dashboard
    createdTimestamp String
    The timestamp of the dashboard creation.
    dashboardArn String
    The ARN of the dashboard.
    name String
    The name of the dashboard.
    refreshSchedule DashboardRefreshSchedule
    Configures the automatic refresh schedule for the dashboard. Includes the frequency unit (DAYS or HOURS) and value, as well as the status (ENABLED or DISABLED) of the refresh schedule.
    status DashboardStatus
    The status of the dashboard. Values are CREATING, CREATED, UPDATING, UPDATED and DELETING.
    tags List<Tag>
    A list of tags.
    terminationProtectionEnabled Boolean
    Indicates whether the dashboard is protected from termination.
    type DashboardType
    The type of the dashboard. Values are CUSTOM and MANAGED.
    updatedTimestamp String
    The timestamp showing when the dashboard was updated, if applicable. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp.
    widgets List<DashboardWidget>
    List of widgets on the dashboard
    createdTimestamp string
    The timestamp of the dashboard creation.
    dashboardArn string
    The ARN of the dashboard.
    name string
    The name of the dashboard.
    refreshSchedule DashboardRefreshSchedule
    Configures the automatic refresh schedule for the dashboard. Includes the frequency unit (DAYS or HOURS) and value, as well as the status (ENABLED or DISABLED) of the refresh schedule.
    status DashboardStatus
    The status of the dashboard. Values are CREATING, CREATED, UPDATING, UPDATED and DELETING.
    tags Tag[]
    A list of tags.
    terminationProtectionEnabled boolean
    Indicates whether the dashboard is protected from termination.
    type DashboardType
    The type of the dashboard. Values are CUSTOM and MANAGED.
    updatedTimestamp string
    The timestamp showing when the dashboard was updated, if applicable. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp.
    widgets DashboardWidget[]
    List of widgets on the dashboard
    created_timestamp str
    The timestamp of the dashboard creation.
    dashboard_arn str
    The ARN of the dashboard.
    name str
    The name of the dashboard.
    refresh_schedule DashboardRefreshSchedule
    Configures the automatic refresh schedule for the dashboard. Includes the frequency unit (DAYS or HOURS) and value, as well as the status (ENABLED or DISABLED) of the refresh schedule.
    status DashboardStatus
    The status of the dashboard. Values are CREATING, CREATED, UPDATING, UPDATED and DELETING.
    tags Sequence[root_Tag]
    A list of tags.
    termination_protection_enabled bool
    Indicates whether the dashboard is protected from termination.
    type DashboardType
    The type of the dashboard. Values are CUSTOM and MANAGED.
    updated_timestamp str
    The timestamp showing when the dashboard was updated, if applicable. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp.
    widgets Sequence[DashboardWidget]
    List of widgets on the dashboard
    createdTimestamp String
    The timestamp of the dashboard creation.
    dashboardArn String
    The ARN of the dashboard.
    name String
    The name of the dashboard.
    refreshSchedule Property Map
    Configures the automatic refresh schedule for the dashboard. Includes the frequency unit (DAYS or HOURS) and value, as well as the status (ENABLED or DISABLED) of the refresh schedule.
    status "CREATING" | "CREATED" | "UPDATING" | "UPDATED" | "DELETING"
    The status of the dashboard. Values are CREATING, CREATED, UPDATING, UPDATED and DELETING.
    tags List<Property Map>
    A list of tags.
    terminationProtectionEnabled Boolean
    Indicates whether the dashboard is protected from termination.
    type "MANAGED" | "CUSTOM"
    The type of the dashboard. Values are CUSTOM and MANAGED.
    updatedTimestamp String
    The timestamp showing when the dashboard was updated, if applicable. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp.
    widgets List<Property Map>
    List of widgets on the dashboard

    Supporting Types

    DashboardRefreshSchedule

    Frequency Pulumi.AwsNative.CloudTrail.Inputs.DashboardRefreshScheduleFrequencyProperties
    The frequency at which you want the dashboard refreshed.
    Status Pulumi.AwsNative.CloudTrail.DashboardRefreshScheduleStatus
    The status of the schedule. Supported values are ENABLED and DISABLED.
    TimeOfDay string
    StartTime of the automatic schedule refresh.
    Frequency DashboardRefreshScheduleFrequencyProperties
    The frequency at which you want the dashboard refreshed.
    Status DashboardRefreshScheduleStatus
    The status of the schedule. Supported values are ENABLED and DISABLED.
    TimeOfDay string
    StartTime of the automatic schedule refresh.
    frequency DashboardRefreshScheduleFrequencyProperties
    The frequency at which you want the dashboard refreshed.
    status DashboardRefreshScheduleStatus
    The status of the schedule. Supported values are ENABLED and DISABLED.
    timeOfDay String
    StartTime of the automatic schedule refresh.
    frequency DashboardRefreshScheduleFrequencyProperties
    The frequency at which you want the dashboard refreshed.
    status DashboardRefreshScheduleStatus
    The status of the schedule. Supported values are ENABLED and DISABLED.
    timeOfDay string
    StartTime of the automatic schedule refresh.
    frequency DashboardRefreshScheduleFrequencyProperties
    The frequency at which you want the dashboard refreshed.
    status DashboardRefreshScheduleStatus
    The status of the schedule. Supported values are ENABLED and DISABLED.
    time_of_day str
    StartTime of the automatic schedule refresh.
    frequency Property Map
    The frequency at which you want the dashboard refreshed.
    status "ENABLED" | "DISABLED"
    The status of the schedule. Supported values are ENABLED and DISABLED.
    timeOfDay String
    StartTime of the automatic schedule refresh.

    DashboardRefreshScheduleFrequencyProperties

    Unit Pulumi.AwsNative.CloudTrail.DashboardRefreshScheduleFrequencyPropertiesUnit
    The frequency unit. Supported values are HOURS and DAYS.
    Value int
    The frequency value.
    Unit DashboardRefreshScheduleFrequencyPropertiesUnit
    The frequency unit. Supported values are HOURS and DAYS.
    Value int
    The frequency value.
    unit DashboardRefreshScheduleFrequencyPropertiesUnit
    The frequency unit. Supported values are HOURS and DAYS.
    value Integer
    The frequency value.
    unit DashboardRefreshScheduleFrequencyPropertiesUnit
    The frequency unit. Supported values are HOURS and DAYS.
    value number
    The frequency value.
    unit DashboardRefreshScheduleFrequencyPropertiesUnit
    The frequency unit. Supported values are HOURS and DAYS.
    value int
    The frequency value.
    unit "HOURS" | "DAYS"
    The frequency unit. Supported values are HOURS and DAYS.
    value Number
    The frequency value.

    DashboardRefreshScheduleFrequencyPropertiesUnit

    DashboardRefreshScheduleStatus

    DashboardStatus

    DashboardType

    DashboardWidget

    QueryStatement string
    The SQL query statement on one or more event data stores.
    QueryParameters List<string>
    The placeholder keys in the QueryStatement. For example: $StartTime$, $EndTime$, $Period$.
    ViewProperties Dictionary<string, string>
    The view properties of the widget.
    QueryStatement string
    The SQL query statement on one or more event data stores.
    QueryParameters []string
    The placeholder keys in the QueryStatement. For example: $StartTime$, $EndTime$, $Period$.
    ViewProperties map[string]string
    The view properties of the widget.
    queryStatement String
    The SQL query statement on one or more event data stores.
    queryParameters List<String>
    The placeholder keys in the QueryStatement. For example: $StartTime$, $EndTime$, $Period$.
    viewProperties Map<String,String>
    The view properties of the widget.
    queryStatement string
    The SQL query statement on one or more event data stores.
    queryParameters string[]
    The placeholder keys in the QueryStatement. For example: $StartTime$, $EndTime$, $Period$.
    viewProperties {[key: string]: string}
    The view properties of the widget.
    query_statement str
    The SQL query statement on one or more event data stores.
    query_parameters Sequence[str]
    The placeholder keys in the QueryStatement. For example: $StartTime$, $EndTime$, $Period$.
    view_properties Mapping[str, str]
    The view properties of the widget.
    queryStatement String
    The SQL query statement on one or more event data stores.
    queryParameters List<String>
    The placeholder keys in the QueryStatement. For example: $StartTime$, $EndTime$, $Period$.
    viewProperties Map<String>
    The view properties of the widget.

    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.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
    pulumi/pulumi-aws-native