Class: Aws::Deadline::Types::CreateMonitorRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-deadline/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_token ⇒ String

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

**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

  • (String) 


1320
1321
1322
1323
1324
1325
1326
1327
1328
 
# File 'lib/aws-sdk-deadline/types.rb', line 1320

class CreateMonitorRequest < Struct.new(
  :client_token,
  :display_name,
  :identity_center_instance_arn,
  :subdomain,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#display_name ⇒ String

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.

Returns:

  • (String) 


1320
1321
1322
1323
1324
1325
1326
1327
1328
 
# File 'lib/aws-sdk-deadline/types.rb', line 1320

class CreateMonitorRequest < Struct.new(
  :client_token,
  :display_name,
  :identity_center_instance_arn,
  :subdomain,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#identity_center_instance_arn ⇒ String

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

Returns:

  • (String) 


1320
1321
1322
1323
1324
1325
1326
1327
1328
 
# File 'lib/aws-sdk-deadline/types.rb', line 1320

class CreateMonitorRequest < Struct.new(
  :client_token,
  :display_name,
  :identity_center_instance_arn,
  :subdomain,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

The Amazon Resource Name (ARN) 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.

Returns:

  • (String) 


1320
1321
1322
1323
1324
1325
1326
1327
1328
 
# File 'lib/aws-sdk-deadline/types.rb', line 1320

class CreateMonitorRequest < Struct.new(
  :client_token,
  :display_name,
  :identity_center_instance_arn,
  :subdomain,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#subdomain ⇒ String

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

Returns:

  • (String) 


1320
1321
1322
1323
1324
1325
1326
1327
1328
 
# File 'lib/aws-sdk-deadline/types.rb', line 1320

class CreateMonitorRequest < Struct.new(
  :client_token,
  :display_name,
  :identity_center_instance_arn,
  :subdomain,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end