Package software.amazon.awscdk.services.cloudtrail

Class CfnDashboard.Builder

java.lang.Object

software.amazon.awscdk.services.cloudtrail.CfnDashboard.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDashboard>

Enclosing class:

CfnDashboard

@Stability(Stable)
public static final class CfnDashboard.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDashboard>

A fluent builder for CfnDashboard.

Method Summary

Modifier and Type	Method	Description
CfnDashboard	build()
static CfnDashboard.Builder	create(software.constructs.Construct scope, String id)
CfnDashboard.Builder	name(String name)	The name of the dashboard.
CfnDashboard.Builder	refreshSchedule(IResolvable refreshSchedule)	The schedule for a dashboard refresh.
CfnDashboard.Builder	refreshSchedule(CfnDashboard.RefreshScheduleProperty refreshSchedule)	The schedule for a dashboard refresh.
CfnDashboard.Builder	tags(List<? extends CfnTag> tags)	A list of tags.
CfnDashboard.Builder	terminationProtectionEnabled(Boolean terminationProtectionEnabled)	Specifies whether termination protection is enabled for the dashboard.
CfnDashboard.Builder	terminationProtectionEnabled(IResolvable terminationProtectionEnabled)	Specifies whether termination protection is enabled for the dashboard.
CfnDashboard.Builder	widgets(List<? extends Object> widgets)	An array of widgets for a custom dashboard.
CfnDashboard.Builder	widgets(IResolvable widgets)	An array of widgets for a custom dashboard.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnDashboard.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnDashboard.Builder.

name

@Stability(Stable)
public CfnDashboard.Builder name(String name)

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

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

Parameters:

name - The name of the dashboard. The name must be unique to your account. This parameter is required.

Returns:

this

See Also:

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

refreshSchedule

@Stability(Stable)
public CfnDashboard.Builder refreshSchedule(IResolvable refreshSchedule)

The schedule for a dashboard refresh.

Parameters:

refreshSchedule - The schedule for a dashboard refresh. This parameter is required.

Returns:

this

See Also:

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

refreshSchedule

@Stability(Stable)
public CfnDashboard.Builder refreshSchedule(CfnDashboard.RefreshScheduleProperty refreshSchedule)

The schedule for a dashboard refresh.

Parameters:

refreshSchedule - The schedule for a dashboard refresh. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnDashboard.Builder tags(List<? extends CfnTag> tags)

A list of tags.

Parameters:

tags - A list of tags. This parameter is required.

Returns:

this

See Also:

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

terminationProtectionEnabled

@Stability(Stable)
public CfnDashboard.Builder terminationProtectionEnabled(Boolean 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.

Parameters:

terminationProtectionEnabled - Specifies whether termination protection is enabled for the dashboard. This parameter is required.

Returns:

this

See Also:

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

terminationProtectionEnabled

@Stability(Stable)
public CfnDashboard.Builder terminationProtectionEnabled(IResolvable 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.

Parameters:

terminationProtectionEnabled - Specifies whether termination protection is enabled for the dashboard. This parameter is required.

Returns:

this

See Also:

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

widgets

@Stability(Stable)
public CfnDashboard.Builder widgets(IResolvable widgets)

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.

Parameters:

widgets - An array of widgets for a custom dashboard. A custom dashboard can have a maximum of ten widgets. This parameter is required.

Returns:

this

See Also:

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

widgets

@Stability(Stable)
public CfnDashboard.Builder widgets(List<? extends Object> widgets)

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.

Parameters:

widgets - An array of widgets for a custom dashboard. A custom dashboard can have a maximum of ten widgets. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnDashboard build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnDashboard>

Returns:

a newly built instance of CfnDashboard.