Package software.amazon.awscdk.services.cloudtrail

Interface CfnDashboard.RefreshScheduleProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDashboard.RefreshScheduleProperty.Jsii$Proxy

Enclosing class:

CfnDashboard

@Stability(Stable)
public static interface CfnDashboard.RefreshScheduleProperty
extends software.amazon.jsii.JsiiSerializable

The schedule for a dashboard refresh.

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.*;
 RefreshScheduleProperty refreshScheduleProperty = RefreshScheduleProperty.builder()
         .frequency(FrequencyProperty.builder()
                 .unit("unit")
                 .value(123)
                 .build())
         .status("status")
         .timeOfDay("timeOfDay")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDashboard.RefreshScheduleProperty.Builder	builder()
default Object	getFrequency()	The frequency at which you want the dashboard refreshed.
default String	getStatus()	Specifies whether the refresh schedule is enabled.
default String	getTimeOfDay()	The time of day in UTC to run the schedule;

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFrequency

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

The frequency at which you want the dashboard refreshed.

See Also:

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

getStatus

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

Specifies whether the refresh schedule is enabled.

Set the value to ENABLED to enable the refresh schedule, or to DISABLED to turn off the refresh schedule.

See Also:

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

getTimeOfDay

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

The time of day in UTC to run the schedule;

for hourly only refer to minutes; default is 00:00.

See Also:

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

builder

@Stability(Stable)
static CfnDashboard.RefreshScheduleProperty.Builder builder()

Returns:

a CfnDashboard.RefreshScheduleProperty.Builder of CfnDashboard.RefreshScheduleProperty