Docs Packages
  1. Packages
  2. AWS Classic
  3. API Docs
  4. connect
  5. User

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.13.2 published on Thursday, Dec 7, 2023 by Pulumi
pulumi/pulumi-aws

aws.connect.User

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.13.2 published on Thursday, Dec 7, 2023 by Pulumi
pulumi/pulumi-aws

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

    Example Usage

    Basic

    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 = aws_connect_instance.Example.Id,
        Password = "Password123",
        RoutingProfileId = aws_connect_routing_profile.Example.Routing_profile_id,
        SecurityProfileIds = new[]
        {
            aws_connect_security_profile.Example.Security_profile_id,
        },
        IdentityInfo = new Aws.Connect.Inputs.UserIdentityInfoArgs
        {
            FirstName = "example",
            LastName = "example2",
        },
        PhoneConfig = new Aws.Connect.Inputs.UserPhoneConfigArgs
        {
            AfterContactWorkTimeLimit = 0,
            PhoneType = "SOFT_PHONE",
        },
    });

});

    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(aws_connect_instance.Example.Id),
			Password:         pulumi.String("Password123"),
			RoutingProfileId: pulumi.Any(aws_connect_routing_profile.Example.Routing_profile_id),
			SecurityProfileIds: pulumi.StringArray{
				aws_connect_security_profile.Example.Security_profile_id,
			},
			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
	})
}

    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());

    }
}

    import pulumi
import pulumi_aws as aws

example = aws.connect.User("example",
    instance_id=aws_connect_instance["example"]["id"],
    password="Password123",
    routing_profile_id=aws_connect_routing_profile["example"]["routing_profile_id"],
    security_profile_ids=[aws_connect_security_profile["example"]["security_profile_id"]],
    identity_info=aws.connect.UserIdentityInfoArgs(
        first_name="example",
        last_name="example2",
    ),
    phone_config=aws.connect.UserPhoneConfigArgs(
        after_contact_work_time_limit=0,
        phone_type="SOFT_PHONE",
    ))

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

const example = new aws.connect.User("example", {
    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: {
        firstName: "example",
        lastName: "example2",
    },
    phoneConfig: {
        afterContactWorkTimeLimit: 0,
        phoneType: "SOFT_PHONE",
    },
});

    resources:
  example:
    type: aws:connect:User
    properties:
      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:
        firstName: example
        lastName: example2
      phoneConfig:
        afterContactWorkTimeLimit: 0
        phoneType: SOFT_PHONE

    With hierarchy_group_id

    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 = 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 = new[]
        {
            aws_connect_security_profile.Example.Security_profile_id,
        },
        IdentityInfo = new Aws.Connect.Inputs.UserIdentityInfoArgs
        {
            FirstName = "example",
            LastName = "example2",
        },
        PhoneConfig = new Aws.Connect.Inputs.UserPhoneConfigArgs
        {
            AfterContactWorkTimeLimit = 0,
            PhoneType = "SOFT_PHONE",
        },
    });

});

    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(aws_connect_instance.Example.Id),
			Password:         pulumi.String("Password123"),
			RoutingProfileId: pulumi.Any(aws_connect_routing_profile.Example.Routing_profile_id),
			HierarchyGroupId: pulumi.Any(aws_connect_user_hierarchy_group.Example.Hierarchy_group_id),
			SecurityProfileIds: pulumi.StringArray{
				aws_connect_security_profile.Example.Security_profile_id,
			},
			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
	})
}

    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());

    }
}

    import pulumi
import pulumi_aws as aws

example = aws.connect.User("example",
    instance_id=aws_connect_instance["example"]["id"],
    password="Password123",
    routing_profile_id=aws_connect_routing_profile["example"]["routing_profile_id"],
    hierarchy_group_id=aws_connect_user_hierarchy_group["example"]["hierarchy_group_id"],
    security_profile_ids=[aws_connect_security_profile["example"]["security_profile_id"]],
    identity_info=aws.connect.UserIdentityInfoArgs(
        first_name="example",
        last_name="example2",
    ),
    phone_config=aws.connect.UserPhoneConfigArgs(
        after_contact_work_time_limit=0,
        phone_type="SOFT_PHONE",
    ))

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

