Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. connect
  5. User
AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws

aws.connect.User

Explore with Pulumi AI

AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws

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

Example Usage

Basic

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.connect.User("example", {
    instanceId: exampleAwsConnectInstance.id,
    name: "example",
    password: "Password123",
    routingProfileId: exampleAwsConnectRoutingProfile.routingProfileId,
    securityProfileIds: [exampleAwsConnectSecurityProfile.securityProfileId],
    identityInfo: {
        firstName: "example",
        lastName: "example2",
    },
    phoneConfig: {
        afterContactWorkTimeLimit: 0,
        phoneType: "SOFT_PHONE",
    },
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.connect.User("example",
    instance_id=example_aws_connect_instance["id"],
    name="example",
    password="Password123",
    routing_profile_id=example_aws_connect_routing_profile["routingProfileId"],
    security_profile_ids=[example_aws_connect_security_profile["securityProfileId"]],
    identity_info={
        "first_name": "example",
        "last_name": "example2",
    },
    phone_config={
        "after_contact_work_time_limit": 0,
        "phone_type": "SOFT_PHONE",
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/connect"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := connect.NewUser(ctx, "example", &connect.UserArgs{
			InstanceId:       pulumi.Any(exampleAwsConnectInstance.Id),
			Name:             pulumi.String("example"),
			Password:         pulumi.String("Password123"),
			RoutingProfileId: pulumi.Any(exampleAwsConnectRoutingProfile.RoutingProfileId),
			SecurityProfileIds: pulumi.StringArray{
				exampleAwsConnectSecurityProfile.SecurityProfileId,
			},
			IdentityInfo: &connect.UserIdentityInfoArgs{
				FirstName: pulumi.String("example"),
				LastName:  pulumi.String("example2"),
			},
			PhoneConfig: &connect.UserPhoneConfigArgs{
				AfterContactWorkTimeLimit: pulumi.Int(0),
				PhoneType:                 pulumi.String("SOFT_PHONE"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Connect.User("example", new()
    {
        InstanceId = exampleAwsConnectInstance.Id,
        Name = "example",
        Password = "Password123",
        RoutingProfileId = exampleAwsConnectRoutingProfile.RoutingProfileId,
        SecurityProfileIds = new[]
        {
            exampleAwsConnectSecurityProfile.SecurityProfileId,
        },
        IdentityInfo = new Aws.Connect.Inputs.UserIdentityInfoArgs
        {
            FirstName = "example",
            LastName = "example2",
        },
        PhoneConfig = new Aws.Connect.Inputs.UserPhoneConfigArgs
        {
            AfterContactWorkTimeLimit = 0,
            PhoneType = "SOFT_PHONE",
        },
    });

});
Copy
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(exampleAwsConnectInstance.id())
            .name("example")
            .password("Password123")
            .routingProfileId(exampleAwsConnectRoutingProfile.routingProfileId())
            .securityProfileIds(exampleAwsConnectSecurityProfile.securityProfileId())
            .identityInfo(UserIdentityInfoArgs.builder()
                .firstName("example")
                .lastName("example2")
                .build())
            .phoneConfig(UserPhoneConfigArgs.builder()
                .afterContactWorkTimeLimit(0)
                .phoneType("SOFT_PHONE")
                .build())
            .build());

    }
}
Copy
resources:
  example:
    type: aws:connect:User
    properties:
      instanceId: ${exampleAwsConnectInstance.id}
      name: example
      password: Password123
      routingProfileId: ${exampleAwsConnectRoutingProfile.routingProfileId}
      securityProfileIds:
        - ${exampleAwsConnectSecurityProfile.securityProfileId}
      identityInfo:
        firstName: example
        lastName: example2
      phoneConfig:
        afterContactWorkTimeLimit: 0
        phoneType: SOFT_PHONE
Copy

With hierarchy_group_id

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.connect.User("example", {
    instanceId: exampleAwsConnectInstance.id,
    name: "example",
    password: "Password123",
    routingProfileId: exampleAwsConnectRoutingProfile.routingProfileId,
    hierarchyGroupId: exampleAwsConnectUserHierarchyGroup.hierarchyGroupId,
    securityProfileIds: [exampleAwsConnectSecurityProfile.securityProfileId],
    identityInfo: {
        firstName: "example",
        lastName: "example2",
    },
    phoneConfig: {
        afterContactWorkTimeLimit: 0,
        phoneType: "SOFT_PHONE",
    },
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.connect.User("example",
    instance_id=example_aws_connect_instance["id"],
    name="example",
    password="Password123",
    routing_profile_id=example_aws_connect_routing_profile["routingProfileId"],
    hierarchy_group_id=example_aws_connect_user_hierarchy_group["hierarchyGroupId"],
    security_profile_ids=[example_aws_connect_security_profile["securityProfileId"]],
    identity_info={
        "first_name": "example",
        "last_name": "example2",
    },
    phone_config={
        "after_contact_work_time_limit": 0,
        "phone_type": "SOFT_PHONE",
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/connect"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := connect.NewUser(ctx, "example", &connect.UserArgs{
			InstanceId:       pulumi.Any(exampleAwsConnectInstance.Id),
			Name:             pulumi.String("example"),
			Password:         pulumi.String("Password123"),
			RoutingProfileId: pulumi.Any(exampleAwsConnectRoutingProfile.RoutingProfileId),
			HierarchyGroupId: pulumi.Any(exampleAwsConnectUserHierarchyGroup.HierarchyGroupId),
			SecurityProfileIds: pulumi.StringArray{
				exampleAwsConnectSecurityProfile.SecurityProfileId,
			},
			IdentityInfo: &connect.UserIdentityInfoArgs{
				FirstName: pulumi.String("example"),
				LastName:  pulumi.String("example2"),
			},
			PhoneConfig: &connect.UserPhoneConfigArgs{
				AfterContactWorkTimeLimit: pulumi.Int(0),
				PhoneType:                 pulumi.String("SOFT_PHONE"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Connect.User("example", new()
    {
        InstanceId = exampleAwsConnectInstance.Id,
        Name = "example",
        Password = "Password123",
        RoutingProfileId = exampleAwsConnectRoutingProfile.RoutingProfileId,
        HierarchyGroupId = exampleAwsConnectUserHierarchyGroup.HierarchyGroupId,
        SecurityProfileIds = new[]
        {
            exampleAwsConnectSecurityProfile.SecurityProfileId,
        },
        IdentityInfo = new Aws.Connect.Inputs.UserIdentityInfoArgs
        {
            FirstName = "example",
            LastName = "example2",
        },
        PhoneConfig = new Aws.Connect.Inputs.UserPhoneConfigArgs
        {
            AfterContactWorkTimeLimit = 0,
            PhoneType = "SOFT_PHONE",
        },
    });

});
Copy
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(exampleAwsConnectInstance.id())
            .name("example")
            .password("Password123")
            .routingProfileId(exampleAwsConnectRoutingProfile.routingProfileId())
            .hierarchyGroupId(exampleAwsConnectUserHierarchyGroup.hierarchyGroupId())
            .securityProfileIds(exampleAwsConnectSecurityProfile.securityProfileId())
            .identityInfo(UserIdentityInfoArgs.builder()
                .firstName("example")
                .lastName("example2")
                .build())
            .phoneConfig(UserPhoneConfigArgs.builder()
                .afterContactWorkTimeLimit(0)
                .phoneType("SOFT_PHONE")
                .build())
            .build());

    }
}
Copy
resources:
  example:
    type: aws:connect:User
    properties:
      instanceId: ${exampleAwsConnectInstance.id}
      name: example
      password: Password123
      routingProfileId: ${exampleAwsConnectRoutingProfile.routingProfileId}
      hierarchyGroupId: ${exampleAwsConnectUserHierarchyGroup.hierarchyGroupId}
      securityProfileIds:
        - ${exampleAwsConnectSecurityProfile.securityProfileId}
      identityInfo:
        firstName: example
        lastName: example2
      phoneConfig:
        afterContactWorkTimeLimit: 0
        phoneType: SOFT_PHONE
Copy

With identity_info filled

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.connect.User("example", {
    instanceId: exampleAwsConnectInstance.id,
    name: "example",
    password: "Password123",
    routingProfileId: exampleAwsConnectRoutingProfile.routingProfileId,
    securityProfileIds: [exampleAwsConnectSecurityProfile.securityProfileId],
    identityInfo: {
        email: "example@example.com",
        firstName: "example",
        lastName: "example2",
        secondaryEmail: "secondary@example.com",
    },
    phoneConfig: {
        afterContactWorkTimeLimit: 0,
        phoneType: "SOFT_PHONE",
    },
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.connect.User("example",
    instance_id=example_aws_connect_instance["id"],
    name="example",
    password="Password123",
    routing_profile_id=example_aws_connect_routing_profile["routingProfileId"],
    security_profile_ids=[example_aws_connect_security_profile["securityProfileId"]],
    identity_info={
        "email": "example@example.com",
        "first_name": "example",
        "last_name": "example2",
        "secondary_email": "secondary@example.com",
    },
    phone_config={
        "after_contact_work_time_limit": 0,
        "phone_type": "SOFT_PHONE",
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/connect"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := connect.NewUser(ctx, "example", &connect.UserArgs{
			InstanceId:       pulumi.Any(exampleAwsConnectInstance.Id),
			Name:             pulumi.String("example"),
			Password:         pulumi.String("Password123"),
			RoutingProfileId: pulumi.Any(exampleAwsConnectRoutingProfile.RoutingProfileId),
			SecurityProfileIds: pulumi.StringArray{
				exampleAwsConnectSecurityProfile.SecurityProfileId,
			},
			IdentityInfo: &connect.UserIdentityInfoArgs{
				Email:          pulumi.String("example@example.com"),
				FirstName:      pulumi.String("example"),
				LastName:       pulumi.String("example2"),
				SecondaryEmail: pulumi.String("secondary@example.com"),
			},
			PhoneConfig: &connect.UserPhoneConfigArgs{
				AfterContactWorkTimeLimit: pulumi.Int(0),
				PhoneType:                 pulumi.String("SOFT_PHONE"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Connect.User("example", new()
    {
        InstanceId = exampleAwsConnectInstance.Id,
        Name = "example",
        Password = "Password123",
        RoutingProfileId = exampleAwsConnectRoutingProfile.RoutingProfileId,
        SecurityProfileIds = new[]
        {
            exampleAwsConnectSecurityProfile.SecurityProfileId,
        },
        IdentityInfo = new Aws.Connect.Inputs.UserIdentityInfoArgs
        {
            Email = "example@example.com",
            FirstName = "example",
            LastName = "example2",
            SecondaryEmail = "secondary@example.com",
        },
        PhoneConfig = new Aws.Connect.Inputs.UserPhoneConfigArgs
        {
            AfterContactWorkTimeLimit = 0,
            PhoneType = "SOFT_PHONE",
        },
    });

});
Copy
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(exampleAwsConnectInstance.id())
            .name("example")
            .password("Password123")
            .routingProfileId(exampleAwsConnectRoutingProfile.routingProfileId())
            .securityProfileIds(exampleAwsConnectSecurityProfile.securityProfileId())
            .identityInfo(UserIdentityInfoArgs.builder()
                .email("example@example.com")
                .firstName("example")
                .lastName("example2")
                .secondaryEmail("secondary@example.com")
                .build())
            .phoneConfig(UserPhoneConfigArgs.builder()
                .afterContactWorkTimeLimit(0)
                .phoneType("SOFT_PHONE")
                .build())
            .build());

    }
}
Copy
resources:
  example:
    type: aws:connect:User
    properties:
      instanceId: ${exampleAwsConnectInstance.id}
      name: example
      password: Password123
      routingProfileId: ${exampleAwsConnectRoutingProfile.routingProfileId}
      securityProfileIds:
        - ${exampleAwsConnectSecurityProfile.securityProfileId}
      identityInfo:
        email: example@example.com
        firstName: example
        lastName: example2
        secondaryEmail: secondary@example.com
      phoneConfig:
        afterContactWorkTimeLimit: 0
        phoneType: SOFT_PHONE
Copy

With phone_config phone type as desk phone

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.connect.User("example", {
    instanceId: exampleAwsConnectInstance.id,
    name: "example",
    password: "Password123",
    routingProfileId: exampleAwsConnectRoutingProfile.routingProfileId,
    securityProfileIds: [exampleAwsConnectSecurityProfile.securityProfileId],
    phoneConfig: {
        afterContactWorkTimeLimit: 0,
        phoneType: "SOFT_PHONE",
    },
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.connect.User("example",
    instance_id=example_aws_connect_instance["id"],
    name="example",
    password="Password123",
    routing_profile_id=example_aws_connect_routing_profile["routingProfileId"],
    security_profile_ids=[example_aws_connect_security_profile["securityProfileId"]],
    phone_config={
        "after_contact_work_time_limit": 0,
        "phone_type": "SOFT_PHONE",
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/connect"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := connect.NewUser(ctx, "example", &connect.UserArgs{
			InstanceId:       pulumi.Any(exampleAwsConnectInstance.Id),
			Name:             pulumi.String("example"),
			Password:         pulumi.String("Password123"),
			RoutingProfileId: pulumi.Any(exampleAwsConnectRoutingProfile.RoutingProfileId),
			SecurityProfileIds: pulumi.StringArray{
				exampleAwsConnectSecurityProfile.SecurityProfileId,
			},
			PhoneConfig: &connect.UserPhoneConfigArgs{
				AfterContactWorkTimeLimit: pulumi.Int(0),
				PhoneType:                 pulumi.String("SOFT_PHONE"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Connect.User("example", new()
    {
        InstanceId = exampleAwsConnectInstance.Id,
        Name = "example",
        Password = "Password123",
        RoutingProfileId = exampleAwsConnectRoutingProfile.RoutingProfileId,
        SecurityProfileIds = new[]
        {
            exampleAwsConnectSecurityProfile.SecurityProfileId,
        },
        PhoneConfig = new Aws.Connect.Inputs.UserPhoneConfigArgs
        {
            AfterContactWorkTimeLimit = 0,
            PhoneType = "SOFT_PHONE",
        },
    });

});
Copy
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(exampleAwsConnectInstance.id())
            .name("example")
            .password("Password123")
            .routingProfileId(exampleAwsConnectRoutingProfile.routingProfileId())
            .securityProfileIds(exampleAwsConnectSecurityProfile.securityProfileId())
            .phoneConfig(UserPhoneConfigArgs.builder()
                .afterContactWorkTimeLimit(0)
                .phoneType("SOFT_PHONE")
                .build())
            .build());

    }
}
Copy
resources:
  example:
    type: aws:connect:User
    properties:
      instanceId: ${exampleAwsConnectInstance.id}
      name: example
      password: Password123
      routingProfileId: ${exampleAwsConnectRoutingProfile.routingProfileId}
      securityProfileIds:
        - ${exampleAwsConnectSecurityProfile.securityProfileId}
      phoneConfig:
        afterContactWorkTimeLimit: 0
        phoneType: SOFT_PHONE
Copy

With multiple Security profile ids specified in security_profile_ids

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.connect.User("example", {
    instanceId: exampleAwsConnectInstance.id,
    name: "example",
    password: "Password123",
    routingProfileId: exampleAwsConnectRoutingProfile.routingProfileId,
    securityProfileIds: [
        exampleAwsConnectSecurityProfile.securityProfileId,
        example2.securityProfileId,
    ],
    phoneConfig: {
        afterContactWorkTimeLimit: 0,
        autoAccept: false,
        deskPhoneNumber: "+112345678912",
        phoneType: "DESK_PHONE",
    },
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.connect.User("example",
    instance_id=example_aws_connect_instance["id"],
    name="example",
    password="Password123",
    routing_profile_id=example_aws_connect_routing_profile["routingProfileId"],
    security_profile_ids=[
        example_aws_connect_security_profile["securityProfileId"],
        example2["securityProfileId"],
    ],
    phone_config={
        "after_contact_work_time_limit": 0,
        "auto_accept": False,
        "desk_phone_number": "+112345678912",
        "phone_type": "DESK_PHONE",
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/connect"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := connect.NewUser(ctx, "example", &connect.UserArgs{
			InstanceId:       pulumi.Any(exampleAwsConnectInstance.Id),
			Name:             pulumi.String("example"),
			Password:         pulumi.String("Password123"),
			RoutingProfileId: pulumi.Any(exampleAwsConnectRoutingProfile.RoutingProfileId),
			SecurityProfileIds: pulumi.StringArray{
				exampleAwsConnectSecurityProfile.SecurityProfileId,
				example2.SecurityProfileId,
			},
			PhoneConfig: &connect.UserPhoneConfigArgs{
				AfterContactWorkTimeLimit: pulumi.Int(0),
				AutoAccept:                pulumi.Bool(false),
				DeskPhoneNumber:           pulumi.String("+112345678912"),
				PhoneType:                 pulumi.String("DESK_PHONE"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Connect.User("example", new()
    {
        InstanceId = exampleAwsConnectInstance.Id,
        Name = "example",
        Password = "Password123",
        RoutingProfileId = exampleAwsConnectRoutingProfile.RoutingProfileId,
        SecurityProfileIds = new[]
        {
            exampleAwsConnectSecurityProfile.SecurityProfileId,
            example2.SecurityProfileId,
        },
        PhoneConfig = new Aws.Connect.Inputs.UserPhoneConfigArgs
        {
            AfterContactWorkTimeLimit = 0,
            AutoAccept = false,
            DeskPhoneNumber = "+112345678912",
            PhoneType = "DESK_PHONE",
        },
    });

});
Copy
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(exampleAwsConnectInstance.id())
            .name("example")
            .password("Password123")
            .routingProfileId(exampleAwsConnectRoutingProfile.routingProfileId())
            .securityProfileIds(            
                exampleAwsConnectSecurityProfile.securityProfileId(),
                example2.securityProfileId())
            .phoneConfig(UserPhoneConfigArgs.builder()
                .afterContactWorkTimeLimit(0)
                .autoAccept(false)
                .deskPhoneNumber("+112345678912")
                .phoneType("DESK_PHONE")
                .build())
            .build());

    }
}
Copy
resources:
  example:
    type: aws:connect:User
    properties:
      instanceId: ${exampleAwsConnectInstance.id}
      name: example
      password: Password123
      routingProfileId: ${exampleAwsConnectRoutingProfile.routingProfileId}
      securityProfileIds:
        - ${exampleAwsConnectSecurityProfile.securityProfileId}
        - ${example2.securityProfileId}
      phoneConfig:
        afterContactWorkTimeLimit: 0
        autoAccept: false
        deskPhoneNumber: '+112345678912'
        phoneType: DESK_PHONE
Copy

Create User Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new User(name: string, args: UserArgs, opts?: CustomResourceOptions);
@overload
def User(resource_name: str,
         args: UserArgs,
         opts: Optional[ResourceOptions] = None)

@overload
def User(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         instance_id: Optional[str] = None,
         phone_config: Optional[UserPhoneConfigArgs] = None,
         routing_profile_id: Optional[str] = None,
         security_profile_ids: Optional[Sequence[str]] = None,
         directory_user_id: Optional[str] = None,
         hierarchy_group_id: Optional[str] = None,
         identity_info: Optional[UserIdentityInfoArgs] = None,
         name: Optional[str] = None,
         password: Optional[str] = None,
         tags: Optional[Mapping[str, str]] = None)
func NewUser(ctx *Context, name string, args UserArgs, opts ...ResourceOption) (*User, error)
public User(string name, UserArgs args, CustomResourceOptions? opts = null)
public User(String name, UserArgs args)
public User(String name, UserArgs args, CustomResourceOptions options)

type: aws:connect:User
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. UserArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. UserArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. UserArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. UserArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. UserArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var exampleuserResourceResourceFromConnectuser = new Aws.Connect.User("exampleuserResourceResourceFromConnectuser", new()
{
    InstanceId = "string",
    PhoneConfig = new Aws.Connect.Inputs.UserPhoneConfigArgs
    {
        PhoneType = "string",
        AfterContactWorkTimeLimit = 0,
        AutoAccept = false,
        DeskPhoneNumber = "string",
    },
    RoutingProfileId = "string",
    SecurityProfileIds = new[]
    {
        "string",
    },
    DirectoryUserId = "string",
    HierarchyGroupId = "string",
    IdentityInfo = new Aws.Connect.Inputs.UserIdentityInfoArgs
    {
        Email = "string",
        FirstName = "string",
        LastName = "string",
        SecondaryEmail = "string",
    },
    Name = "string",
    Password = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := connect.NewUser(ctx, "exampleuserResourceResourceFromConnectuser", &connect.UserArgs{
	InstanceId: pulumi.String("string"),
	PhoneConfig: &connect.UserPhoneConfigArgs{
		PhoneType:                 pulumi.String("string"),
		AfterContactWorkTimeLimit: pulumi.Int(0),
		AutoAccept:                pulumi.Bool(false),
		DeskPhoneNumber:           pulumi.String("string"),
	},
	RoutingProfileId: pulumi.String("string"),
	SecurityProfileIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	DirectoryUserId:  pulumi.String("string"),
	HierarchyGroupId: pulumi.String("string"),
	IdentityInfo: &connect.UserIdentityInfoArgs{
		Email:          pulumi.String("string"),
		FirstName:      pulumi.String("string"),
		LastName:       pulumi.String("string"),
		SecondaryEmail: pulumi.String("string"),
	},
	Name:     pulumi.String("string"),
	Password: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var exampleuserResourceResourceFromConnectuser = new User("exampleuserResourceResourceFromConnectuser", UserArgs.builder()
    .instanceId("string")
    .phoneConfig(UserPhoneConfigArgs.builder()
        .phoneType("string")
        .afterContactWorkTimeLimit(0)
        .autoAccept(false)
        .deskPhoneNumber("string")
        .build())
    .routingProfileId("string")
    .securityProfileIds("string")
    .directoryUserId("string")
    .hierarchyGroupId("string")
    .identityInfo(UserIdentityInfoArgs.builder()
        .email("string")
        .firstName("string")
        .lastName("string")
        .secondaryEmail("string")
        .build())
    .name("string")
    .password("string")
    .tags(Map.of("string", "string"))
    .build());
Copy
exampleuser_resource_resource_from_connectuser = aws.connect.User("exampleuserResourceResourceFromConnectuser",
    instance_id="string",
    phone_config={
        "phone_type": "string",
        "after_contact_work_time_limit": 0,
        "auto_accept": False,
        "desk_phone_number": "string",
    },
    routing_profile_id="string",
    security_profile_ids=["string"],
    directory_user_id="string",
    hierarchy_group_id="string",
    identity_info={
        "email": "string",
        "first_name": "string",
        "last_name": "string",
        "secondary_email": "string",
    },
    name="string",
    password="string",
    tags={
        "string": "string",
    })
Copy
const exampleuserResourceResourceFromConnectuser = new aws.connect.User("exampleuserResourceResourceFromConnectuser", {
    instanceId: "string",
    phoneConfig: {
        phoneType: "string",
        afterContactWorkTimeLimit: 0,
        autoAccept: false,
        deskPhoneNumber: "string",
    },
    routingProfileId: "string",
    securityProfileIds: ["string"],
    directoryUserId: "string",
    hierarchyGroupId: "string",
    identityInfo: {
        email: "string",
        firstName: "string",
        lastName: "string",
        secondaryEmail: "string",
    },
    name: "string",
    password: "string",
    tags: {
        string: "string",
    },
});
Copy
type: aws:connect:User
properties:
    directoryUserId: string
    hierarchyGroupId: string
    identityInfo:
        email: string
        firstName: string
        lastName: string
        secondaryEmail: string
    instanceId: string
    name: string
    password: string
    phoneConfig:
        afterContactWorkTimeLimit: 0
        autoAccept: false
        deskPhoneNumber: string
        phoneType: string
    routingProfileId: string
    securityProfileIds:
        - string
    tags:
        string: string
Copy

User Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The User resource accepts the following input properties:

InstanceId
This property is required.
Changes to this property will trigger replacement.
string
Specifies the identifier of the hosting Amazon Connect Instance.
PhoneConfig This property is required. UserPhoneConfig
A block that contains information about the phone settings for the user. Documented below.
RoutingProfileId This property is required. string
The identifier of the routing profile for the user.
SecurityProfileIds This property is required. 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.
DirectoryUserId 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.
HierarchyGroupId string
The identifier of the hierarchy group for the user.
IdentityInfo UserIdentityInfo
A block that contains information about the identity of the user. Documented below.
Name Changes to this property will trigger replacement. 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_-.\@]+.
Password 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.
Tags Dictionary<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.
InstanceId
This property is required.
Changes to this property will trigger replacement.
string
Specifies the identifier of the hosting Amazon Connect Instance.
PhoneConfig This property is required. UserPhoneConfigArgs
A block that contains information about the phone settings for the user. Documented below.
RoutingProfileId This property is required. string
The identifier of the routing profile for the user.
SecurityProfileIds This property is required. []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.
DirectoryUserId 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.
HierarchyGroupId string
The identifier of the hierarchy group for the user.
IdentityInfo UserIdentityInfoArgs
A block that contains information about the identity of the user. Documented below.
Name Changes to this property will trigger replacement. 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_-.\@]+.
Password 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.
Tags 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.
instanceId
This property is required.
Changes to this property will trigger replacement.
String
Specifies the identifier of the hosting Amazon Connect Instance.
phoneConfig This property is required. UserPhoneConfig
A block that contains information about the phone settings for the user. Documented below.
routingProfileId This property is required. String
The identifier of the routing profile for the user.
securityProfileIds This property is required. 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.
directoryUserId 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.
hierarchyGroupId String
The identifier of the hierarchy group for the user.
identityInfo UserIdentityInfo
A block that contains information about the identity of the user. Documented below.
name Changes to this property will trigger replacement. 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_-.\@]+.
password 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.
tags 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.
instanceId
This property is required.
Changes to this property will trigger replacement.
string
Specifies the identifier of the hosting Amazon Connect Instance.
phoneConfig This property is required. UserPhoneConfig
A block that contains information about the phone settings for the user. Documented below.
routingProfileId This property is required. string
The identifier of the routing profile for the user.
securityProfileIds This property is required. 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.
directoryUserId 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.
hierarchyGroupId string
The identifier of the hierarchy group for the user.
identityInfo UserIdentityInfo
A block that contains information about the identity of the user. Documented below.
name Changes to this property will trigger replacement. 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_-.\@]+.
password 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.
tags {[key: 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.
instance_id
This property is required.
Changes to this property will trigger replacement.
str
Specifies the identifier of the hosting Amazon Connect Instance.
phone_config This property is required. UserPhoneConfigArgs
A block that contains information about the phone settings for the user. Documented below.
routing_profile_id This property is required. str
The identifier of the routing profile for the user.
security_profile_ids This property is required. Sequence[str]
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.
directory_user_id str
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.
hierarchy_group_id str
The identifier of the hierarchy group for the user.
identity_info UserIdentityInfoArgs
A block that contains information about the identity of the user. Documented below.
name Changes to this property will trigger replacement. str
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_-.\@]+.
password str
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.
tags Mapping[str, str]
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.
instanceId
This property is required.
Changes to this property will trigger replacement.
String
Specifies the identifier of the hosting Amazon Connect Instance.
phoneConfig This property is required. Property Map
A block that contains information about the phone settings for the user. Documented below.
routingProfileId This property is required. String
The identifier of the routing profile for the user.
securityProfileIds This property is required. 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.
directoryUserId 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.
hierarchyGroupId String
The identifier of the hierarchy group for the user.
identityInfo Property Map
A block that contains information about the identity of the user. Documented below.
name Changes to this property will trigger replacement. 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_-.\@]+.
password 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.
tags Map<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.

Outputs

All input properties are implicitly available as output properties. Additionally, the User resource produces the following output properties:

Arn string
The Amazon Resource Name (ARN) of the user.
Id string
The provider-assigned unique ID for this managed resource.
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

UserId string
The identifier for the user.
Arn string
The Amazon Resource Name (ARN) of the user.
Id string
The provider-assigned unique ID for this managed resource.
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

UserId string
The identifier for the user.
arn String
The Amazon Resource Name (ARN) of the user.
id String
The provider-assigned unique ID for this managed resource.
tagsAll Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

userId String
The identifier for the user.
arn string
The Amazon Resource Name (ARN) of the user.
id string
The provider-assigned unique ID for this managed resource.
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

userId string
The identifier for the user.
arn str
The Amazon Resource Name (ARN) of the user.
id str
The provider-assigned unique ID for this managed resource.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

user_id str
The identifier for the user.
arn String
The Amazon Resource Name (ARN) of the user.
id String
The provider-assigned unique ID for this managed resource.
tagsAll Map<String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

userId String
The identifier for the user.

Look up Existing User Resource

Get an existing User resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: UserState, opts?: CustomResourceOptions): User
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        directory_user_id: Optional[str] = None,
        hierarchy_group_id: Optional[str] = None,
        identity_info: Optional[UserIdentityInfoArgs] = None,
        instance_id: Optional[str] = None,
        name: Optional[str] = None,
        password: Optional[str] = None,
        phone_config: Optional[UserPhoneConfigArgs] = None,
        routing_profile_id: Optional[str] = None,
        security_profile_ids: Optional[Sequence[str]] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        user_id: Optional[str] = None) -> User
func GetUser(ctx *Context, name string, id IDInput, state *UserState, opts ...ResourceOption) (*User, error)
public static User Get(string name, Input<string> id, UserState? state, CustomResourceOptions? opts = null)
public static User get(String name, Output<String> id, UserState state, CustomResourceOptions options)
resources:  _:    type: aws:connect:User    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Arn string
The Amazon Resource Name (ARN) of the user.
DirectoryUserId 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.
HierarchyGroupId string
The identifier of the hierarchy group for the user.
IdentityInfo UserIdentityInfo
A block that contains information about the identity of the user. Documented below.
InstanceId Changes to this property will trigger replacement. string
Specifies the identifier of the hosting Amazon Connect Instance.
Name Changes to this property will trigger replacement. 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_-.\@]+.
Password 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.
PhoneConfig UserPhoneConfig
A block that contains information about the phone settings for the user. Documented below.
RoutingProfileId string
The identifier of the routing profile for the user.
SecurityProfileIds 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.
Tags Dictionary<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.
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

UserId string
The identifier for the user.
Arn string
The Amazon Resource Name (ARN) of the user.
DirectoryUserId 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.
HierarchyGroupId string
The identifier of the hierarchy group for the user.
IdentityInfo UserIdentityInfoArgs
A block that contains information about the identity of the user. Documented below.
InstanceId Changes to this property will trigger replacement. string
Specifies the identifier of the hosting Amazon Connect Instance.
Name Changes to this property will trigger replacement. 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_-.\@]+.
Password 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.
PhoneConfig UserPhoneConfigArgs
A block that contains information about the phone settings for the user. Documented below.
RoutingProfileId string
The identifier of the routing profile for the user.
SecurityProfileIds []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.
Tags 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.
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

UserId string
The identifier for the user.
arn String
The Amazon Resource Name (ARN) of the user.
directoryUserId 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.
hierarchyGroupId String
The identifier of the hierarchy group for the user.
identityInfo UserIdentityInfo
A block that contains information about the identity of the user. Documented below.
instanceId Changes to this property will trigger replacement. String
Specifies the identifier of the hosting Amazon Connect Instance.
name Changes to this property will trigger replacement. 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_-.\@]+.
password 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.
phoneConfig UserPhoneConfig
A block that contains information about the phone settings for the user. Documented below.
routingProfileId String
The identifier of the routing profile for the user.
securityProfileIds 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.
tags 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.
tagsAll Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

