Class: Aws::CloudTrail::Types::CreateDashboardRequest

Inherits:

Struct

• Object
• Struct
• Aws::CloudTrail::Types::CreateDashboardRequest

Includes:

Structure

Defined in:

lib/aws-sdk-cloudtrail/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #name ⇒ String

  The name of the dashboard.

• #refresh_schedule ⇒ Types::RefreshSchedule

  The refresh schedule configuration for the dashboard.

• #tags_list ⇒ Array<Types::Tag>

  A list of tags.

• #termination_protection_enabled ⇒ Boolean

  Specifies whether termination protection is enabled for the dashboard.

• #widgets ⇒ Array<Types::RequestWidget>

  An array of widgets for a custom dashboard.

Instance Attribute Details

#name ⇒ String

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

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

Returns:

• (String)

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

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

#refresh_schedule ⇒ Types::RefreshSchedule

The refresh schedule configuration for the dashboard.

To create the Highlights dashboard, you must set a refresh schedule and set the ‘Status` to `ENABLED`. The `Unit` for the refresh schedule must be `HOURS` and the `Value` must be `6`.

Returns:

• (Types::RefreshSchedule)

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

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

#tags_list ⇒ Array<Types::Tag>

A list of tags.

Returns:

• (Array<Types::Tag>)

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

class CreateDashboardRequest < Struct.new(
  :name,
  :refresh_schedule,
  :tags_list,
  :termination_protection_enabled,
  :widgets)
  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 481

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

#widgets ⇒ Array<Types::RequestWidget>

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.

Returns:

• (Array<Types::RequestWidget>)

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

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