Class: Aws::CloudTrail::Types::UpdateDashboardRequest

Inherits:

Struct

• Object
• Struct
• Aws::CloudTrail::Types::UpdateDashboardRequest

Includes:

Structure

Defined in:

lib/aws-sdk-cloudtrail/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #dashboard_id ⇒ String

  The name or ARN of the dashboard.

• #refresh_schedule ⇒ Types::RefreshSchedule

  The refresh schedule configuration for the dashboard.

• #termination_protection_enabled ⇒ Boolean

  Specifies whether termination protection is enabled for the dashboard.

• #widgets ⇒ Array<Types::RequestWidget>

  An array of widgets for the dashboard.

Instance Attribute Details

#dashboard_id ⇒ String

The name or ARN of the dashboard.

Returns:

• (String)

# File 'lib/aws-sdk-cloudtrail/types.rb', line 5517

class UpdateDashboardRequest < Struct.new(
  :dashboard_id,
  :widgets,
  :refresh_schedule,
  :termination_protection_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#refresh_schedule ⇒ Types::RefreshSchedule

The refresh schedule configuration for the dashboard.

Returns:

• (Types::RefreshSchedule)

# File 'lib/aws-sdk-cloudtrail/types.rb', line 5517

class UpdateDashboardRequest < Struct.new(
  :dashboard_id,
  :widgets,
  :refresh_schedule,
  :termination_protection_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#termination_protection_enabled ⇒ Boolean

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

Returns:

• (Boolean)

# File 'lib/aws-sdk-cloudtrail/types.rb', line 5517

class UpdateDashboardRequest < Struct.new(
  :dashboard_id,
  :widgets,
  :refresh_schedule,
  :termination_protection_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#widgets ⇒ Array<Types::RequestWidget>

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

To add new widgets, pass in an array that includes the existing widgets along with any new widgets. Run the ‘GetDashboard` operation to get the list of widgets for the dashboard.

To remove widgets, pass in an array that includes the existing widgets minus the widgets you want removed.

Returns:

• (Array<Types::RequestWidget>)

# File 'lib/aws-sdk-cloudtrail/types.rb', line 5517

class UpdateDashboardRequest < Struct.new(
  :dashboard_id,
  :widgets,
  :refresh_schedule,
  :termination_protection_enabled)
  SENSITIVE = []
  include Aws::Structure
end