Skip to content
v2.274.0

CfnMonitorProps Struct ​

Properties for defining a CfnMonitor.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_deadline as deadline } from 'aws-cdk-lib';
const cfnMonitorProps: deadline.CfnMonitorProps = {
  displayName: 'displayName',
  identityCenterInstanceArn: 'identityCenterInstanceArn',
  roleArn: 'roleArn',
  subdomain: 'subdomain',

  // the properties below are optional
  identityCenterRegion: 'identityCenterRegion',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties ​

displayNamestringdisplay_namestrdisplayNameStringDisplayNamestringDisplayName*stringrequired#
The name of the monitor that displays on the Deadline Cloud console.

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.

identityCenterInstanceArnstringidentity_center_instance_arnstridentityCenterInstanceArnStringIdentityCenterInstanceArnstringIdentityCenterInstanceArn*stringrequired#
The Amazon Resource Name of the IAM Identity Center instance responsible for authenticating monitor users.
identityCenterRegionoptionalstringidentity_center_regionoptionalstridentityCenterRegionoptionalStringIdentityCenterRegionoptionalstringIdentityCenterRegionoptional*string#
The AWS region where IAM Identity Center is enabled.

Required when Identity Center is in a different region than the monitor.

roleArnstringrole_arnstrroleArnStringRoleArnstringRoleArn*stringrequired#
The Amazon Resource Name of the IAM role for the monitor.

Users of the monitor use this role to access Deadline Cloud resources.

subdomainstringsubdomainstrsubdomainStringSubdomainstringSubdomain*stringrequired#
The subdomain used for the monitor URL.

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

tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
An array of key-value pairs to apply to this resource.