userId String
The identifier for the user.
arn string
The Amazon Resource Name (ARN) of the user.
directoryUserId 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.
hierarchyGroupId string
The identifier of the hierarchy group for the user.
identityInfo UserIdentityInfo
A block that contains information about the identity of the user. Documented below.
instanceId Changes to this property will trigger replacement. string
Specifies the identifier of the hosting Amazon Connect Instance.
name Changes to this property will trigger replacement. 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_-.\@]+.
password 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.
phoneConfig UserPhoneConfig
A block that contains information about the phone settings for the user. Documented below.
routingProfileId string
The identifier of the routing profile for the user.
securityProfileIds 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.
tags {[key: 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.
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

userId string
The identifier for the user.
arn str
The Amazon Resource Name (ARN) of the user.
directory_user_id str
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.
hierarchy_group_id str
The identifier of the hierarchy group for the user.
identity_info UserIdentityInfoArgs
A block that contains information about the identity of the user. Documented below.
instance_id Changes to this property will trigger replacement. str
Specifies the identifier of the hosting Amazon Connect Instance.
name Changes to this property will trigger replacement. str
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_-.\@]+.
password str
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.
phone_config UserPhoneConfigArgs
A block that contains information about the phone settings for the user. Documented below.
routing_profile_id str
The identifier of the routing profile for the user.
security_profile_ids Sequence[str]
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.
tags Mapping[str, str]
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.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

user_id str
The identifier for the user.
arn String
The Amazon Resource Name (ARN) of the user.
directoryUserId 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.
hierarchyGroupId String
The identifier of the hierarchy group for the user.
identityInfo Property Map
A block that contains information about the identity of the user. Documented below.
instanceId Changes to this property will trigger replacement. String
Specifies the identifier of the hosting Amazon Connect Instance.
name Changes to this property will trigger replacement. 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_-.\@]+.
password 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.
phoneConfig Property Map
A block that contains information about the phone settings for the user. Documented below.
routingProfileId String
The identifier of the routing profile for the user.
securityProfileIds 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.
tags Map<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.
tagsAll Map<String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

