Class: AWSCDK::Connect::CfnUserProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
connect/cfn_user_props.rb

Overview

Properties for defining a CfnUser.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(instance_arn:, routing_profile_arn:, security_profile_arns:, username:, after_contact_work_configs: nil, auto_accept_configs: nil, directory_user_id: nil, hierarchy_group_arn: nil, identity_info: nil, password: nil, persistent_connection_configs: nil, phone_config: nil, phone_number_configs: nil, tags: nil, user_proficiencies: nil, voice_enhancement_configs: nil) ⇒ CfnUserProps

Returns a new instance of CfnUserProps.

Parameters:



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'connect/cfn_user_props.rb', line 25

def initialize(instance_arn:, routing_profile_arn:, security_profile_arns:, username:, after_contact_work_configs: nil, auto_accept_configs: nil, directory_user_id: nil, hierarchy_group_arn: nil, identity_info: nil, password: nil, persistent_connection_configs: nil, phone_config: nil, phone_number_configs: nil, tags: nil, user_proficiencies: nil, voice_enhancement_configs: nil)
  @instance_arn = instance_arn
  Jsii::Type.check_type(@instance_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "instanceArn")
  @routing_profile_arn = routing_profile_arn
  Jsii::Type.check_type(@routing_profile_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "routingProfileArn")
  @security_profile_arns = security_profile_arns
  Jsii::Type.check_type(@security_profile_arns, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "securityProfileArns")
  @username = username
  Jsii::Type.check_type(@username, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "username")
  @after_contact_work_configs = after_contact_work_configs
  Jsii::Type.check_type(@after_contact_work_configs, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29ubmVjdC5DZm5Vc2VyLkFmdGVyQ29udGFjdFdvcmtDb25maWdQZXJDaGFubmVsUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "afterContactWorkConfigs") unless @after_contact_work_configs.nil?
  @auto_accept_configs = auto_accept_configs
  Jsii::Type.check_type(@auto_accept_configs, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29ubmVjdC5DZm5Vc2VyLkF1dG9BY2NlcHRDb25maWdQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "autoAcceptConfigs") unless @auto_accept_configs.nil?
  @directory_user_id = directory_user_id
  Jsii::Type.check_type(@directory_user_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "directoryUserId") unless @directory_user_id.nil?
  @hierarchy_group_arn = hierarchy_group_arn
  Jsii::Type.check_type(@hierarchy_group_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "hierarchyGroupArn") unless @hierarchy_group_arn.nil?
  @identity_info = identity_info.is_a?(Hash) ? ::AWSCDK::Connect::CfnUser::UserIdentityInfoProperty.new(**identity_info.transform_keys(&:to_sym)) : identity_info
  Jsii::Type.check_type(@identity_info, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb25uZWN0LkNmblVzZXIuVXNlcklkZW50aXR5SW5mb1Byb3BlcnR5In1dfX0=")), "identityInfo") unless @identity_info.nil?
  @password = password
  Jsii::Type.check_type(@password, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "password") unless @password.nil?
  @persistent_connection_configs = persistent_connection_configs
  Jsii::Type.check_type(@persistent_connection_configs, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29ubmVjdC5DZm5Vc2VyLlBlcnNpc3RlbnRDb25uZWN0aW9uQ29uZmlnUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "persistentConnectionConfigs") unless @persistent_connection_configs.nil?
  @phone_config = phone_config.is_a?(Hash) ? ::AWSCDK::Connect::CfnUser::UserPhoneConfigProperty.new(**phone_config.transform_keys(&:to_sym)) : phone_config
  Jsii::Type.check_type(@phone_config, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb25uZWN0LkNmblVzZXIuVXNlclBob25lQ29uZmlnUHJvcGVydHkifV19fQ==")), "phoneConfig") unless @phone_config.nil?
  @phone_number_configs = phone_number_configs
  Jsii::Type.check_type(@phone_number_configs, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29ubmVjdC5DZm5Vc2VyLlBob25lTnVtYmVyQ29uZmlnUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "phoneNumberConfigs") unless @phone_number_configs.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?
  @user_proficiencies = user_proficiencies
  Jsii::Type.check_type(@user_proficiencies, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29ubmVjdC5DZm5Vc2VyLlVzZXJQcm9maWNpZW5jeVByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "userProficiencies") unless @user_proficiencies.nil?
  @voice_enhancement_configs = voice_enhancement_configs
  Jsii::Type.check_type(@voice_enhancement_configs, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29ubmVjdC5DZm5Vc2VyLlZvaWNlRW5oYW5jZW1lbnRDb25maWdQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "voiceEnhancementConfigs") unless @voice_enhancement_configs.nil?
end

Instance Attribute Details

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

After Contact Work configurations of a user.

Returns:

See Also:



84
85
86
 
# File 'connect/cfn_user_props.rb', line 84

def after_contact_work_configs
  @after_contact_work_configs
end

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

Auto-accept configurations of a user.

Returns:

See Also:



89
90
91
 
# File 'connect/cfn_user_props.rb', line 89

def auto_accept_configs
  @auto_accept_configs
end

#directory_user_id ⇒ String? (readonly)

The identifier of the user account in the directory used for identity management.

Returns:

  • (String, nil)

See Also:



94
95
96
 
# File 'connect/cfn_user_props.rb', line 94

def directory_user_id
  @directory_user_id
end

#hierarchy_group_arn ⇒ String? (readonly)

The Amazon Resource Name (ARN) of the user's hierarchy group.

Returns:

  • (String, nil)

See Also:



99
100
101
 
# File 'connect/cfn_user_props.rb', line 99

def hierarchy_group_arn
  @hierarchy_group_arn
end

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

Information about the user identity.

Returns:

See Also:



104
105
106
 
# File 'connect/cfn_user_props.rb', line 104

def identity_info
  @identity_info
end

#instance_arn ⇒ String (readonly)

The Amazon Resource Name (ARN) of the instance.

Returns:

  • (String)

See Also:



64
65
66
 
# File 'connect/cfn_user_props.rb', line 64

def instance_arn
  @instance_arn
end

#password ⇒ String? (readonly)

The user's password.

Returns:

  • (String, nil)

See Also:



109
110
111
 
# File 'connect/cfn_user_props.rb', line 109

def password
  @password
end

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

Persistent Connection configurations of a user.

Returns:

See Also:



114
115
116
 
# File 'connect/cfn_user_props.rb', line 114

def persistent_connection_configs
  @persistent_connection_configs
end

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

Information about the phone configuration for the user.

Returns:

See Also:



119
120
121
 
# File 'connect/cfn_user_props.rb', line 119

def phone_config
  @phone_config
end

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

Phone Number configurations of a user.

Returns:

See Also:



124
125
126
 
# File 'connect/cfn_user_props.rb', line 124

def phone_number_configs
  @phone_number_configs
end

#routing_profile_arn ⇒ String (readonly)

The Amazon Resource Name (ARN) of the user's routing profile.

Returns:

  • (String)

See Also:



69
70
71
 
# File 'connect/cfn_user_props.rb', line 69

def routing_profile_arn
  @routing_profile_arn
end

#security_profile_arns ⇒ Array<String> (readonly)

The Amazon Resource Name (ARN) of the user's security profile.

Returns:

  • (Array<String>)

See Also:



74
75
76
 
# File 'connect/cfn_user_props.rb', line 74

def security_profile_arns
  @security_profile_arns
end

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

The tags.

Returns:

See Also:



129
130
131
 
# File 'connect/cfn_user_props.rb', line 129

def tags
  @tags
end

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

One or more predefined attributes assigned to a user, with a numeric value that indicates how their level of skill in a specified area.

Returns:

See Also:



134
135
136
 
# File 'connect/cfn_user_props.rb', line 134

def user_proficiencies
  @user_proficiencies
end

#username ⇒ String (readonly)

The user name assigned to the user account.

Returns:

  • (String)

See Also:



79
80
81
 
# File 'connect/cfn_user_props.rb', line 79

def username
  @username
end

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

Voice Enhancement configurations of a user.

Returns:

See Also:



139
140
141
 
# File 'connect/cfn_user_props.rb', line 139

def voice_enhancement_configs
  @voice_enhancement_configs
end

Class Method Details

.jsii_properties ⇒ Object 



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'connect/cfn_user_props.rb', line 141

def self.jsii_properties
  {
    :instance_arn => "instanceArn",
    :routing_profile_arn => "routingProfileArn",
    :security_profile_arns => "securityProfileArns",
    :username => "username",
    :after_contact_work_configs => "afterContactWorkConfigs",
    :auto_accept_configs => "autoAcceptConfigs",
    :directory_user_id => "directoryUserId",
    :hierarchy_group_arn => "hierarchyGroupArn",
    :identity_info => "identityInfo",
    :password => "password",
    :persistent_connection_configs => "persistentConnectionConfigs",
    :phone_config => "phoneConfig",
    :phone_number_configs => "phoneNumberConfigs",
    :tags => "tags",
    :user_proficiencies => "userProficiencies",
    :voice_enhancement_configs => "voiceEnhancementConfigs",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'connect/cfn_user_props.rb', line 162

def to_jsii
  result = {}
  result.merge!({
    "instanceArn" => @instance_arn,
    "routingProfileArn" => @routing_profile_arn,
    "securityProfileArns" => @security_profile_arns,
    "username" => @username,
    "afterContactWorkConfigs" => @after_contact_work_configs,
    "autoAcceptConfigs" => @auto_accept_configs,
    "directoryUserId" => @directory_user_id,
    "hierarchyGroupArn" => @hierarchy_group_arn,
    "identityInfo" => @identity_info,
    "password" => @password,
    "persistentConnectionConfigs" => @persistent_connection_configs,
    "phoneConfig" => @phone_config,
    "phoneNumberConfigs" => @phone_number_configs,
    "tags" => @tags,
    "userProficiencies" => @user_proficiencies,
    "voiceEnhancementConfigs" => @voice_enhancement_configs,
  })
  result.compact
end