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

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

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.

    Create Dashboard Resource

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

    Constructor syntax

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

@overload
def Dashboard(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              name: Optional[str] = None,
              refresh_schedule: Optional[DashboardRefreshScheduleArgs] = None,
              tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
              termination_protection_enabled: Optional[bool] = None,
              widgets: Optional[Sequence[DashboardWidgetArgs]] = None)
    func NewDashboard(ctx *Context, name string, args *DashboardArgs, opts ...ResourceOption) (*Dashboard, error)
    public Dashboard(string name, DashboardArgs? args = null, CustomResourceOptions? opts = null)
    public Dashboard(String name, DashboardArgs args)
public Dashboard(String name, DashboardArgs args, CustomResourceOptions options)

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

    Parameters

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

    Dashboard Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Dashboard resource accepts the following input properties:

    Name string
    The name of the dashboard.
    RefreshSchedule Pulumi.AwsNative.CloudTrail.Inputs.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.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    A list of tags.
    TerminationProtectionEnabled bool
    Indicates whether the dashboard is protected from termination.
    Widgets List<Pulumi.AwsNative.CloudTrail.Inputs.DashboardWidget>
    List of widgets on the dashboard
    Name string
    The name of the dashboard.
    RefreshSchedule DashboardRefreshScheduleArgs
    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.
    Tags TagArgs
    A list of tags.
    TerminationProtectionEnabled bool
    Indicates whether the dashboard is protected from termination.
    Widgets []DashboardWidgetArgs
    List of widgets on 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.
    tags List<Tag>
    A list of tags.
    terminationProtectionEnabled Boolean
    Indicates whether the dashboard is protected from termination.
    widgets List<DashboardWidget>
    List of widgets on 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.
    tags Tag[]
    A list of tags.
    terminationProtectionEnabled boolean
    Indicates whether the dashboard is protected from termination.
    widgets DashboardWidget[]
    List of widgets on the dashboard
    name str
    The name of the dashboard.
    refresh_schedule DashboardRefreshScheduleArgs
    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.
    tags Sequence[TagArgs]
    A list of tags.
    termination_protection_enabled bool
    Indicates whether the dashboard is protected from termination.
    widgets Sequence[DashboardWidgetArgs]
    List of widgets on 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.
    tags List<Property Map>
    A list of tags.
    terminationProtectionEnabled Boolean
    Indicates whether the dashboard is protected from termination.
    widgets List<Property Map>
    List of widgets on the dashboard

    Outputs

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

    CreatedTimestamp string
    The timestamp of the dashboard creation.
    DashboardArn string
    The ARN of the dashboard.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status Pulumi.AwsNative.CloudTrail.DashboardStatus
    The status of the dashboard. Values are CREATING, CREATED, UPDATING, UPDATED and DELETING.
    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.
    CreatedTimestamp string
    The timestamp of the dashboard creation.
    DashboardArn string
    The ARN of the dashboard.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status DashboardStatus
    The status of the dashboard. Values are CREATING, CREATED, UPDATING, UPDATED and DELETING.
    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.
    createdTimestamp String
    The timestamp of the dashboard creation.
    dashboardArn String
    The ARN of the dashboard.
    id String
    The provider-assigned unique ID for this managed resource.
    status DashboardStatus
    The status of the dashboard. Values are CREATING, CREATED, UPDATING, UPDATED and DELETING.
    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.
    createdTimestamp string
    The timestamp of the dashboard creation.
    dashboardArn string
    The ARN of the dashboard.
    id string
    The provider-assigned unique ID for this managed resource.
    status DashboardStatus
    The status of the dashboard. Values are CREATING, CREATED, UPDATING, UPDATED and DELETING.
    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.
    created_timestamp str
    The timestamp of the dashboard creation.
    dashboard_arn str
    The ARN of the dashboard.
    id str
    The provider-assigned unique ID for this managed resource.
    status DashboardStatus
    The status of the dashboard. Values are CREATING, CREATED, UPDATING, UPDATED and DELETING.
    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.
    createdTimestamp String
    The timestamp of the dashboard creation.
    dashboardArn String
    The ARN of the dashboard.
    id String
    The provider-assigned unique ID for this managed resource.
    status "CREATING" | "CREATED" | "UPDATING" | "UPDATED" | "DELETING"
    The status of the dashboard. Values are CREATING, CREATED, UPDATING, UPDATED and DELETING.
    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.

    Supporting Types

    DashboardRefreshSchedule, DashboardRefreshScheduleArgs

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

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

    Hours
    HOURS
    Days
    DAYS
    DashboardRefreshScheduleFrequencyPropertiesUnitHours
    HOURS
    DashboardRefreshScheduleFrequencyPropertiesUnitDays
    DAYS
    Hours
    HOURS
    Days
    DAYS
    Hours
    HOURS
    Days
    DAYS
    HOURS
    HOURS
    DAYS
    DAYS
    "HOURS"
    HOURS
    "DAYS"
    DAYS

    DashboardRefreshScheduleStatus, DashboardRefreshScheduleStatusArgs

    Enabled
    ENABLED
    Disabled
    DISABLED
    DashboardRefreshScheduleStatusEnabled
    ENABLED
    DashboardRefreshScheduleStatusDisabled
    DISABLED
    Enabled
    ENABLED
    Disabled
    DISABLED
    Enabled
    ENABLED
    Disabled
    DISABLED
    ENABLED
    ENABLED
    DISABLED
    DISABLED
    "ENABLED"
    ENABLED
    "DISABLED"
    DISABLED

    DashboardStatus, DashboardStatusArgs

    Creating
    CREATING
    Created
    CREATED
    Updating
    UPDATING
    Updated
    UPDATED
    Deleting
    DELETING
    DashboardStatusCreating
    CREATING
    DashboardStatusCreated
    CREATED
    DashboardStatusUpdating
    UPDATING
    DashboardStatusUpdated
    UPDATED
    DashboardStatusDeleting
    DELETING
    Creating
    CREATING
    Created
    CREATED
    Updating
    UPDATING
    Updated
    UPDATED
    Deleting
    DELETING
    Creating
    CREATING
    Created
    CREATED
    Updating
    UPDATING
    Updated
    UPDATED
    Deleting
    DELETING
    CREATING
    CREATING
    CREATED
    CREATED
    UPDATING
    UPDATING
    UPDATED
    UPDATED
    DELETING
    DELETING
    "CREATING"
    CREATING
    "CREATED"
    CREATED
    "UPDATING"
    UPDATING
    "UPDATED"
    UPDATED
    "DELETING"
    DELETING

    DashboardType, DashboardTypeArgs

    Managed
    MANAGED
    Custom
    CUSTOM
    DashboardTypeManaged
    MANAGED
    DashboardTypeCustom
    CUSTOM
    Managed
    MANAGED
    Custom
    CUSTOM
    Managed
    MANAGED
    Custom
    CUSTOM
    MANAGED
    MANAGED
    CUSTOM
    CUSTOM
    "MANAGED"
    MANAGED
    "CUSTOM"
    CUSTOM

    DashboardWidget, DashboardWidgetArgs

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

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

    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