userId String
The identifier for the user.

Supporting Types

UserIdentityInfo
, UserIdentityInfoArgs

Email string
The email address. If you are using SAML for identity management and include this parameter, an error is returned. Note that updates to the email is supported. From the UpdateUserIdentityInfo API documentation it is strongly recommended to limit who has the ability to invoke UpdateUserIdentityInfo. Someone with that ability can change the login credentials of other users by changing their email address. This poses a security risk to your organization. They can change the email address of a user to the attacker's email address, and then reset the password through email. For more information, see Best Practices for Security Profiles in the Amazon Connect Administrator Guide.
FirstName string
The first name. This is required if you are using Amazon Connect or SAML for identity management. Minimum length of 1. Maximum length of 100.
LastName string
The last name. This is required if you are using Amazon Connect or SAML for identity management. Minimum length of 1. Maximum length of 100.
SecondaryEmail string
The secondary email address. If present, email notifications will be sent to this email address instead of the primary one.
Email string
The email address. If you are using SAML for identity management and include this parameter, an error is returned. Note that updates to the email is supported. From the UpdateUserIdentityInfo API documentation it is strongly recommended to limit who has the ability to invoke UpdateUserIdentityInfo. Someone with that ability can change the login credentials of other users by changing their email address. This poses a security risk to your organization. They can change the email address of a user to the attacker's email address, and then reset the password through email. For more information, see Best Practices for Security Profiles in the Amazon Connect Administrator Guide.
FirstName string
The first name. This is required if you are using Amazon Connect or SAML for identity management. Minimum length of 1. Maximum length of 100.
LastName string
The last name. This is required if you are using Amazon Connect or SAML for identity management. Minimum length of 1. Maximum length of 100.
SecondaryEmail string
The secondary email address. If present, email notifications will be sent to this email address instead of the primary one.
email String
The email address. If you are using SAML for identity management and include this parameter, an error is returned. Note that updates to the email is supported. From the UpdateUserIdentityInfo API documentation it is strongly recommended to limit who has the ability to invoke UpdateUserIdentityInfo. Someone with that ability can change the login credentials of other users by changing their email address. This poses a security risk to your organization. They can change the email address of a user to the attacker's email address, and then reset the password through email. For more information, see Best Practices for Security Profiles in the Amazon Connect Administrator Guide.
firstName String
The first name. This is required if you are using Amazon Connect or SAML for identity management. Minimum length of 1. Maximum length of 100.
lastName String
The last name. This is required if you are using Amazon Connect or SAML for identity management. Minimum length of 1. Maximum length of 100.
secondaryEmail String
The secondary email address. If present, email notifications will be sent to this email address instead of the primary one.
email string
The email address. If you are using SAML for identity management and include this parameter, an error is returned. Note that updates to the email is supported. From the UpdateUserIdentityInfo API documentation it is strongly recommended to limit who has the ability to invoke UpdateUserIdentityInfo. Someone with that ability can change the login credentials of other users by changing their email address. This poses a security risk to your organization. They can change the email address of a user to the attacker's email address, and then reset the password through email. For more information, see Best Practices for Security Profiles in the Amazon Connect Administrator Guide.
firstName string
The first name. This is required if you are using Amazon Connect or SAML for identity management. Minimum length of 1. Maximum length of 100.
lastName string
The last name. This is required if you are using Amazon Connect or SAML for identity management. Minimum length of 1. Maximum length of 100.
secondaryEmail string
The secondary email address. If present, email notifications will be sent to this email address instead of the primary one.
email str
The email address. If you are using SAML for identity management and include this parameter, an error is returned. Note that updates to the email is supported. From the UpdateUserIdentityInfo API documentation it is strongly recommended to limit who has the ability to invoke UpdateUserIdentityInfo. Someone with that ability can change the login credentials of other users by changing their email address. This poses a security risk to your organization. They can change the email address of a user to the attacker's email address, and then reset the password through email. For more information, see Best Practices for Security Profiles in the Amazon Connect Administrator Guide.
first_name str
The first name. This is required if you are using Amazon Connect or SAML for identity management. Minimum length of 1. Maximum length of 100.
last_name str
The last name. This is required if you are using Amazon Connect or SAML for identity management. Minimum length of 1. Maximum length of 100.
secondary_email str
The secondary email address. If present, email notifications will be sent to this email address instead of the primary one.
email String
The email address. If you are using SAML for identity management and include this parameter, an error is returned. Note that updates to the email is supported. From the UpdateUserIdentityInfo API documentation it is strongly recommended to limit who has the ability to invoke UpdateUserIdentityInfo. Someone with that ability can change the login credentials of other users by changing their email address. This poses a security risk to your organization. They can change the email address of a user to the attacker's email address, and then reset the password through email. For more information, see Best Practices for Security Profiles in the Amazon Connect Administrator Guide.
firstName String
The first name. This is required if you are using Amazon Connect or SAML for identity management. Minimum length of 1. Maximum length of 100.
lastName String
The last name. This is required if you are using Amazon Connect or SAML for identity management. Minimum length of 1. Maximum length of 100.
secondaryEmail String
The secondary email address. If present, email notifications will be sent to this email address instead of the primary one.

