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	awscc.deadline.monitors

Fields

get (all properties)

Name	Datatype	Description
display_name	string
identity_center_application_arn	string
identity_center_instance_arn	string
monitor_id	string
role_arn	string
subdomain	string
▶tags	array	An array of key-value pairs to apply to this resource.
url	string
arn	string
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
arn	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	monitors	INSERT	DisplayName, IdentityCenterInstanceArn, RoleArn, Subdomain, region
delete_resource	monitors	DELETE	Identifier, region
update_resource	monitors	UPDATE	Identifier, PatchDocument, region
list_resources	monitors_list_only	SELECT	region
get_resource	monitors	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual monitor.

SELECT
  region,
  display_name,
  identity_center_application_arn,
  identity_center_instance_arn,
  monitor_id,
  role_arn,
  subdomain,
  tags,
  url,
  arn
FROM awscc.deadline.monitors
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all monitors in a region.

SELECT
  region,
  arn
FROM awscc.deadline.monitors_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.deadline.monitors (
  DisplayName,
  IdentityCenterInstanceArn,
  RoleArn,
  Subdomain,
  region
)
SELECT
  '{{ display_name }}',
  '{{ identity_center_instance_arn }}',
  '{{ role_arn }}',
  '{{ subdomain }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.deadline.monitors (
  DisplayName,
  IdentityCenterInstanceArn,
  RoleArn,
  Subdomain,
  Tags,
  region
)
SELECT
  '{{ display_name }}',
  '{{ identity_center_instance_arn }}',
  '{{ role_arn }}',
  '{{ subdomain }}',
  '{{ 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: monitor
  props:
    - name: display_name
      value: '{{ display_name }}'
    - name: identity_center_instance_arn
      value: '{{ identity_center_instance_arn }}'
    - name: role_arn
      value: '{{ role_arn }}'
    - name: subdomain
      value: '{{ subdomain }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.deadline.monitors
SET PatchDocument = string('{{ {
    "DisplayName": display_name,
    "RoleArn": role_arn,
    "Subdomain": subdomain,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.deadline.monitors
WHERE
  Identifier = '{{ 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 monitors resource, the following permissions are required:

Create

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

Read

deadline:GetMonitor,
deadline:ListTagsForResource

Update

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

Delete

deadline:DeleteMonitor,
deadline:GetMonitor,
sso:DeleteApplication

List

deadline:ListMonitors