monitors

Creates, updates, deletes or gets a monitor resource or lists monitors in a region

Overview

Name	monitors
Type	Resource
Description	Definition of AWS::Deadline::Monitor Resource Type
Id	aws.deadline.monitors

Fields

Name	Datatype	Description
display_name	string
identity_center_application_arn	string
identity_center_instance_arn	string
monitor_id	string
role_arn	string
subdomain	string
url	string
arn	string
region	string	AWS region.

For more information, see AWS::Deadline::Monitor.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	DisplayName, IdentityCenterInstanceArn, RoleArn, Subdomain, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all monitors in a region.

SELECT
region,
display_name,
identity_center_application_arn,
identity_center_instance_arn,
monitor_id,
role_arn,
subdomain,
url,
arn
FROM aws.deadline.monitors
WHERE region = 'us-east-1';

Gets all properties from an individual monitor.

SELECT
region,
display_name,
identity_center_application_arn,
identity_center_instance_arn,
monitor_id,
role_arn,
subdomain,
url,
arn
FROM aws.deadline.monitors
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.deadline.monitors (
 DisplayName,
 IdentityCenterInstanceArn,
 RoleArn,
 Subdomain,
 region
)
SELECT 
'{{ DisplayName }}',
 '{{ IdentityCenterInstanceArn }}',
 '{{ RoleArn }}',
 '{{ Subdomain }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.deadline.monitors (
 DisplayName,
 IdentityCenterInstanceArn,
 RoleArn,
 Subdomain,
 region
)
SELECT 
 '{{ DisplayName }}',
 '{{ IdentityCenterInstanceArn }}',
 '{{ RoleArn }}',
 '{{ Subdomain }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: monitor
    props:
      - name: DisplayName
        value: '{{ DisplayName }}'
      - name: IdentityCenterInstanceArn
        value: '{{ IdentityCenterInstanceArn }}'
      - name: RoleArn
        value: '{{ RoleArn }}'
      - name: Subdomain
        value: '{{ Subdomain }}'

DELETE example

/*+ delete */
DELETE FROM aws.deadline.monitors
WHERE data__Identifier = '<Arn>'
AND region = 'us-east-1';

Permissions

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

Create

deadline:CreateMonitor,
deadline:GetMonitor,
iam:PassRole,
kms:CreateGrant,
sso:CreateApplication,
sso:DeleteApplication,
sso:PutApplicationAssignmentConfiguration,
sso:PutApplicationAuthenticationMethod,
sso:PutApplicationGrant

Read

deadline:GetMonitor

Update

deadline:GetMonitor,
deadline:UpdateMonitor,
iam:PassRole,
kms:CreateGrant,
sso:PutApplicationGrant,
sso:UpdateApplication

Delete

deadline:DeleteMonitor,
deadline:GetMonitor,
sso:DeleteApplication

List

deadline:ListMonitors