UserPhoneConfig
, UserPhoneConfigArgs

PhoneType This property is required. string
The phone type. Valid values are DESK_PHONE and SOFT_PHONE.
AfterContactWorkTimeLimit int
The After Call Work (ACW) timeout setting, in seconds. Minimum value of 0.
AutoAccept bool
When Auto-Accept Call is enabled for an available agent, the agent connects to contacts automatically.
DeskPhoneNumber string
The phone number for the user's desk phone. Required if phone_type is set as DESK_PHONE.
PhoneType This property is required. string
The phone type. Valid values are DESK_PHONE and SOFT_PHONE.
AfterContactWorkTimeLimit int
The After Call Work (ACW) timeout setting, in seconds. Minimum value of 0.
AutoAccept bool
When Auto-Accept Call is enabled for an available agent, the agent connects to contacts automatically.
DeskPhoneNumber string
The phone number for the user's desk phone. Required if phone_type is set as DESK_PHONE.
phoneType This property is required. String
The phone type. Valid values are DESK_PHONE and SOFT_PHONE.
afterContactWorkTimeLimit Integer
The After Call Work (ACW) timeout setting, in seconds. Minimum value of 0.
autoAccept Boolean
When Auto-Accept Call is enabled for an available agent, the agent connects to contacts automatically.
deskPhoneNumber String
The phone number for the user's desk phone. Required if phone_type is set as DESK_PHONE.
phoneType This property is required. string
The phone type. Valid values are DESK_PHONE and SOFT_PHONE.
afterContactWorkTimeLimit number
The After Call Work (ACW) timeout setting, in seconds. Minimum value of 0.
autoAccept boolean
When Auto-Accept Call is enabled for an available agent, the agent connects to contacts automatically.
deskPhoneNumber string
The phone number for the user's desk phone. Required if phone_type is set as DESK_PHONE.
phone_type This property is required. str
The phone type. Valid values are DESK_PHONE and SOFT_PHONE.
after_contact_work_time_limit int
The After Call Work (ACW) timeout setting, in seconds. Minimum value of 0.
auto_accept bool
When Auto-Accept Call is enabled for an available agent, the agent connects to contacts automatically.
desk_phone_number str
The phone number for the user's desk phone. Required if phone_type is set as DESK_PHONE.
phoneType This property is required. String
The phone type. Valid values are DESK_PHONE and SOFT_PHONE.
afterContactWorkTimeLimit Number
The After Call Work (ACW) timeout setting, in seconds. Minimum value of 0.
autoAccept Boolean
When Auto-Accept Call is enabled for an available agent, the agent connects to contacts automatically.
deskPhoneNumber String
The phone number for the user's desk phone. Required if phone_type is set as DESK_PHONE.

Import

Using pulumi import, import Amazon Connect Users using the instance_id and user_id separated by a colon (:). For example:

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

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws