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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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) 


524
525
526
527
528
529
530
531
532
 
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 524

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:



524
525
526
527
528
529
530
531
532
 
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 524

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:



524
525
526
527
528
529
530
531
532
 
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 524

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) 


524
525
526
527
528
529
530
531
532
 
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 524

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:



524
525
526
527
528
529
530
531
532
 
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 524

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