Class: AWSCDK::Connect::CfnUser

Inherits:
AWSCDK::CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSConnect::IUserRef
Defined in:
connect/cfn_user.rb

Overview

Specifies a user account for an Connect Customer instance.

For information about how to create user accounts using the Connect Customer console, see Add Users in the Connect Customer Administrator Guide .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnUser

Create a new AWS::Connect::User.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::Connect::CfnUserProps) —

    Resource properties.



20
21
22
23
24
25
26
 
# File 'connect/cfn_user.rb', line 20

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::Connect::CfnUserProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29ubmVjdC5DZm5Vc2VyUHJvcHMifQ==")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_user(resource) ⇒ String

Parameters:

Returns:

  • (String) 


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

def self.arn_for_user(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19jb25uZWN0LklVc2VyUmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_connect.CfnUser", "arnForUser", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


196
197
198
 
# File 'connect/cfn_user.rb', line 196

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_connect.CfnUser", "CFN_RESOURCE_TYPE_NAME")
end

.is_cfn_user(x) ⇒ Boolean

Checks whether the given object is a CfnUser.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


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

def self.is_cfn_user(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_connect.CfnUser", "isCfnUser", [x])
end

.jsii_overridable_methods ⇒ Object 



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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'connect/cfn_user.rb', line 28

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_user_arn => { kind: :property, name: "attrUserArn", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :user_ref => { kind: :property, name: "userRef", is_optional: false },
    :instance_arn => { kind: :property, name: "instanceArn", is_optional: false },
    :routing_profile_arn => { kind: :property, name: "routingProfileArn", is_optional: false },
    :security_profile_arns => { kind: :property, name: "securityProfileArns", is_optional: false },
    :username => { kind: :property, name: "username", is_optional: false },
    :after_contact_work_configs => { kind: :property, name: "afterContactWorkConfigs", is_optional: true },
    :auto_accept_configs => { kind: :property, name: "autoAcceptConfigs", is_optional: true },
    :directory_user_id => { kind: :property, name: "directoryUserId", is_optional: true },
    :hierarchy_group_arn => { kind: :property, name: "hierarchyGroupArn", is_optional: true },
    :identity_info => { kind: :property, name: "identityInfo", is_optional: true },
    :password => { kind: :property, name: "password", is_optional: true },
    :persistent_connection_configs => { kind: :property, name: "persistentConnectionConfigs", is_optional: true },
    :phone_config => { kind: :property, name: "phoneConfig", is_optional: true },
    :phone_number_configs => { kind: :property, name: "phoneNumberConfigs", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :user_proficiencies => { kind: :property, name: "userProficiencies", is_optional: true },
    :voice_enhancement_configs => { kind: :property, name: "voiceEnhancementConfigs", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



452
453
454
455
 
# File 'connect/cfn_user.rb', line 452

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



464
465
466
467
 
# File 'connect/cfn_user.rb', line 464

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



474
475
476
477
 
# File 'connect/cfn_user.rb', line 474

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



485
486
487
488
489
 
# File 'connect/cfn_user.rb', line 485

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


542
543
544
545
546
 
# File 'connect/cfn_user.rb', line 542

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



552
553
554
555
 
# File 'connect/cfn_user.rb', line 552

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



564
565
566
567
568
 
# File 'connect/cfn_user.rb', line 564

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#after_contact_work_configs ⇒ AWSCDK::IResolvable, ...

After Contact Work configurations of a user.

Returns:



272
273
274
 
# File 'connect/cfn_user.rb', line 272

def after_contact_work_configs()
  jsii_get_property("afterContactWorkConfigs")
end

#after_contact_work_configs=(value) ⇒ Object 



276
277
278
279
 
# File 'connect/cfn_user.rb', line 276

def after_contact_work_configs=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29ubmVjdC5DZm5Vc2VyLkFmdGVyQ29udGFjdFdvcmtDb25maWdQZXJDaGFubmVsUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "afterContactWorkConfigs") unless value.nil?
  jsii_set_property("afterContactWorkConfigs", value)
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



577
578
579
580
 
# File 'connect/cfn_user.rb', line 577

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



599
600
601
602
603
604
 
# File 'connect/cfn_user.rb', line 599

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_user_arn ⇒ String

The Amazon Resource Name (ARN) of the user.

Returns:

  • (String) 


203
204
205
 
# File 'connect/cfn_user.rb', line 203

def attr_user_arn()
  jsii_get_property("attrUserArn")
end

#auto_accept_configs ⇒ AWSCDK::IResolvable, ...

Auto-accept configurations of a user.

Returns:



284
285
286
 
# File 'connect/cfn_user.rb', line 284

def auto_accept_configs()
  jsii_get_property("autoAcceptConfigs")
end

#auto_accept_configs=(value) ⇒ Object 



288
289
290
291
 
# File 'connect/cfn_user.rb', line 288

def auto_accept_configs=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29ubmVjdC5DZm5Vc2VyLkF1dG9BY2NlcHRDb25maWdQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "autoAcceptConfigs") unless value.nil?
  jsii_set_property("autoAcceptConfigs", value)
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



149
150
151
 
# File 'connect/cfn_user.rb', line 149

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


154
155
156
 
# File 'connect/cfn_user.rb', line 154

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


608
609
610
611
 
# File 'connect/cfn_user.rb', line 608

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


159
160
161
 
# File 'connect/cfn_user.rb', line 159

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


166
167
168
 
# File 'connect/cfn_user.rb', line 166

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


111
112
113
 
# File 'connect/cfn_user.rb', line 111

def creation_stack()
  jsii_get_property("creationStack")
end

#directory_user_id ⇒ String?

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

Returns:

  • (String, nil) 


296
297
298
 
# File 'connect/cfn_user.rb', line 296

def directory_user_id()
  jsii_get_property("directoryUserId")
end

#directory_user_id=(value) ⇒ Object 



300
301
302
303
 
# File 'connect/cfn_user.rb', line 300

def directory_user_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "directoryUserId") unless value.nil?
  jsii_set_property("directoryUserId", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



171
172
173
 
# File 'connect/cfn_user.rb', line 171

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



621
622
623
624
625
 
# File 'connect/cfn_user.rb', line 621

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



632
633
634
635
 
# File 'connect/cfn_user.rb', line 632

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#hierarchy_group_arn ⇒ String?

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

Returns:

  • (String, nil) 


308
309
310
 
# File 'connect/cfn_user.rb', line 308

def hierarchy_group_arn()
  jsii_get_property("hierarchyGroupArn")
end

#hierarchy_group_arn=(value) ⇒ Object 



312
313
314
315
 
# File 'connect/cfn_user.rb', line 312

def hierarchy_group_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "hierarchyGroupArn") unless value.nil?
  jsii_set_property("hierarchyGroupArn", value)
end

#identity_info ⇒ AWSCDK::IResolvable, ...

Information about the user identity.

Returns:



320
321
322
 
# File 'connect/cfn_user.rb', line 320

def identity_info()
  jsii_get_property("identityInfo")
end

#identity_info=(value) ⇒ Object 



324
325
326
327
328
 
# File 'connect/cfn_user.rb', line 324

def identity_info=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Connect::CfnUser::UserIdentityInfoProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb25uZWN0LkNmblVzZXIuVXNlcklkZW50aXR5SW5mb1Byb3BlcnR5In1dfX0=")), "identityInfo") unless value.nil?
  jsii_set_property("identityInfo", value)
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



702
703
704
705
 
# File 'connect/cfn_user.rb', line 702

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#instance_arn ⇒ String

The Amazon Resource Name (ARN) of the instance.

Returns:

  • (String) 


224
225
226
 
# File 'connect/cfn_user.rb', line 224

def instance_arn()
  jsii_get_property("instanceArn")
end

#instance_arn=(value) ⇒ Object 



228
229
230
231
 
# File 'connect/cfn_user.rb', line 228

def instance_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "instanceArn")
  jsii_set_property("instanceArn", value)
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


123
124
125
 
# File 'connect/cfn_user.rb', line 123

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


106
107
108
 
# File 'connect/cfn_user.rb', line 106

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



643
644
645
 
# File 'connect/cfn_user.rb', line 643

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



650
651
652
 
# File 'connect/cfn_user.rb', line 650

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



443
444
445
446
 
# File 'connect/cfn_user.rb', line 443

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#password ⇒ String?

The user's password.

Returns:

  • (String, nil) 


333
334
335
 
# File 'connect/cfn_user.rb', line 333

def password()
  jsii_get_property("password")
end

#password=(value) ⇒ Object 



337
338
339
340
 
# File 'connect/cfn_user.rb', line 337

def password=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "password") unless value.nil?
  jsii_set_property("password", value)
