Class: AWSCDK::Sagemaker::CfnWorkteamProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
sagemaker/cfn_workteam_props.rb

Overview

Properties for defining a CfnWorkteam.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(description: nil, member_definitions: nil, notification_configuration: nil, tags: nil, workforce_name: nil, workteam_name: nil) ⇒ CfnWorkteamProps

Returns a new instance of CfnWorkteamProps.

Parameters:



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

def initialize(description: nil, member_definitions: nil, notification_configuration: nil, tags: nil, workforce_name: nil, workteam_name: nil)
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @member_definitions = member_definitions
  Jsii::Type.check_type(@member_definitions, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2FnZW1ha2VyLkNmbldvcmt0ZWFtLk1lbWJlckRlZmluaXRpb25Qcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "memberDefinitions") unless @member_definitions.nil?
  @notification_configuration = notification_configuration.is_a?(Hash) ? ::AWSCDK::Sagemaker::CfnWorkteam::NotificationConfigurationProperty.new(**notification_configuration.transform_keys(&:to_sym)) : notification_configuration
  Jsii::Type.check_type(@notification_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYWdlbWFrZXIuQ2ZuV29ya3RlYW0uTm90aWZpY2F0aW9uQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "notificationConfiguration") unless @notification_configuration.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?
  @workforce_name = workforce_name
  Jsii::Type.check_type(@workforce_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "workforceName") unless @workforce_name.nil?
  @workteam_name = workteam_name
  Jsii::Type.check_type(@workteam_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "workteamName") unless @workteam_name.nil?
end

Instance Attribute Details

#description ⇒ String? (readonly)

A description of the work team.

Returns:

  • (String, nil)

See Also:



34
35
36
 
# File 'sagemaker/cfn_workteam_props.rb', line 34

def description
  @description
end

#member_definitions ⇒ AWSCDK::IResolvable, ... (readonly)

A list of MemberDefinition objects that contains objects that identify the workers that make up the work team.

Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For private workforces created using Amazon Cognito use CognitoMemberDefinition . For workforces created using your own OIDC identity provider (IdP) use OidcMemberDefinition .

Returns:

See Also:



41
42
43
 
# File 'sagemaker/cfn_workteam_props.rb', line 41

def member_definitions
  @member_definitions
end

#notification_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

Configures SNS notifications of available or expiring work items for work teams.

Returns:

See Also:



46
47
48
 
# File 'sagemaker/cfn_workteam_props.rb', line 46

def notification_configuration
  @notification_configuration
end

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

An array of key-value pairs.

Returns:

See Also:



51
52
53
 
# File 'sagemaker/cfn_workteam_props.rb', line 51

def tags
  @tags
end

#workforce_name ⇒ String? (readonly)

The name of the workforce.

Returns:

  • (String, nil)

See Also:



56
57
58
 
# File 'sagemaker/cfn_workteam_props.rb', line 56

def workforce_name
  @workforce_name
end

#workteam_name ⇒ String? (readonly)

The name of the work team.

Returns:

  • (String, nil)

See Also:



61
62
63
 
# File 'sagemaker/cfn_workteam_props.rb', line 61

def workteam_name
  @workteam_name
end

Class Method Details

.jsii_properties ⇒ Object 



63
64
65
66
67
68
69
70
71
72
 
# File 'sagemaker/cfn_workteam_props.rb', line 63

def self.jsii_properties
  {
    :description => "description",
    :member_definitions => "memberDefinitions",
    :notification_configuration => "notificationConfiguration",
    :tags => "tags",
    :workforce_name => "workforceName",
    :workteam_name => "workteamName",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'sagemaker/cfn_workteam_props.rb', line 74

def to_jsii
  result = {}
  result.merge!({
    "description" => @description,
    "memberDefinitions" => @member_definitions,
    "notificationConfiguration" => @notification_configuration,
    "tags" => @tags,
    "workforceName" => @workforce_name,
    "workteamName" => @workteam_name,
  })
  result.compact
end