Class CfnDashboardMixinProps

Properties for CfnDashboardPropsMixin.

Inheritance

object

CfnDashboardMixinProps

Implements

ICfnDashboardMixinProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.Mixins.Preview.AWS.CloudTrail.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public class CfnDashboardMixinProps : ICfnDashboardMixinProps

Syntax (vb)

Public Class CfnDashboardMixinProps Implements ICfnDashboardMixinProps

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.CloudTrail.Mixins;

             var cfnDashboardMixinProps = new CfnDashboardMixinProps {
                 Name = "name",
                 RefreshSchedule = new RefreshScheduleProperty {
                     Frequency = new FrequencyProperty {
                         Unit = "unit",
                         Value = 123
                     },
                     Status = "status",
                     TimeOfDay = "timeOfDay"
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 TerminationProtectionEnabled = false,
                 Widgets = new [] { new WidgetProperty {
                     QueryParameters = new [] { "queryParameters" },
                     QueryStatement = "queryStatement",
                     ViewProperties = new Dictionary<string, string> {
                         { "viewPropertiesKey", "viewProperties" }
                     }
                 } }
             };

Synopsis

Constructors

CfnDashboardMixinProps()

Properties for CfnDashboardPropsMixin.

Properties

Name	The name of the dashboard. The name must be unique to your account.
RefreshSchedule	The schedule for a dashboard refresh.
Tags	A list of tags.
TerminationProtectionEnabled	Specifies whether termination protection is enabled for the dashboard.
Widgets	An array of widgets for a custom dashboard. A custom dashboard can have a maximum of ten widgets.

Constructors

CfnDashboardMixinProps()

Properties for CfnDashboardPropsMixin.

public CfnDashboardMixinProps()

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.CloudTrail.Mixins;

             var cfnDashboardMixinProps = new CfnDashboardMixinProps {
                 Name = "name",
                 RefreshSchedule = new RefreshScheduleProperty {
                     Frequency = new FrequencyProperty {
                         Unit = "unit",
                         Value = 123
                     },
                     Status = "status",
                     TimeOfDay = "timeOfDay"
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 TerminationProtectionEnabled = false,
                 Widgets = new [] { new WidgetProperty {
                     QueryParameters = new [] { "queryParameters" },
                     QueryStatement = "queryStatement",
                     ViewProperties = new Dictionary<string, string> {
                         { "viewPropertiesKey", "viewProperties" }
                     }
                 } }
             };

Properties

Name

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

public string? Name { get; set; }

Property Value

string

Remarks

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

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

RefreshSchedule

The schedule for a dashboard refresh.

public object? RefreshSchedule { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnDashboardPropsMixin.IRefreshScheduleProperty

TerminationProtectionEnabled

Specifies whether termination protection is enabled for the dashboard.

public object? TerminationProtectionEnabled { get; set; }

Property Value

object

Remarks

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

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

Type union: either bool or IResolvable

Widgets

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

public object? Widgets { get; set; }

Property Value

object

Remarks

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#cfn-cloudtrail-dashboard-widgets

Type union: either IResolvable or (either IResolvable or CfnDashboardPropsMixin.IWidgetProperty)[]

Implements

ICfnDashboardMixinProps