Package software.amazon.awscdk.services.deadline

Interface CfnMonitorProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnMonitorProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-17T14:40:48.876Z")
@Stability(Stable)
public interface CfnMonitorProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnMonitor.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.deadline.*;
 CfnMonitorProps cfnMonitorProps = CfnMonitorProps.builder()
         .displayName("displayName")
         .identityCenterInstanceArn("identityCenterInstanceArn")
         .roleArn("roleArn")
         .subdomain("subdomain")
         // the properties below are optional
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnMonitorProps.Builder	A builder for CfnMonitorProps
static final class	CfnMonitorProps.Jsii$Proxy	An implementation for CfnMonitorProps

Method Summary

Modifier and Type	Method	Description
static CfnMonitorProps.Builder	builder()
String	getDisplayName()	The name of the monitor that displays on the Deadline Cloud console.
String	getIdentityCenterInstanceArn()	The Amazon Resource Name (ARN) of the IAM Identity Center instance responsible for authenticating monitor users.
String	getRoleArn()	The Amazon Resource Name (ARN) of the IAM role for the monitor.
String	getSubdomain()	The subdomain used for the monitor URL.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDisplayName

@Stability(Stable)
@NotNull
String getDisplayName()

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 Also:

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

getIdentityCenterInstanceArn

@Stability(Stable)
@NotNull
String getIdentityCenterInstanceArn()

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

See Also:

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

getRoleArn

@Stability(Stable)
@NotNull
String getRoleArn()

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 Also:

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

getSubdomain

@Stability(Stable)
@NotNull
String getSubdomain()

The subdomain used for the monitor URL.

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

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

An array of key-value pairs to apply to this resource.

See Also:

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

builder

@Stability(Stable)
static CfnMonitorProps.Builder builder()

Returns:

a CfnMonitorProps.Builder of CfnMonitorProps