Class: AWSCDK::Deadline::CfnMonitorProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
deadline/cfn_monitor_props.rb

Overview

Properties for defining a CfnMonitor.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(display_name:, identity_center_instance_arn:, role_arn:, subdomain:, identity_center_region: nil, tags: nil) ⇒ CfnMonitorProps

Returns a new instance of CfnMonitorProps.

Parameters:

  • display_name (String) —

    The name of the monitor that displays on the Deadline Cloud console.

  • identity_center_instance_arn (String) —

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

  • role_arn (String) —

    The Amazon Resource Name of the IAM role for the monitor.

  • subdomain (String) —

    The subdomain used for the monitor URL.

  • identity_center_region (String, nil) (defaults to: nil) —

    The AWS region where IAM Identity Center is enabled.

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

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



15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'deadline/cfn_monitor_props.rb', line 15

def initialize(display_name:, identity_center_instance_arn:, role_arn:, subdomain:, identity_center_region: nil, tags: nil)
  @display_name = display_name
  Jsii::Type.check_type(@display_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "displayName")
  @identity_center_instance_arn = identity_center_instance_arn
  Jsii::Type.check_type(@identity_center_instance_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "identityCenterInstanceArn")
  @role_arn = role_arn
  Jsii::Type.check_type(@role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn")
  @subdomain = subdomain
  Jsii::Type.check_type(@subdomain, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "subdomain")
  @identity_center_region = identity_center_region
  Jsii::Type.check_type(@identity_center_region, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "identityCenterRegion") unless @identity_center_region.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#display_name ⇒ String (readonly)

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.

Returns:

  • (String)

See Also:



36
37
38
 
# File 'deadline/cfn_monitor_props.rb', line 36

def display_name
  @display_name
end

#identity_center_instance_arn ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



41
42
43
 
# File 'deadline/cfn_monitor_props.rb', line 41

def identity_center_instance_arn
  @identity_center_instance_arn
end

#identity_center_region ⇒ String? (readonly)

The AWS region where IAM Identity Center is enabled.

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

Returns:

  • (String, nil)

See Also:



62
63
64
 
# File 'deadline/cfn_monitor_props.rb', line 62

def identity_center_region
  @identity_center_region
end

#role_arn ⇒ String (readonly)

The Amazon Resource Name of the IAM role for the monitor.

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

Returns:

  • (String)

See Also:



48
49
50
 
# File 'deadline/cfn_monitor_props.rb', line 48

def role_arn
  @role_arn
end

#subdomain ⇒ String (readonly)

The subdomain used for the monitor URL.

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

Returns:

  • (String)

See Also:



55
56
57
 
# File 'deadline/cfn_monitor_props.rb', line 55

def subdomain
  @subdomain
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

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

Returns:

See Also:



67
68
69
 
# File 'deadline/cfn_monitor_props.rb', line 67

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



69
70
71
72
73
74
75
76
77
78
 
# File 'deadline/cfn_monitor_props.rb', line 69

def self.jsii_properties
  {
    :display_name => "displayName",
    :identity_center_instance_arn => "identityCenterInstanceArn",
    :role_arn => "roleArn",
    :subdomain => "subdomain",
    :identity_center_region => "identityCenterRegion",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'deadline/cfn_monitor_props.rb', line 80

def to_jsii
  result = {}
  result.merge!({
    "displayName" => @display_name,
    "identityCenterInstanceArn" => @identity_center_instance_arn,
    "roleArn" => @role_arn,
    "subdomain" => @subdomain,
    "identityCenterRegion" => @identity_center_region,
    "tags" => @tags,
  })
  result.compact
end