dashboards

Creates, updates, deletes or gets a dashboard resource or lists dashboards in a region

Overview

Name	dashboards
Type	Resource
Description	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.
Id	awscc.cloudtrail.dashboards

Fields

get (all properties)

Name	Datatype	Description
▶widgets	array	List of widgets on the dashboard
created_timestamp	string	The timestamp of the dashboard creation.
dashboard_arn	string	The ARN of the dashboard.
▶refresh_schedule	object	Configures the automatic refresh schedule for the dashboard. Includes the frequency unit (DAYS or HOURS) and value, as well as the status (ENABLED or DISABLED) of the refresh schedule.
name	string	The name of the dashboard.
status	string	The status of the dashboard. Values are CREATING, CREATED, UPDATING, UPDATED and DELETING.
termination_protection_enabled	boolean	Indicates whether the dashboard is protected from termination.
type	string	The type of the dashboard. Values are CUSTOM and MANAGED.
▶tags	array
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
dashboard_arn	string	The ARN of the dashboard.
region	string	AWS region.

For more information, see AWS::CloudTrail::Dashboard.

Methods

Name	Resource	Accessible by	Required Params
create_resource	dashboards	INSERT	, region
delete_resource	dashboards	DELETE	Identifier, region
update_resource	dashboards	UPDATE	Identifier, PatchDocument, region
list_resources	dashboards_list_only	SELECT	region
get_resource	dashboards	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual dashboard.

SELECT
  region,
  widgets,
  created_timestamp,
  dashboard_arn,
  refresh_schedule,
  name,
  status,
  termination_protection_enabled,
  type,
  updated_timestamp,
  tags
FROM awscc.cloudtrail.dashboards
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ dashboard_arn }}';

list (identifiers only)

Lists all dashboards in a region.

SELECT
  region,
  dashboard_arn
FROM awscc.cloudtrail.dashboards_list_only
WHERE
  region = '{{ region }}';

INSERT example

Use the following StackQL query and manifest file to create a new dashboard resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.cloudtrail.dashboards (
  ,
  region
)
SELECT
  '{{  }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.cloudtrail.dashboards (
  Widgets,
  RefreshSchedule,
  Name,
  TerminationProtectionEnabled,
  Tags,
  region
)
SELECT
  '{{ widgets }}',
  '{{ refresh_schedule }}',
  '{{ name }}',
  '{{ termination_protection_enabled }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: dashboard
  props:
    - name: widgets
      value:
        - query_statement: '{{ query_statement }}'
          query_parameters:
            - '{{ query_parameters[0] }}'
          view_properties: {}
    - name: refresh_schedule
      value:
        frequency:
          unit: '{{ unit }}'
          value: '{{ value }}'
        time_of_day: '{{ time_of_day }}'
        status: '{{ status }}'
    - name: name
      value: '{{ name }}'
    - name: termination_protection_enabled
      value: '{{ termination_protection_enabled }}'
    - name: tags
      value:
        - value: '{{ value }}'
          key: '{{ key }}'

UPDATE example

Use the following StackQL query and manifest file to update a dashboard resource, using stack-deploy.

/*+ update */
UPDATE awscc.cloudtrail.dashboards
SET PatchDocument = string('{{ {
    "Widgets": widgets,
    "RefreshSchedule": refresh_schedule,
    "Name": name,
    "TerminationProtectionEnabled": termination_protection_enabled,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ dashboard_arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.cloudtrail.dashboards
WHERE
  Identifier = '{{ dashboard_arn }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

To operate on the dashboards resource, the following permissions are required:

Create

CloudTrail:CreateDashboard,
CloudTrail:AddTags,
CloudTrail:StartQuery,
CloudTrail:StartDashboardRefresh

Read

CloudTrail:GetDashboard,
CloudTrail:ListDashboards,
CloudTrail:ListTags

Update

CloudTrail:UpdateDashboard,
CloudTrail:AddTags,
CloudTrail:RemoveTags,
CloudTrail:StartQuery,
CloudTrail:StartDashboardRefresh

Delete

CloudTrail:DeleteDashboard,
CloudTrail:UpdateDashboard

List

CloudTrail:ListDashboards,
CloudTrail:GetDashboard,
CloudTrail:ListTags