const example = new aws.connect.User("example", {
    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: {
        firstName: "example",
        lastName: "example2",
    },
    phoneConfig: {
        afterContactWorkTimeLimit: 0,
        phoneType: "SOFT_PHONE",
    },
});

    resources:
  example:
    type: aws:connect:User
    properties:
      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:
        firstName: example
        lastName: example2
      phoneConfig:
        afterContactWorkTimeLimit: 0
        phoneType: SOFT_PHONE

    With identity_info filled

    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 = aws_connect_instance.Example.Id,
        Password = "Password123",
        RoutingProfileId = aws_connect_routing_profile.Example.Routing_profile_id,
        SecurityProfileIds = new[]
        {
            aws_connect_security_profile.Example.Security_profile_id,
        },
        IdentityInfo = new Aws.Connect.Inputs.UserIdentityInfoArgs
        {
            Email = "example@example.com",
            FirstName = "example",
            LastName = "example2",
        },
        PhoneConfig = new Aws.Connect.Inputs.UserPhoneConfigArgs
        {
            AfterContactWorkTimeLimit = 0,
            PhoneType = "SOFT_PHONE",
        },
    });

});

    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(aws_connect_instance.Example.Id),
			Password:         pulumi.String("Password123"),
			RoutingProfileId: pulumi.Any(aws_connect_routing_profile.Example.Routing_profile_id),
			SecurityProfileIds: pulumi.StringArray{
				aws_connect_security_profile.Example.Security_profile_id,
			},
			IdentityInfo: &connect.UserIdentityInfoArgs{
				Email:     pulumi.String("example@example.com"),
				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
	})
}

    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());

    }
}

    import pulumi
import pulumi_aws as aws

example = aws.connect.User("example",
    instance_id=aws_connect_instance["example"]["id"],
    password="Password123",
    routing_profile_id=aws_connect_routing_profile["example"]["routing_profile_id"],
    security_profile_ids=[aws_connect_security_profile["example"]["security_profile_id"]],
    identity_info=aws.connect.UserIdentityInfoArgs(
        email="example@example.com",
        first_name="example",
        last_name="example2",
    ),
    phone_config=aws.connect.UserPhoneConfigArgs(
        after_contact_work_time_limit=0,
        phone_type="SOFT_PHONE",
    ))

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

const example = new aws.connect.User("example", {
    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: {
        email: "example@example.com",
        firstName: "example",
        lastName: "example2",
    },
    phoneConfig: {
        afterContactWorkTimeLimit: 0,
        phoneType: "SOFT_PHONE",
    },
});

    resources:
  example:
    type: aws:connect:User
    properties:
      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:
        email: example@example.com
        firstName: example
        lastName: example2
      phoneConfig:
        afterContactWorkTimeLimit: 0
        phoneType: SOFT_PHONE

    With phone_config phone type as desk phone

    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 = aws_connect_instance.Example.Id,
        Password = "Password123",
        RoutingProfileId = aws_connect_routing_profile.Example.Routing_profile_id,
        SecurityProfileIds = new[]
        {
            aws_connect_security_profile.Example.Security_profile_id,
        },
        PhoneConfig = new Aws.Connect.Inputs.UserPhoneConfigArgs
        {
            AfterContactWorkTimeLimit = 0,
            PhoneType = "SOFT_PHONE",
        },
    });

});

    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(aws_connect_instance.Example.Id),
			Password:         pulumi.String("Password123"),
			RoutingProfileId: pulumi.Any(aws_connect_routing_profile.Example.Routing_profile_id),
			SecurityProfileIds: pulumi.StringArray{
				aws_connect_security_profile.Example.Security_profile_id,
			},
			PhoneConfig: &connect.UserPhoneConfigArgs{
				AfterContactWorkTimeLimit: pulumi.Int(0),
				PhoneType:                 pulumi.String("SOFT_PHONE"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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());

    }
}

    import pulumi
import pulumi_aws as aws

example = aws.connect.User("example",
    instance_id=aws_connect_instance["example"]["id"],
    password="Password123",
    routing_profile_id=aws_connect_routing_profile["example"]["routing_profile_id"],
    security_profile_ids=[aws_connect_security_profile["example"]["security_profile_id"]],
    phone_config=aws.connect.UserPhoneConfigArgs(
        after_contact_work_time_limit=0,
        phone_type="SOFT_PHONE",
    ))

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

