software.amazon.awscdk.services.connect

Class CfnUser

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.connect.CfnUser

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:35.640Z")
public class CfnUser
extends CfnResource
implements IInspectable

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

Specifies a user account for an 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")
                 .mobile("mobile")
                 .secondaryEmail("secondaryEmail")
                 .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 interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnUser(Construct scope, java.lang.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
java.lang.String	getAttrUserArn() The Amazon Resource Name (ARN) of the user.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDirectoryUserId() The identifier of the user account in the directory used for identity management.
java.lang.String	getHierarchyGroupArn() The Amazon Resource Name (ARN) of the user's hierarchy group.
java.lang.Object	getIdentityInfo() Information about the user identity.
java.lang.String	getInstanceArn() The Amazon Resource Name (ARN) of the instance.
java.lang.String	getPassword() The user's password.
java.lang.Object	getPhoneConfig() Information about the phone configuration for the user.
java.lang.String	getRoutingProfileArn() The Amazon Resource Name (ARN) of the user's routing profile.
java.util.List<java.lang.String>	getSecurityProfileArns() The Amazon Resource Name (ARN) of the user's security profile.
TagManager	getTags() The tags.
java.lang.String	getUsername() The user name assigned to the user account.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setDirectoryUserId(java.lang.String value) The identifier of the user account in the directory used for identity management.
void	setHierarchyGroupArn(java.lang.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(java.lang.String value) The Amazon Resource Name (ARN) of the instance.
void	setPassword(java.lang.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(java.lang.String value) The Amazon Resource Name (ARN) of the user's routing profile.
void	setSecurityProfileArns(java.util.List<java.lang.String> value) The Amazon Resource Name (ARN) of the user's security profile.
void	setUsername(java.lang.String value) The user name assigned to the user account.

Methods inherited from class software.amazon.awscdk.core.CfnResource

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

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.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

public CfnUser(Construct scope,
               java.lang.String id,
               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

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrUserArn

public java.lang.String getAttrUserArn()

The Amazon Resource Name (ARN) of the user.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

The tags.

getInstanceArn

public java.lang.String getInstanceArn()

The Amazon Resource Name (ARN) of the instance.

setInstanceArn

public void setInstanceArn(java.lang.String value)

The Amazon Resource Name (ARN) of the instance.

getPhoneConfig

public java.lang.Object getPhoneConfig()

Information about the phone configuration for the user.

setPhoneConfig

public void setPhoneConfig(IResolvable value)

Information about the phone configuration for the user.

setPhoneConfig

public void setPhoneConfig(CfnUser.UserPhoneConfigProperty value)

Information about the phone configuration for the user.

getRoutingProfileArn

public java.lang.String getRoutingProfileArn()

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

setRoutingProfileArn

public void setRoutingProfileArn(java.lang.String value)

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

getSecurityProfileArns

public java.util.List<java.lang.String> getSecurityProfileArns()

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

setSecurityProfileArns

public void setSecurityProfileArns(java.util.List<java.lang.String> value)

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

getUsername

public java.lang.String getUsername()

The user name assigned to the user account.

setUsername

public void setUsername(java.lang.String value)

The user name assigned to the user account.

getDirectoryUserId

public java.lang.String getDirectoryUserId()

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

setDirectoryUserId

public void setDirectoryUserId(java.lang.String value)

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

getHierarchyGroupArn

public java.lang.String getHierarchyGroupArn()

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

setHierarchyGroupArn

public void setHierarchyGroupArn(java.lang.String value)

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

getIdentityInfo

public java.lang.Object getIdentityInfo()

Information about the user identity.

setIdentityInfo

public void setIdentityInfo(IResolvable value)

Information about the user identity.

setIdentityInfo

public void setIdentityInfo(CfnUser.UserIdentityInfoProperty value)

Information about the user identity.

getPassword

public java.lang.String getPassword()

The user's password.

setPassword

public void setPassword(java.lang.String value)

The user's password.