Skip to content

CreateDashboardRequest

Source code in docs_src/capo_cloudtrail/types/create_dashboard_request.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
class CreateDashboardRequest(TypedDict, closed=True):
    name: "capo_cloudtrail.types.dashboard_name.DashboardName"
    """<p> The name of the dashboard. The name must be unique to your account. </p> <p>To create the Highlights dashboard, the name must be <code>AWSCloudTrail-Highlights</code>.</p>"""
    refresh_schedule: NotRequired[
        "capo_cloudtrail.types.refresh_schedule.RefreshSchedule"
    ]
    """<p> The refresh schedule configuration for the dashboard. </p> <p>To create the Highlights dashboard, you must set a refresh schedule and set the <code>Status</code> to <code>ENABLED</code>. The <code>Unit</code> for the refresh schedule must be <code>HOURS</code> and the <code>Value</code> must be <code>6</code>.</p>"""
    tags_list: NotRequired["capo_cloudtrail.types.tags_list.TagsList"]
    termination_protection_enabled: NotRequired[
        "capo_cloudtrail.types.termination_protection_enabled.TerminationProtectionEnabled"
    ]
    """<p> Specifies whether termination protection is enabled for the dashboard. If termination protection is enabled, you cannot delete the dashboard until termination protection is disabled. </p>"""
    widgets: NotRequired["capo_cloudtrail.types.request_widget_list.RequestWidgetList"]
    """<p> An array of widgets for a custom dashboard. A custom dashboard can have a maximum of ten widgets. </p> <p>You do not need to specify widgets for the Highlights dashboard.</p>"""

name instance-attribute 

name: DashboardName

The name of the dashboard. The name must be unique to your account.

To create the Highlights dashboard, the name must be AWSCloudTrail-Highlights.

refresh_schedule instance-attribute 

refresh_schedule: NotRequired[RefreshSchedule]

The refresh schedule configuration for the dashboard.

To create the Highlights dashboard, you must set a refresh schedule and set the Status to ENABLED. The Unit for the refresh schedule must be HOURS and the Value must be 6.

tags_list instance-attribute 

tags_list: NotRequired[TagsList]

termination_protection_enabled instance-attribute 

termination_protection_enabled: NotRequired[TerminationProtectionEnabled]

Specifies whether termination protection is enabled for the dashboard. If termination protection is enabled, you cannot delete the dashboard until termination protection is disabled.

widgets instance-attribute 

widgets: NotRequired[RequestWidgetList]

An array of widgets for a custom dashboard. A custom dashboard can have a maximum of ten widgets.

You do not need to specify widgets for the Highlights dashboard.