Package software.amazon.awscdk.services.cloudtrail

Interface CfnDashboardProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDashboardProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2025-01-15T21:09:15.910Z")
@Stability(Stable)
public interface CfnDashboardProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnDashboard.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cloudtrail.*;
 CfnDashboardProps cfnDashboardProps = CfnDashboardProps.builder()
         .name("name")
         .refreshSchedule(RefreshScheduleProperty.builder()
                 .frequency(FrequencyProperty.builder()
                         .unit("unit")
                         .value(123)
                         .build())
                 .status("status")
                 .timeOfDay("timeOfDay")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .terminationProtectionEnabled(false)
         .widgets(List.of(WidgetProperty.builder()
                 .queryStatement("queryStatement")
                 // the properties below are optional
                 .queryParameters(List.of("queryParameters"))
                 .viewProperties(Map.of(
                         "viewPropertiesKey", "viewProperties"))
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDashboardProps.Builder	A builder for CfnDashboardProps
static final class	CfnDashboardProps.Jsii$Proxy	An implementation for CfnDashboardProps

Method Summary

Modifier and Type	Method	Description
static CfnDashboardProps.Builder	builder()
default String	getName()	The name of the dashboard.
default Object	getRefreshSchedule()	The schedule for a dashboard refresh.
default List<CfnTag>	getTags()	A list of tags.
default Object	getTerminationProtectionEnabled()	Specifies whether termination protection is enabled for the dashboard.
default Object	getWidgets()	An array of widgets for a custom dashboard.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@Nullable
default String getName()

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

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

See Also:

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

getRefreshSchedule

@Stability(Stable)
@Nullable
default Object getRefreshSchedule()

The schedule for a dashboard refresh.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

A list of tags.

See Also:

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

getTerminationProtectionEnabled

@Stability(Stable)
@Nullable
default Object getTerminationProtectionEnabled()

Specifies whether termination protection is enabled for the dashboard.

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

See Also:

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

getWidgets

@Stability(Stable)
@Nullable
default Object getWidgets()

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 Also:

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

builder

@Stability(Stable)
static CfnDashboardProps.Builder builder()

Returns:

a CfnDashboardProps.Builder of CfnDashboardProps