pulumi-aws-kotlin/com.pulumi.aws.connect.kotlin/User

User

class User : KotlinCustomResource

Provides an Amazon Connect User resource. For more information see Amazon Connect: Getting Started

Example Usage

Basic

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.connect.User;
import com.pulumi.aws.connect.UserArgs;
import com.pulumi.aws.connect.inputs.UserIdentityInfoArgs;
import com.pulumi.aws.connect.inputs.UserPhoneConfigArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var example = new User("example", UserArgs.builder()
            .instanceId(aws_connect_instance.example().id())
            .password("Password123")
            .routingProfileId(aws_connect_routing_profile.example().routing_profile_id())
            .securityProfileIds(aws_connect_security_profile.example().security_profile_id())
            .identityInfo(UserIdentityInfoArgs.builder()
                .firstName("example")
                .lastName("example2")
                .build())
            .phoneConfig(UserPhoneConfigArgs.builder()
                .afterContactWorkTimeLimit(0)
                .phoneType("SOFT_PHONE")
                .build())
            .build());
    }
}
Content copied to clipboard

With hierarchy_group_id

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.connect.User;
import com.pulumi.aws.connect.UserArgs;
import com.pulumi.aws.connect.inputs.UserIdentityInfoArgs;
import com.pulumi.aws.connect.inputs.UserPhoneConfigArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var example = new User("example", UserArgs.builder()
            .instanceId(aws_connect_instance.example().id())
            .password("Password123")
            .routingProfileId(aws_connect_routing_profile.example().routing_profile_id())
            .hierarchyGroupId(aws_connect_user_hierarchy_group.example().hierarchy_group_id())
            .securityProfileIds(aws_connect_security_profile.example().security_profile_id())
            .identityInfo(UserIdentityInfoArgs.builder()
                .firstName("example")
                .lastName("example2")
                .build())
            .phoneConfig(UserPhoneConfigArgs.builder()
                .afterContactWorkTimeLimit(0)
                .phoneType("SOFT_PHONE")
                .build())
            .build());
    }
}
Content copied to clipboard

With identity_info filled

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.connect.User;
import com.pulumi.aws.connect.UserArgs;
import com.pulumi.aws.connect.inputs.UserIdentityInfoArgs;
import com.pulumi.aws.connect.inputs.UserPhoneConfigArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var example = new User("example", UserArgs.builder()
            .instanceId(aws_connect_instance.example().id())
            .password("Password123")
            .routingProfileId(aws_connect_routing_profile.example().routing_profile_id())
            .securityProfileIds(aws_connect_security_profile.example().security_profile_id())
            .identityInfo(UserIdentityInfoArgs.builder()
                .email("example@example.com")
                .firstName("example")
                .lastName("example2")
                .build())
            .phoneConfig(UserPhoneConfigArgs.builder()
                .afterContactWorkTimeLimit(0)
                .phoneType("SOFT_PHONE")
                .build())
            .build());
    }
}
Content copied to clipboard

With phone_config phone type as desk phone

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.connect.User;
import com.pulumi.aws.connect.UserArgs;
import com.pulumi.aws.connect.inputs.UserPhoneConfigArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var example = new User("example", UserArgs.builder()
            .instanceId(aws_connect_instance.example().id())
            .password("Password123")
            .routingProfileId(aws_connect_routing_profile.example().routing_profile_id())
            .securityProfileIds(aws_connect_security_profile.example().security_profile_id())
            .phoneConfig(UserPhoneConfigArgs.builder()
                .afterContactWorkTimeLimit(0)
                .phoneType("SOFT_PHONE")
                .build())
            .build());
    }
}
Content copied to clipboard

With multiple Security profile ids specified in security_profile_ids

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.connect.User;
import com.pulumi.aws.connect.UserArgs;
import com.pulumi.aws.connect.inputs.UserPhoneConfigArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var example = new User("example", UserArgs.builder()
            .instanceId(aws_connect_instance.example().id())
            .password("Password123")
            .routingProfileId(aws_connect_routing_profile.example().routing_profile_id())
            .securityProfileIds(
                aws_connect_security_profile.example().security_profile_id(),
                aws_connect_security_profile.example2().security_profile_id())
            .phoneConfig(UserPhoneConfigArgs.builder()
                .afterContactWorkTimeLimit(0)
                .autoAccept(false)
                .deskPhoneNumber("+112345678912")
                .phoneType("DESK_PHONE")
                .build())
            .build());
    }
}
Content copied to clipboard

Import

Amazon Connect Users can be imported using the instance_id and user_id separated by a colon (:), e.g.,

$ pulumi import aws:connect/user:User example f1288a1f-6193-445a-b47e-af739b2:c1d4e5f6-1b3c-1b3c-1b3c-c1d4e5f6c1d4e5
Content copied to clipboard

Properties

Link copied to clipboard
val arn: Output<String>

The Amazon Resource Name (ARN) of the user.

Link copied to clipboard
val directoryUserId: Output<String>

The identifier of the user account in the directory used for identity management. If Amazon Connect cannot access the directory, you can specify this identifier to authenticate users. If you include the identifier, we assume that Amazon Connect cannot access the directory. Otherwise, the identity information is used to authenticate users from your directory. This parameter is required if you are using an existing directory for identity management in Amazon Connect when Amazon Connect cannot access your directory to authenticate users. If you are using SAML for identity management and include this parameter, an error is returned.

Link copied to clipboard
val hierarchyGroupId: Output<String>?

The identifier of the hierarchy group for the user.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val identityInfo: Output<UserIdentityInfo>?

A block that contains information about the identity of the user. Documented below.

Link copied to clipboard
val instanceId: Output<String>

Specifies the identifier of the hosting Amazon Connect Instance.

Link copied to clipboard
val name: Output<String>

The user name for the account. For instances not using SAML for identity management, the user name can include up to 20 characters. If you are using SAML for identity management, the user name can include up to 64 characters from [a-zA-Z0-9_-&#46;\@]+.

Link copied to clipboard
val password: Output<String>?

The password for the user account. A password is required if you are using Amazon Connect for identity management. Otherwise, it is an error to include a password.

Link copied to clipboard
val phoneConfig: Output<UserPhoneConfig>

A block that contains information about the phone settings for the user. Documented below.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val routingProfileId: Output<String>

The identifier of the routing profile for the user.

Link copied to clipboard
val securityProfileIds: Output<List<String>>

A list of identifiers for the security profiles for the user. Specify a minimum of 1 and maximum of 10 security profile ids. For more information, see Best Practices for Security Profiles in the Amazon Connect Administrator Guide.

Link copied to clipboard
val tags: Output<Map<String, String>>?

Tags to apply to the user. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Link copied to clipboard
val tagsAll: Output<Map<String, String>>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Link copied to clipboard
val urn: Output<String>
Link copied to clipboard
val userId: Output<String>

The identifier for the user.