end

#persistent_connection_configs ⇒ AWSCDK::IResolvable, ...

Persistent Connection configurations of a user.

Returns:



345
346
347
 
# File 'connect/cfn_user.rb', line 345

def persistent_connection_configs()
  jsii_get_property("persistentConnectionConfigs")
end

#persistent_connection_configs=(value) ⇒ Object 



349
350
351
352
 
# File 'connect/cfn_user.rb', line 349

def persistent_connection_configs=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29ubmVjdC5DZm5Vc2VyLlBlcnNpc3RlbnRDb25uZWN0aW9uQ29uZmlnUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "persistentConnectionConfigs") unless value.nil?
  jsii_set_property("persistentConnectionConfigs", value)
end

#phone_config ⇒ AWSCDK::IResolvable, ...

Information about the phone configuration for the user.

Returns:



357
358
359
 
# File 'connect/cfn_user.rb', line 357

def phone_config()
  jsii_get_property("phoneConfig")
end

#phone_config=(value) ⇒ Object 



361
362
363
364
365
 
# File 'connect/cfn_user.rb', line 361

def phone_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Connect::CfnUser::UserPhoneConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb25uZWN0LkNmblVzZXIuVXNlclBob25lQ29uZmlnUHJvcGVydHkifV19fQ==")), "phoneConfig") unless value.nil?
  jsii_set_property("phoneConfig", value)
