Skip to content

CreateMonitorRequest

Source code in docs_src/capo_deadline/types/create_monitor_request.py
class CreateMonitorRequest(TypedDict, closed=True):
    client_token: NotRequired["capo_deadline.types.client_token.ClientToken"]
    """<p>The unique token which the server uses to recognize retries of the same request.</p>"""
    display_name: "capo_deadline.types.resource_name.ResourceName"
    """<p>The name that you give the monitor that is displayed in the Deadline Cloud console.</p> <important> <p>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.</p> </important>"""
    identity_center_instance_arn: (
        "capo_deadline.types.identity_center_instance_arn.IdentityCenterInstanceArn"
    )
    """<p>The Amazon Resource Name of the IAM Identity Center instance that authenticates monitor users.</p>"""
    identity_center_region: NotRequired["capo_deadline.types.region.Region"]
    """<p>The Region where IAM Identity Center is enabled. Required when IAM Identity Center is in a different Region than the monitor.</p>"""
    subdomain: "capo_deadline.types.subdomain.Subdomain"
    """<p>The subdomain to use when creating the monitor URL. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.</p>"""
    role_arn: "capo_deadline.types.iam_role_arn.IamRoleArn"
    """<p>The Amazon Resource Name of the IAM role that the monitor uses to connect to Deadline Cloud. Every user that signs in to the monitor using IAM Identity Center uses this role to access Deadline Cloud resources.</p>"""
    tags: NotRequired["capo_deadline.types.tags.Tags"]
    """<p>The tags to add to your monitor. Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.</p>"""

client_token instance-attribute

client_token: NotRequired[ClientToken]

The unique token which the server uses to recognize retries of the same request.

display_name instance-attribute

display_name: ResourceName

The name that you give the monitor that is displayed in 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.

identity_center_instance_arn instance-attribute

identity_center_instance_arn: IdentityCenterInstanceArn

The Amazon Resource Name of the IAM Identity Center instance that authenticates monitor users.

identity_center_region instance-attribute

identity_center_region: NotRequired[Region]

The Region where IAM Identity Center is enabled. Required when IAM Identity Center is in a different Region than the monitor.

role_arn instance-attribute

role_arn: IamRoleArn

The Amazon Resource Name of the IAM role that the monitor uses to connect to Deadline Cloud. Every user that signs in to the monitor using IAM Identity Center uses this role to access Deadline Cloud resources.

subdomain instance-attribute

subdomain: Subdomain

The subdomain to use when creating the monitor URL. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.

tags instance-attribute

tags: NotRequired[Tags]

The tags to add to your monitor. Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.