CfnDashboardProps

class aws_cdk.aws_cloudtrail.CfnDashboardProps(*, name=None, refresh_schedule=None, tags=None, termination_protection_enabled=None, widgets=None)

Bases: object

Properties for defining a CfnDashboard.

Parameters:

name (Optional[str]) – 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 (Union[IResolvable, RefreshScheduleProperty, Dict[str, Any], None]) – The schedule for a dashboard refresh.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – A list of tags.
termination_protection_enabled (Union[bool, IResolvable, None]) – 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 (Union[IResolvable, Sequence[Union[IResolvable, WidgetProperty, Dict[str, Any]]], None]) – 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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-dashboard.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_cloudtrail as cloudtrail

cfn_dashboard_props = cloudtrail.CfnDashboardProps(
    name="name",
    refresh_schedule=cloudtrail.CfnDashboard.RefreshScheduleProperty(
        frequency=cloudtrail.CfnDashboard.FrequencyProperty(
            unit="unit",
            value=123
        ),
        status="status",
        time_of_day="timeOfDay"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    termination_protection_enabled=False,
    widgets=[cloudtrail.CfnDashboard.WidgetProperty(
        query_statement="queryStatement",

        # the properties below are optional
        query_parameters=["queryParameters"],
        view_properties={
            "view_properties_key": "viewProperties"
        }
    )]
)