software.amazon.awscdk.services.connect

Class CfnUser

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.connect.CfnUser

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.776Z")
 @Stability(value=Stable)
public class CfnUser
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Connect::User`.

Creates a user account for the specified Amazon Connect instance.

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.connect.*;
 CfnUser cfnUser = CfnUser.Builder.create(this, "MyCfnUser")
         .instanceArn("instanceArn")
         .phoneConfig(UserPhoneConfigProperty.builder()
                 .phoneType("phoneType")
                 // the properties below are optional
                 .afterContactWorkTimeLimit(123)
                 .autoAccept(false)
                 .deskPhoneNumber("deskPhoneNumber")
                 .build())
         .routingProfileArn("routingProfileArn")
         .securityProfileArns(List.of("securityProfileArns"))
         .username("username")
         // the properties below are optional
         .directoryUserId("directoryUserId")
         .hierarchyGroupArn("hierarchyGroupArn")
         .identityInfo(UserIdentityInfoProperty.builder()
                 .email("email")
                 .firstName("firstName")
                 .lastName("lastName")
                 .build())
         .password("password")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnUser.Builder A fluent builder for CfnUser.
static interface	CfnUser.UserIdentityInfoProperty Contains information about the identity of a user.
static interface	CfnUser.UserPhoneConfigProperty Contains information about the phone configuration settings for a user.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnUser(software.constructs.Construct scope, String id, CfnUserProps props) Create a new `AWS::Connect::User`.
protected	CfnUser(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnUser(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrUserArn() The Amazon Resource Name (ARN) of the user.
protected Map<String,Object>	getCfnProperties()
String	getDirectoryUserId() The identifier of the user account in the directory used for identity management.
String	getHierarchyGroupArn() The Amazon Resource Name (ARN) of the user's hierarchy group.
Object	getIdentityInfo() Information about the user identity.
String	getInstanceArn() The Amazon Resource Name (ARN) of the instance.
String	getPassword() The user's password.
Object	getPhoneConfig() Information about the phone configuration for the user.
String	getRoutingProfileArn() The Amazon Resource Name (ARN) of the user's routing profile.
List<String>	getSecurityProfileArns() The Amazon Resource Name (ARN) of the user's security profile.
TagManager	getTags() The tags.
String	getUsername() The user name assigned to the user account.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDirectoryUserId(String value) The identifier of the user account in the directory used for identity management.
void	setHierarchyGroupArn(String value) The Amazon Resource Name (ARN) of the user's hierarchy group.
void	setIdentityInfo(CfnUser.UserIdentityInfoProperty value) Information about the user identity.
void	setIdentityInfo(IResolvable value) Information about the user identity.
void	setInstanceArn(String value) The Amazon Resource Name (ARN) of the instance.
void	setPassword(String value) The user's password.
void	setPhoneConfig(CfnUser.UserPhoneConfigProperty value) Information about the phone configuration for the user.
void	setPhoneConfig(IResolvable value) Information about the phone configuration for the user.
void	setRoutingProfileArn(String value) The Amazon Resource Name (ARN) of the user's routing profile.
void	setSecurityProfileArns(List<String> value) The Amazon Resource Name (ARN) of the user's security profile.
void	setUsername(String value) The user name assigned to the user account.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnUser

protected CfnUser(software.amazon.jsii.JsiiObjectRef objRef)

CfnUser

protected CfnUser(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnUser

@Stability(value=Stable)
public CfnUser(@NotNull
                                        software.constructs.Construct scope,
                                        @NotNull
                                        String id,
                                        @NotNull
                                        CfnUserProps props)

Create a new `AWS::Connect::User`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrUserArn

@Stability(value=Stable)
 @NotNull
public String getAttrUserArn()

The Amazon Resource Name (ARN) of the user.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

The tags.

getInstanceArn

@Stability(value=Stable)
 @NotNull
public String getInstanceArn()

The Amazon Resource Name (ARN) of the instance.

setInstanceArn

@Stability(value=Stable)
public void setInstanceArn(@NotNull
                                                    String value)

The Amazon Resource Name (ARN) of the instance.

getPhoneConfig

@Stability(value=Stable)
 @NotNull
public Object getPhoneConfig()

Information about the phone configuration for the user.

setPhoneConfig

@Stability(value=Stable)
public void setPhoneConfig(@NotNull
                                                    CfnUser.UserPhoneConfigProperty value)

Information about the phone configuration for the user.

setPhoneConfig

@Stability(value=Stable)
public void setPhoneConfig(@NotNull
                                                    IResolvable value)

Information about the phone configuration for the user.

getRoutingProfileArn

@Stability(value=Stable)
 @NotNull
public String getRoutingProfileArn()

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

setRoutingProfileArn

@Stability(value=Stable)
public void setRoutingProfileArn(@NotNull
                                                          String value)

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

getSecurityProfileArns

@Stability(value=Stable)
 @NotNull
public List<String> getSecurityProfileArns()

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

setSecurityProfileArns

@Stability(value=Stable)
public void setSecurityProfileArns(@NotNull
                                                            List<String> value)

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

getUsername

@Stability(value=Stable)
 @NotNull
public String getUsername()

The user name assigned to the user account.

setUsername

@Stability(value=Stable)
public void setUsername(@NotNull
                                                 String value)

The user name assigned to the user account.

getDirectoryUserId

@Stability(value=Stable)
 @Nullable
public String getDirectoryUserId()

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

setDirectoryUserId

@Stability(value=Stable)
public void setDirectoryUserId(@Nullable
                                                        String value)

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

getHierarchyGroupArn

@Stability(value=Stable)
 @Nullable
public String getHierarchyGroupArn()

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

setHierarchyGroupArn

@Stability(value=Stable)
public void setHierarchyGroupArn(@Nullable
                                                          String value)

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

getIdentityInfo

@Stability(value=Stable)
 @Nullable
public Object getIdentityInfo()

Information about the user identity.

setIdentityInfo

@Stability(value=Stable)
public void setIdentityInfo(@Nullable
                                                     CfnUser.UserIdentityInfoProperty value)

Information about the user identity.

setIdentityInfo

@Stability(value=Stable)
public void setIdentityInfo(@Nullable
                                                     IResolvable value)

Information about the user identity.

getPassword

@Stability(value=Stable)
 @Nullable
public String getPassword()

The user's password.

setPassword

@Stability(value=Stable)
public void setPassword(@Nullable
                                                 String value)

The user's password.