AWS::CloudTrail::Dashboard

CloudTrail Dashboard

The Amazon CloudTrail dashboard resource allows customers to manage managed dashboards and create custom dashboards. You can manually refresh custom and managed dashboards. For custom dashboards, you can also set up an automatic refresh schedule and modify dashboard widgets.

Properties

5 configurable properties. Click a row to see details.

Filter:

Property	Type	Flags
`Name`	`string`
`RefreshSchedule`	`RefreshSchedule`
`Tags`	`Array<Tag>`
`TerminationProtectionEnabled`	`boolean`
`Widgets`	`Array<Widget>`

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`CreatedTimestamp`	`string`	The timestamp of the dashboard creation.
`DashboardArn`	`string`	The ARN of the dashboard.
`Status`	`string`	The status of the dashboard. Values are CREATING, CREATED, UPDATING, UPDATED and DELETING.
`Type`	`string`	The type of the dashboard. Values are CUSTOM and MANAGED.
`UpdatedTimestamp`	`string`	The timestamp showing when the dashboard was updated, if applicable. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::CloudTrail::Dashboard

Resources:
  MyResource:
    Type: AWS::CloudTrail::Dashboard
    Properties:
      Tags:
        - Key: Environment
          Value: Production
      Name: !Ref "AWS::StackName"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

CloudTrail:CreateDashboardCloudTrail:AddTagsCloudTrail:StartQueryCloudTrail:StartDashboardRefresh

read

CloudTrail:GetDashboardCloudTrail:ListDashboardsCloudTrail:ListTags

update

CloudTrail:UpdateDashboardCloudTrail:AddTagsCloudTrail:RemoveTagsCloudTrail:StartQueryCloudTrail:StartDashboardRefresh

delete

CloudTrail:DeleteDashboardCloudTrail:UpdateDashboard

list

CloudTrail:ListDashboardsCloudTrail:GetDashboardCloudTrail:ListTags

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceCloudTrail

Properties10

Required0

TaggingSupported

Primary IDDashboardArn

Supported Operations

CreateReadUpdateDeleteList

Related Resources

External Links

AWS Documentation