Package software.amazon.awscdk.services.deadline

Class CfnMonitor

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.deadline.CfnMonitor
All Implemented Interfaces:
IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)", date="2024-10-05T03:43:41.389Z") @Stability(Stable) public class CfnMonitor extends CfnResource implements IInspectable
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.

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.*;
 CfnMonitor cfnMonitor = CfnMonitor.Builder.create(this, "MyCfnMonitor")
         .displayName("displayName")
         .identityCenterInstanceArn("identityCenterInstanceArn")
         .roleArn("roleArn")
         .subdomain("subdomain")
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnMonitor

      protected CfnMonitor(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnMonitor

      protected CfnMonitor(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnMonitor

      @Stability(Stable) public CfnMonitor(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnMonitorProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the monitor.

    • getAttrIdentityCenterApplicationArn

      @Stability(Stable) @NotNull public String getAttrIdentityCenterApplicationArn()
      The Amazon Resource Name (ARN) that the IAM Identity Center assigned to the monitor when it was created.

    • getAttrMonitorId

      @Stability(Stable) @NotNull public String getAttrMonitorId()
      The unique identifier for the monitor.

    • getAttrUrl

      @Stability(Stable) @NotNull public String getAttrUrl()
      The complete URL of the monitor.

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

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getDisplayName

      @Stability(Stable) @NotNull public String getDisplayName()
      The name of the monitor that displays on the Deadline Cloud console.

    • setDisplayName

      @Stability(Stable) public void setDisplayName(@NotNull String value)
      The name of the monitor that displays on the Deadline Cloud console.

    • getIdentityCenterInstanceArn

      @Stability(Stable) @NotNull public String getIdentityCenterInstanceArn()
      The Amazon Resource Name (ARN) of the IAM Identity Center instance responsible for authenticating monitor users.

    • setIdentityCenterInstanceArn

      @Stability(Stable) public void setIdentityCenterInstanceArn(@NotNull String value)
      The Amazon Resource Name (ARN) of the IAM Identity Center instance responsible for authenticating monitor users.

    • getRoleArn

      @Stability(Stable) @NotNull public String getRoleArn()
      The Amazon Resource Name (ARN) of the IAM role for the monitor.

    • setRoleArn

      @Stability(Stable) public void setRoleArn(@NotNull String value)
      The Amazon Resource Name (ARN) of the IAM role for the monitor.

    • getSubdomain

      @Stability(Stable) @NotNull public String getSubdomain()
      The subdomain used for the monitor URL.

    • setSubdomain

      @Stability(Stable) public void setSubdomain(@NotNull String value)
      The subdomain used for the monitor URL.