Package software.amazon.awscdk.services.connect

Interface CfnUserProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUserProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:29:56.027Z")
@Stability(Stable)
public interface CfnUserProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnUser.

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.*;
 CfnUserProps cfnUserProps = CfnUserProps.builder()
         .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	Interface	Description
static final class	CfnUserProps.Builder	A builder for CfnUserProps
static final class	CfnUserProps.Jsii$Proxy	An implementation for CfnUserProps

Method Summary

Modifier and Type	Method	Description
static CfnUserProps.Builder	builder()
default String	getDirectoryUserId()	The identifier of the user account in the directory used for identity management.
default String	getHierarchyGroupArn()	The Amazon Resource Name (ARN) of the user's hierarchy group.
default Object	getIdentityInfo()	Information about the user identity.
String	getInstanceArn()	The Amazon Resource Name (ARN) of the instance.
default 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.
default List<CfnTag>	getTags()	The tags.
String	getUsername()	The user name assigned to the user account.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getInstanceArn

@Stability(Stable)
@NotNull
String getInstanceArn()

The Amazon Resource Name (ARN) of the instance.

getPhoneConfig

@Stability(Stable)
@NotNull
Object getPhoneConfig()

Information about the phone configuration for the user.

getRoutingProfileArn

@Stability(Stable)
@NotNull
String getRoutingProfileArn()

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

getSecurityProfileArns

@Stability(Stable)
@NotNull
List<String> getSecurityProfileArns()

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

getUsername

@Stability(Stable)
@NotNull
String getUsername()

The user name assigned to the user account.

getDirectoryUserId

@Stability(Stable)
@Nullable
default String getDirectoryUserId()

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

getHierarchyGroupArn

@Stability(Stable)
@Nullable
default String getHierarchyGroupArn()

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

getIdentityInfo

@Stability(Stable)
@Nullable
default Object getIdentityInfo()

Information about the user identity.

getPassword

@Stability(Stable)
@Nullable
default String getPassword()

The user's password.

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The tags.

builder

@Stability(Stable)
static CfnUserProps.Builder builder()

Returns:

a CfnUserProps.Builder of CfnUserProps