Package software.amazon.awscdk.services.connect

Class CfnUser

java.lang.Object
software.amazon.jsii.JsiiObject
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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:56.023Z") @Stability(Stable) 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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnUser

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

    • CfnUser

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

    • CfnUser

      @Stability(Stable) public CfnUser(@NotNull 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 Details

    • inspect

      @Stability(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(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(Stable) @NotNull public String getAttrUserArn()
      The Amazon Resource Name (ARN) of the user.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      The tags.

    • getInstanceArn

      @Stability(Stable) @NotNull public String getInstanceArn()
      The Amazon Resource Name (ARN) of the instance.

    • setInstanceArn

      @Stability(Stable) public void setInstanceArn(@NotNull String value)
      The Amazon Resource Name (ARN) of the instance.

    • getPhoneConfig

      @Stability(Stable) @NotNull public Object getPhoneConfig()
      Information about the phone configuration for the user.

    • setPhoneConfig

      @Stability(Stable) public void setPhoneConfig(@NotNull IResolvable value)
      Information about the phone configuration for the user.

    • setPhoneConfig

      @Stability(Stable) public void setPhoneConfig(@NotNull CfnUser.UserPhoneConfigProperty value)
      Information about the phone configuration for the user.

    • getRoutingProfileArn

      @Stability(Stable) @NotNull public String getRoutingProfileArn()
      The Amazon Resource Name (ARN) of the user's routing profile.

    • setRoutingProfileArn

      @Stability(Stable) public void setRoutingProfileArn(@NotNull String value)
      The Amazon Resource Name (ARN) of the user's routing profile.

    • getSecurityProfileArns

      @Stability(Stable) @NotNull public List<String> getSecurityProfileArns()
      The Amazon Resource Name (ARN) of the user's security profile.

    • setSecurityProfileArns

      @Stability(Stable) public void setSecurityProfileArns(@NotNull List<String> value)
      The Amazon Resource Name (ARN) of the user's security profile.

    • getUsername

      @Stability(Stable) @NotNull public String getUsername()
      The user name assigned to the user account.

    • setUsername

      @Stability(Stable) public void setUsername(@NotNull String value)
      The user name assigned to the user account.

    • getDirectoryUserId

      @Stability(Stable) @Nullable public String getDirectoryUserId()
      The identifier of the user account in the directory used for identity management.

    • setDirectoryUserId

      @Stability(Stable) public void setDirectoryUserId(@Nullable String value)
      The identifier of the user account in the directory used for identity management.

    • getHierarchyGroupArn

      @Stability(Stable) @Nullable public String getHierarchyGroupArn()
      The Amazon Resource Name (ARN) of the user's hierarchy group.

    • setHierarchyGroupArn

      @Stability(Stable) public void setHierarchyGroupArn(@Nullable String value)
      The Amazon Resource Name (ARN) of the user's hierarchy group.

    • getIdentityInfo

      @Stability(Stable) @Nullable public Object getIdentityInfo()
      Information about the user identity.

    • setIdentityInfo

      @Stability(Stable) public void setIdentityInfo(@Nullable IResolvable value)
      Information about the user identity.

    • setIdentityInfo

      @Stability(Stable) public void setIdentityInfo(@Nullable CfnUser.UserIdentityInfoProperty value)
      Information about the user identity.

    • getPassword

      @Stability(Stable) @Nullable public String getPassword()
      The user's password.

    • setPassword

      @Stability(Stable) public void setPassword(@Nullable String value)
      The user's password.