CfnMonitorProps

class aws_cdk.aws_deadline.CfnMonitorProps(*, display_name, identity_center_instance_arn, role_arn, subdomain)

Bases: object

Properties for defining a CfnMonitor.

Parameters:

display_name (str) – The name of the monitor that displays on the Deadline Cloud console. .. epigraph:: 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.
identity_center_instance_arn (str) – The Amazon Resource Name (ARN) of the IAM Identity Center instance responsible for authenticating monitor users.
role_arn (str) – The Amazon Resource Name (ARN) of the IAM role for the monitor. Users of the monitor use this role to access Deadline Cloud resources.
subdomain (str) – The subdomain used for the monitor URL. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-monitor.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_deadline as deadline

cfn_monitor_props = deadline.CfnMonitorProps(
    display_name="displayName",
    identity_center_instance_arn="identityCenterInstanceArn",
    role_arn="roleArn",
    subdomain="subdomain"
)

Attributes

display_name

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-monitor.html#cfn-deadline-monitor-displayname

identity_center_instance_arn

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-monitor.html#cfn-deadline-monitor-identitycenterinstancearn

role_arn

The Amazon Resource Name (ARN) of the IAM role for the monitor.

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-monitor.html#cfn-deadline-monitor-rolearn

subdomain

The subdomain used for the monitor URL.

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-monitor.html#cfn-deadline-monitor-subdomain