end

#phone_number_configs ⇒ AWSCDK::IResolvable, ...

Phone Number configurations of a user.

Returns:



370
371
372
 
# File 'connect/cfn_user.rb', line 370

def phone_number_configs()
  jsii_get_property("phoneNumberConfigs")
end

#phone_number_configs=(value) ⇒ Object 



374
375
376
377
 
# File 'connect/cfn_user.rb', line 374

def phone_number_configs=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29ubmVjdC5DZm5Vc2VyLlBob25lTnVtYmVyQ29uZmlnUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "phoneNumberConfigs") unless value.nil?
  jsii_set_property("phoneNumberConfigs", value)
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


142
143
144
 
# File 'connect/cfn_user.rb', line 142

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



661
662
663
664
 
# File 'connect/cfn_user.rb', line 661

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


668
669
670
671
 
# File 'connect/cfn_user.rb', line 668

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



678
679
680
681
682
 
# File 'connect/cfn_user.rb', line 678

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#routing_profile_arn ⇒ String

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

Returns:

  • (String) 


236
237
238
 
# File 'connect/cfn_user.rb', line 236

def routing_profile_arn()
  jsii_get_property("routingProfileArn")
end

#routing_profile_arn=(value) ⇒ Object 



240
241
242
243
 
# File 'connect/cfn_user.rb', line 240

def routing_profile_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "routingProfileArn")
  jsii_set_property("routingProfileArn", value)
end

#security_profile_arns ⇒ Array<String>

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

Returns:

  • (Array<String>) 


248
249
250
 
# File 'connect/cfn_user.rb', line 248

def security_profile_arns()
  jsii_get_property("securityProfileArns")
end

#security_profile_arns=(value) ⇒ Object 



252
253
254
255
 
# File 'connect/cfn_user.rb', line 252

def security_profile_arns=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "securityProfileArns")
  jsii_set_property("securityProfileArns", value)
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



687
688
689
 
# File 'connect/cfn_user.rb', line 687

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



132
133
134
 
# File 'connect/cfn_user.rb', line 132

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



210
211
212
 
# File 'connect/cfn_user.rb', line 210

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

The tags.

Returns:



382
383
384
 
# File 'connect/cfn_user.rb', line 382

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



386
387
388
389
390
 
# File 'connect/cfn_user.rb', line 386

def tags_raw=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



419
420
421
 
# File 'connect/cfn_user.rb', line 419

def to_string()
  jsii_call_method("toString", [])
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


179
180
181
 
# File 'connect/cfn_user.rb', line 179

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


189
190
191
 
# File 'connect/cfn_user.rb', line 189

def updated_properties()
  jsii_get_property("updatedProperties")
end

#user_proficiencies ⇒ AWSCDK::IResolvable, ...

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:



395
396
397
 
# File 'connect/cfn_user.rb', line 395

def user_proficiencies()
  jsii_get_property("userProficiencies")
end

#user_proficiencies=(value) ⇒ Object 



399
400
401
402
 
# File 'connect/cfn_user.rb', line 399

def user_proficiencies=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29ubmVjdC5DZm5Vc2VyLlVzZXJQcm9maWNpZW5jeVByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "userProficiencies") unless value.nil?
  jsii_set_property("userProficiencies", value)
end

#user_ref ⇒ AWSCDK::Interfaces::AWSConnect::UserReference

A reference to a User resource.

Returns:



217
218
219
 
# File 'connect/cfn_user.rb', line 217

def user_ref()
  jsii_get_property("userRef")
end

#username ⇒ String

The user name assigned to the user account.

Returns:

  • (String) 


260
261
262
 
# File 'connect/cfn_user.rb', line 260

def username()
  jsii_get_property("username")
end

#username=(value) ⇒ Object 



264
265
266
267
 
# File 'connect/cfn_user.rb', line 264

def username=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "username")
  jsii_set_property("username", value)
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


693
694
695
696
 
# File 'connect/cfn_user.rb', line 693

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#voice_enhancement_configs ⇒ AWSCDK::IResolvable, ...

Voice Enhancement configurations of a user.

Returns:



407
408
409
 
# File 'connect/cfn_user.rb', line 407

def voice_enhancement_configs()
  jsii_get_property("voiceEnhancementConfigs")
end

#voice_enhancement_configs=(value) ⇒ Object 



411
412
413
414
 
# File 'connect/cfn_user.rb', line 411

def voice_enhancement_configs=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29ubmVjdC5DZm5Vc2VyLlZvaWNlRW5oYW5jZW1lbnRDb25maWdQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "voiceEnhancementConfigs") unless value.nil?
  jsii_set_property("voiceEnhancementConfigs", value)
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


432
433
434
435
436
437
 
# File 'connect/cfn_user.rb', line 432

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end