AWS::Deadline::Monitor

Creates an AWS Deadline Cloud monitor that you can use to view your farms, queues, and fleets. After you submit a job, you can track the progress of the tasks and steps that make up the job, and then download the job's results.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Deadline::Monitor",
  "Properties" : {
      "DisplayName" : String,
      "IdentityCenterInstanceArn" : String,
      "RoleArn" : String,
      "Subdomain" : String
    }
}

YAML

Type: AWS::Deadline::Monitor
Properties:
  DisplayName: String
  IdentityCenterInstanceArn: String
  RoleArn: String
  Subdomain: String

Properties

DisplayName

The name of the monitor that displays on the Deadline Cloud console.

Important

This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

Required: Yes

Type: String

Minimum: 1

Maximum: 100

Update requires: No interruption

IdentityCenterInstanceArn

The Amazon Resource Name (ARN) of the IAM Identity Center instance responsible for authenticating monitor users.

Required: Yes

Type: String

Pattern: ^arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}$

Update requires: Replacement

RoleArn

The Amazon Resource Name (ARN) of the IAM role for the monitor. Users of the monitor use this role to access Deadline Cloud resources.

Required: Yes

Type: String

Pattern: ^arn:(aws[a-zA-Z-]*):iam::\d{12}:role(/[!-.0-~]+)*/[\w+=,.@-]+$

Update requires: No interruption

Subdomain

The subdomain used for the monitor URL. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.

Required: Yes

Type: String

Pattern: ^[a-z0-9-]{1,100}$

Update requires: No interruption

Return values

Ref

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Arn

The Amazon Resource Name (ARN) of the monitor.

IdentityCenterApplicationArn

The Amazon Resource Name (ARN) that the IAM Identity Center assigned to the monitor when it was created.

MonitorId

The unique identifier for the monitor.

Url

The complete URL of the monitor. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.