Class CfnUser
A CloudFormation AWS::Connect::User
.
Inherited Members
Namespace: Amazon.CDK.AWS.Connect
Assembly: Amazon.CDK.AWS.Connect.dll
Syntax (csharp)
public class CfnUser : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnUser
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Specifies a user account for an Amazon Connect instance.
For information about how to create user accounts using the Amazon Connect console, see Add Users in the Amazon Connect Administrator Guide .
CloudformationResource: AWS::Connect::User
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-user.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Connect;
var cfnUser = new CfnUser(this, "MyCfnUser", new CfnUserProps {
InstanceArn = "instanceArn",
PhoneConfig = new UserPhoneConfigProperty {
PhoneType = "phoneType",
// the properties below are optional
AfterContactWorkTimeLimit = 123,
AutoAccept = false,
DeskPhoneNumber = "deskPhoneNumber"
},
RoutingProfileArn = "routingProfileArn",
SecurityProfileArns = new [] { "securityProfileArns" },
Username = "username",
// the properties below are optional
DirectoryUserId = "directoryUserId",
HierarchyGroupArn = "hierarchyGroupArn",
IdentityInfo = new UserIdentityInfoProperty {
Email = "email",
FirstName = "firstName",
LastName = "lastName",
Mobile = "mobile",
SecondaryEmail = "secondaryEmail"
},
Password = "password",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnUser(Construct, String, ICfnUserProps) | Create a new |
CfnUser(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnUser(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrUserArn | The Amazon Resource Name (ARN) of the user. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DirectoryUserId | The identifier of the user account in the directory used for identity management. |
HierarchyGroupArn | The Amazon Resource Name (ARN) of the user's hierarchy group. |
IdentityInfo | Information about the user identity. |
InstanceArn | The Amazon Resource Name (ARN) of the instance. |
Password | The user's password. |
PhoneConfig | Information about the phone configuration for the user. |
RoutingProfileArn | The Amazon Resource Name (ARN) of the user's routing profile. |
SecurityProfileArns | The Amazon Resource Name (ARN) of the user's security profile. |
Tags | The tags. |
Username | The user name assigned to the user account. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnUser(Construct, String, ICfnUserProps)
Create a new AWS::Connect::User
.
public CfnUser(Construct scope, string id, ICfnUserProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnUserProps
- resource properties.
CfnUser(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnUser(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnUser(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnUser(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrUserArn
The Amazon Resource Name (ARN) of the user.
public virtual string AttrUserArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: UserArn
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
DirectoryUserId
The identifier of the user account in the directory used for identity management.
public virtual string DirectoryUserId { get; set; }
Property Value
System.String
Remarks
HierarchyGroupArn
The Amazon Resource Name (ARN) of the user's hierarchy group.
public virtual string HierarchyGroupArn { get; set; }
Property Value
System.String
Remarks
IdentityInfo
Information about the user identity.
public virtual object IdentityInfo { get; set; }
Property Value
System.Object
Remarks
InstanceArn
The Amazon Resource Name (ARN) of the instance.
public virtual string InstanceArn { get; set; }
Property Value
System.String
Remarks
Password
The user's password.
public virtual string Password { get; set; }
Property Value
System.String
Remarks
PhoneConfig
Information about the phone configuration for the user.
public virtual object PhoneConfig { get; set; }
Property Value
System.Object
Remarks
RoutingProfileArn
The Amazon Resource Name (ARN) of the user's routing profile.
public virtual string RoutingProfileArn { get; set; }
Property Value
System.String
Remarks
SecurityProfileArns
The Amazon Resource Name (ARN) of the user's security profile.
public virtual string[] SecurityProfileArns { get; set; }
Property Value
System.String[]
Remarks
Tags
The tags.
public virtual TagManager Tags { get; }
Property Value
Remarks
Username
The user name assigned to the user account.
public virtual string Username { get; set; }
Property Value
System.String
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>