const example = new aws.connect.User("example", {
    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: {
        afterContactWorkTimeLimit: 0,
        phoneType: "SOFT_PHONE",
    },
});

    resources:
  example:
    type: aws:connect:User
    properties:
      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:
        afterContactWorkTimeLimit: 0
        phoneType: SOFT_PHONE

    With multiple Security profile ids specified in security_profile_ids

    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 = aws_connect_instance.Example.Id,
        Password = "Password123",
        RoutingProfileId = aws_connect_routing_profile.Example.Routing_profile_id,
        SecurityProfileIds = new[]
        {
            aws_connect_security_profile.Example.Security_profile_id,
            aws_connect_security_profile.Example2.Security_profile_id,
        },
        PhoneConfig = new Aws.Connect.Inputs.UserPhoneConfigArgs
        {
            AfterContactWorkTimeLimit = 0,
            AutoAccept = false,
            DeskPhoneNumber = "+112345678912",
            PhoneType = "DESK_PHONE",
        },
    });

});

    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(aws_connect_instance.Example.Id),
			Password:         pulumi.String("Password123"),
			RoutingProfileId: pulumi.Any(aws_connect_routing_profile.Example.Routing_profile_id),
			SecurityProfileIds: pulumi.StringArray{
				aws_connect_security_profile.Example.Security_profile_id,
				aws_connect_security_profile.Example2.Security_profile_id,
			},
			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
	})
}

    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());

    }
}

    import pulumi
import pulumi_aws as aws

example = aws.connect.User("example",
    instance_id=aws_connect_instance["example"]["id"],
    password="Password123",
    routing_profile_id=aws_connect_routing_profile["example"]["routing_profile_id"],
    security_profile_ids=[
        aws_connect_security_profile["example"]["security_profile_id"],
        aws_connect_security_profile["example2"]["security_profile_id"],
    ],
    phone_config=aws.connect.UserPhoneConfigArgs(
        after_contact_work_time_limit=0,
        auto_accept=False,
        desk_phone_number="+112345678912",
        phone_type="DESK_PHONE",
    ))

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

const example = new aws.connect.User("example", {
    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: {
        afterContactWorkTimeLimit: 0,
        autoAccept: false,
        deskPhoneNumber: "+112345678912",
        phoneType: "DESK_PHONE",
    },
});

    resources:
  example:
    type: aws:connect:User
    properties:
      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:
        afterContactWorkTimeLimit: 0
        autoAccept: false
        deskPhoneNumber: '+112345678912'
        phoneType: DESK_PHONE

    Create User Resource

    new User(name: string, args: UserArgs, opts?: CustomResourceOptions);
    @overload
def User(resource_name: str,
         opts: Optional[ResourceOptions] = 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)
@overload
def User(resource_name: str,
         args: UserArgs,
         opts: Optional[ResourceOptions] = 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.
    name string
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args 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 string
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    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

    The User resource accepts the following input properties:

    InstanceId string

    Specifies the identifier of the hosting Amazon Connect Instance.

    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.

    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 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 string

    Specifies the identifier of the hosting Amazon Connect Instance.

    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.

    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 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 String

    Specifies the identifier of the hosting Amazon Connect Instance.

    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.

    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 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 string

    Specifies the identifier of the hosting Amazon Connect Instance.

    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.

    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 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 str

    Specifies the identifier of the hosting Amazon Connect Instance.

    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.

    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 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 String

    Specifies the identifier of the hosting Amazon Connect Instance.

    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.

    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 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)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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 string

    Specifies the identifier of the hosting Amazon Connect Instance.

    Name 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 string

    Specifies the identifier of the hosting Amazon Connect Instance.

    Name 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 String

    Specifies the identifier of the hosting Amazon Connect Instance.

    name 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 string

    Specifies the identifier of the hosting Amazon Connect Instance.

    name 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 str

    Specifies the identifier of the hosting Amazon Connect Instance.

    name 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 String

    Specifies the identifier of the hosting Amazon Connect Instance.

    name 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.

    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.

    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.

    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.

    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.

    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.

    UserPhoneConfig, UserPhoneConfigArgs

    PhoneType 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 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 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 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 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 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

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the aws Terraform Provider.

    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.13.2 published on Thursday, Dec 7, 2023 by Pulumi
    pulumi/pulumi-aws