awsconnect

package
v2.10.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 29, 2022 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CfnContactFlowModule_CFN_RESOURCE_TYPE_NAME added in v2.2.0 

func CfnContactFlowModule_CFN_RESOURCE_TYPE_NAME() *string

func CfnContactFlowModule_IsCfnElement added in v2.2.0 

func CfnContactFlowModule_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnContactFlowModule_IsCfnResource added in v2.2.0 

func CfnContactFlowModule_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnContactFlowModule_IsConstruct added in v2.2.0 

func CfnContactFlowModule_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnContactFlow_CFN_RESOURCE_TYPE_NAME added in v2.2.0 

func CfnContactFlow_CFN_RESOURCE_TYPE_NAME() *string

func CfnContactFlow_IsCfnElement added in v2.2.0 

func CfnContactFlow_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnContactFlow_IsCfnResource added in v2.2.0 

func CfnContactFlow_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnContactFlow_IsConstruct added in v2.2.0 

func CfnContactFlow_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnHoursOfOperation_CFN_RESOURCE_TYPE_NAME 

func CfnHoursOfOperation_CFN_RESOURCE_TYPE_NAME() *string

func CfnHoursOfOperation_IsCfnElement 

func CfnHoursOfOperation_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnHoursOfOperation_IsCfnResource 

func CfnHoursOfOperation_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnHoursOfOperation_IsConstruct 

func CfnHoursOfOperation_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnQuickConnect_CFN_RESOURCE_TYPE_NAME 

func CfnQuickConnect_CFN_RESOURCE_TYPE_NAME() *string

func CfnQuickConnect_IsCfnElement 

func CfnQuickConnect_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnQuickConnect_IsCfnResource 

func CfnQuickConnect_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnQuickConnect_IsConstruct 

func CfnQuickConnect_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnUserHierarchyGroup_CFN_RESOURCE_TYPE_NAME 

func CfnUserHierarchyGroup_CFN_RESOURCE_TYPE_NAME() *string

func CfnUserHierarchyGroup_IsCfnElement 

func CfnUserHierarchyGroup_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnUserHierarchyGroup_IsCfnResource 

func CfnUserHierarchyGroup_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnUserHierarchyGroup_IsConstruct 

func CfnUserHierarchyGroup_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnUser_CFN_RESOURCE_TYPE_NAME 

func CfnUser_CFN_RESOURCE_TYPE_NAME() *string

func CfnUser_IsCfnElement 

func CfnUser_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnUser_IsCfnResource 

func CfnUser_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnUser_IsConstruct 

func CfnUser_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func NewCfnContactFlowModule_Override added in v2.2.0 

func NewCfnContactFlowModule_Override(c CfnContactFlowModule, scope constructs.Construct, id *string, props *CfnContactFlowModuleProps)

Create a new `AWS::Connect::ContactFlowModule`.

func NewCfnContactFlow_Override added in v2.2.0 

func NewCfnContactFlow_Override(c CfnContactFlow, scope constructs.Construct, id *string, props *CfnContactFlowProps)

Create a new `AWS::Connect::ContactFlow`.

func NewCfnHoursOfOperation_Override 

func NewCfnHoursOfOperation_Override(c CfnHoursOfOperation, scope constructs.Construct, id *string, props *CfnHoursOfOperationProps)

Create a new `AWS::Connect::HoursOfOperation`.

func NewCfnQuickConnect_Override 

func NewCfnQuickConnect_Override(c CfnQuickConnect, scope constructs.Construct, id *string, props *CfnQuickConnectProps)

Create a new `AWS::Connect::QuickConnect`.

func NewCfnUserHierarchyGroup_Override 

func NewCfnUserHierarchyGroup_Override(c CfnUserHierarchyGroup, scope constructs.Construct, id *string, props *CfnUserHierarchyGroupProps)

Create a new `AWS::Connect::UserHierarchyGroup`.

func NewCfnUser_Override 

func NewCfnUser_Override(c CfnUser, scope constructs.Construct, id *string, props *CfnUserProps)

Create a new `AWS::Connect::User`.

Types

type CfnContactFlow added in v2.2.0 

type CfnContactFlow interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrContactFlowArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	Content() *string
	SetContent(val *string)
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	InstanceArn() *string
	SetInstanceArn(val *string)
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	State() *string
	SetState(val *string)
	Tags() awscdk.TagManager
	Type() *string
	SetType(val *string)
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Connect::ContactFlow`.

The `AWS::Connect::ContactFlow` resource specifies a contact flow for the specified Amazon Connect instance.

TODO: EXAMPLE

func NewCfnContactFlow added in v2.2.0 

func NewCfnContactFlow(scope constructs.Construct, id *string, props *CfnContactFlowProps) CfnContactFlow

Create a new `AWS::Connect::ContactFlow`.

type CfnContactFlowModule added in v2.2.0 

type CfnContactFlowModule interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrContactFlowModuleArn() *string
	AttrStatus() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	Content() *string
	SetContent(val *string)
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	InstanceArn() *string
	SetInstanceArn(val *string)
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	State() *string
	SetState(val *string)
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Connect::ContactFlowModule`.

The `AWS::Connect::ContactFlowModule` resource specifies a contact flow module for the specified Amazon Connect instance.

TODO: EXAMPLE

func NewCfnContactFlowModule added in v2.2.0 

func NewCfnContactFlowModule(scope constructs.Construct, id *string, props *CfnContactFlowModuleProps) CfnContactFlowModule

Create a new `AWS::Connect::ContactFlowModule`.

type CfnContactFlowModuleProps added in v2.2.0 

type CfnContactFlowModuleProps struct {
	// The content of the contact flow module.
	Content *string `json:"content" yaml:"content"`
	// The Amazon Resource Name (ARN) of the Amazon Connect instance.
	InstanceArn *string `json:"instanceArn" yaml:"instanceArn"`
	// The name of the contact flow module.
	Name *string `json:"name" yaml:"name"`
	// The description of the contact flow module.
	Description *string `json:"description" yaml:"description"`
	// The state of the contact flow module.
	State *string `json:"state" yaml:"state"`
	// An array of key-value pairs to apply to this resource.
	//
	// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnContactFlowModule`.

TODO: EXAMPLE

type CfnContactFlowProps added in v2.2.0 

type CfnContactFlowProps struct {
	// The content of the contact flow.
	Content *string `json:"content" yaml:"content"`
	// The Amazon Resource Name (ARN) of the Amazon Connect instance.
	InstanceArn *string `json:"instanceArn" yaml:"instanceArn"`
	// The name of the contact flow.
	Name *string `json:"name" yaml:"name"`
	// The description of the contact flow.
	Description *string `json:"description" yaml:"description"`
	// The state of the contact flow.
	State *string `json:"state" yaml:"state"`
	// An array of key-value pairs to apply to this resource.
	//
	// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
	// The type of the contact flow.
	//
	// For descriptions of the available types, see [Choose a Contact Flow Type](https://docs.aws.amazon.com/connect/latest/adminguide/create-contact-flow.html#contact-flow-types) in the *Amazon Connect Administrator Guide* .
	Type *string `json:"type" yaml:"type"`
}

Properties for defining a `CfnContactFlow`.

TODO: EXAMPLE

type CfnHoursOfOperation 

type CfnHoursOfOperation interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrHoursOfOperationArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	Config() interface{}
	SetConfig(val interface{})
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	InstanceArn() *string
	SetInstanceArn(val *string)
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	TimeZone() *string
	SetTimeZone(val *string)
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Connect::HoursOfOperation`.

Creates hours of operation.

TODO: EXAMPLE

func NewCfnHoursOfOperation 

func NewCfnHoursOfOperation(scope constructs.Construct, id *string, props *CfnHoursOfOperationProps) CfnHoursOfOperation

Create a new `AWS::Connect::HoursOfOperation`.

type CfnHoursOfOperationProps 

type CfnHoursOfOperationProps struct {
	// Configuration information for the hours of operation.
	Config interface{} `json:"config" yaml:"config"`
	// The Amazon Resource Name (ARN) for the instance.
	InstanceArn *string `json:"instanceArn" yaml:"instanceArn"`
	// The name for the hours of operation.
	Name *string `json:"name" yaml:"name"`
	// The time zone for the hours of operation.
	TimeZone *string `json:"timeZone" yaml:"timeZone"`
	// The description for the hours of operation.
	Description *string `json:"description" yaml:"description"`
	// The tags used to organize, track, or control access for this resource.
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnHoursOfOperation`.

TODO: EXAMPLE

type CfnHoursOfOperation_HoursOfOperationConfigProperty 

type CfnHoursOfOperation_HoursOfOperationConfigProperty struct {
	// The day that the hours of operation applies to.
	Day *string `json:"day" yaml:"day"`
	// The end time that your contact center closes.
	EndTime interface{} `json:"endTime" yaml:"endTime"`
	// The start time that your contact center opens.
	StartTime interface{} `json:"startTime" yaml:"startTime"`
}

Contains information about the hours of operation.

TODO: EXAMPLE

type CfnHoursOfOperation_HoursOfOperationTimeSliceProperty 

type CfnHoursOfOperation_HoursOfOperationTimeSliceProperty struct {
	// The hours.
	Hours *float64 `json:"hours" yaml:"hours"`
	// The minutes.
	Minutes *float64 `json:"minutes" yaml:"minutes"`
}

The start time or end time for an hours of operation.

TODO: EXAMPLE

type CfnQuickConnect 

type CfnQuickConnect interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrQuickConnectArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	InstanceArn() *string
	SetInstanceArn(val *string)
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() constructs.Node
	QuickConnectConfig() interface{}
	SetQuickConnectConfig(val interface{})
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Connect::QuickConnect`.

The `AWS::Connect::QuickConnnect` resource specifies a quick connect for the specified Amazon Connect instance.

TODO: EXAMPLE

func NewCfnQuickConnect 

func NewCfnQuickConnect(scope constructs.Construct, id *string, props *CfnQuickConnectProps) CfnQuickConnect

Create a new `AWS::Connect::QuickConnect`.

type CfnQuickConnectProps 

type CfnQuickConnectProps struct {
	// The Amazon Resource Name (ARN) of the instance.
	InstanceArn *string `json:"instanceArn" yaml:"instanceArn"`
	// The name of the quick connect.
	Name *string `json:"name" yaml:"name"`
	// Contains information about the quick connect.
	QuickConnectConfig interface{} `json:"quickConnectConfig" yaml:"quickConnectConfig"`
	// The description of the quick connect.
	Description *string `json:"description" yaml:"description"`
	// The tags used to organize, track, or control access for this resource.
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnQuickConnect`.

TODO: EXAMPLE

type CfnQuickConnect_PhoneNumberQuickConnectConfigProperty 

type CfnQuickConnect_PhoneNumberQuickConnectConfigProperty struct {
	// The phone number in E.164 format.
	PhoneNumber *string `json:"phoneNumber" yaml:"phoneNumber"`
}

Contains information about a phone number for a quick connect.

TODO: EXAMPLE

type CfnQuickConnect_QueueQuickConnectConfigProperty 

type CfnQuickConnect_QueueQuickConnectConfigProperty struct {
	// The Amazon Resource Name (ARN) of the contact flow.
	ContactFlowArn *string `json:"contactFlowArn" yaml:"contactFlowArn"`
	// The Amazon Resource Name (ARN) of the queue.
	QueueArn *string `json:"queueArn" yaml:"queueArn"`
}

Contains information about a queue for a quick connect.

The contact flow must be of type Transfer to Queue.

TODO: EXAMPLE

type CfnQuickConnect_QuickConnectConfigProperty 

type CfnQuickConnect_QuickConnectConfigProperty struct {
	// The type of quick connect.
	//
	// In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).
	QuickConnectType *string `json:"quickConnectType" yaml:"quickConnectType"`
	// The phone configuration.
	//
	// This is required only if QuickConnectType is PHONE_NUMBER.
	PhoneConfig interface{} `json:"phoneConfig" yaml:"phoneConfig"`
	// The queue configuration.
	//
	// This is required only if QuickConnectType is QUEUE.
	QueueConfig interface{} `json:"queueConfig" yaml:"queueConfig"`
	// The user configuration.
	//
	// This is required only if QuickConnectType is USER.
	UserConfig interface{} `json:"userConfig" yaml:"userConfig"`
}

Contains configuration settings for a quick connect.

TODO: EXAMPLE

type CfnQuickConnect_UserQuickConnectConfigProperty 

type CfnQuickConnect_UserQuickConnectConfigProperty struct {
	// The Amazon Resource Name (ARN) of the contact flow.
	ContactFlowArn *string `json:"contactFlowArn" yaml:"contactFlowArn"`
	// The Amazon Resource Name (ARN) of the user.
	UserArn *string `json:"userArn" yaml:"userArn"`
}

Contains information about the quick connect configuration settings for a user.

The contact flow must be of type Transfer to Agent.

TODO: EXAMPLE

type CfnUser 

type CfnUser interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrUserArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	DirectoryUserId() *string
	SetDirectoryUserId(val *string)
	HierarchyGroupArn() *string
	SetHierarchyGroupArn(val *string)
	IdentityInfo() interface{}
	SetIdentityInfo(val interface{})
	InstanceArn() *string
	SetInstanceArn(val *string)
	LogicalId() *string
	Node() constructs.Node
	Password() *string
	SetPassword(val *string)
	PhoneConfig() interface{}
	SetPhoneConfig(val interface{})
	Ref() *string
	RoutingProfileArn() *string
	SetRoutingProfileArn(val *string)
	SecurityProfileArns() *[]*string
	SetSecurityProfileArns(val *[]*string)
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	Username() *string
	SetUsername(val *string)
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Connect::User`.

Creates a user account for the specified Amazon Connect instance.

For information about how to create user accounts using the Amazon Connect console, see [Add Users](https://docs.aws.amazon.com/connect/latest/adminguide/user-management.html) in the *Amazon Connect Administrator Guide* .

TODO: EXAMPLE

func NewCfnUser 

func NewCfnUser(scope constructs.Construct, id *string, props *CfnUserProps) CfnUser

Create a new `AWS::Connect::User`.

type CfnUserHierarchyGroup 

type CfnUserHierarchyGroup interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrUserHierarchyGroupArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	InstanceArn() *string
	SetInstanceArn(val *string)
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() constructs.Node
	ParentGroupArn() *string
	SetParentGroupArn(val *string)
	Ref() *string
	Stack() awscdk.Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Connect::UserHierarchyGroup`.

Creates a new user hierarchy group.

TODO: EXAMPLE

func NewCfnUserHierarchyGroup 

func NewCfnUserHierarchyGroup(scope constructs.Construct, id *string, props *CfnUserHierarchyGroupProps) CfnUserHierarchyGroup

Create a new `AWS::Connect::UserHierarchyGroup`.

type CfnUserHierarchyGroupProps 

type CfnUserHierarchyGroupProps struct {
	// The Amazon Resource Name (ARN) of the user hierarchy group.
	InstanceArn *string `json:"instanceArn" yaml:"instanceArn"`
	// The name of the user hierarchy group.
	Name *string `json:"name" yaml:"name"`
	// The Amazon Resource Name (ARN) of the parent group.
	ParentGroupArn *string `json:"parentGroupArn" yaml:"parentGroupArn"`
}

Properties for defining a `CfnUserHierarchyGroup`.

TODO: EXAMPLE

type CfnUserProps 

type CfnUserProps struct {
	// The Amazon Resource Name (ARN) of the instance.
	InstanceArn *string `json:"instanceArn" yaml:"instanceArn"`
	// Information about the phone configuration for the user.
	PhoneConfig interface{} `json:"phoneConfig" yaml:"phoneConfig"`
	// The Amazon Resource Name (ARN) of the user's routing profile.
	RoutingProfileArn *string `json:"routingProfileArn" yaml:"routingProfileArn"`
	// The Amazon Resource Name (ARN) of the user's security profile.
	SecurityProfileArns *[]*string `json:"securityProfileArns" yaml:"securityProfileArns"`
	// The user name assigned to the user account.
	Username *string `json:"username" yaml:"username"`
	// The identifier of the user account in the directory used for identity management.
	DirectoryUserId *string `json:"directoryUserId" yaml:"directoryUserId"`
	// The Amazon Resource Name (ARN) of the user's hierarchy group.
	HierarchyGroupArn *string `json:"hierarchyGroupArn" yaml:"hierarchyGroupArn"`
	// Information about the user identity.
	IdentityInfo interface{} `json:"identityInfo" yaml:"identityInfo"`
	// The user's password.
	Password *string `json:"password" yaml:"password"`
	// The tags.
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnUser`.

TODO: EXAMPLE

type CfnUser_UserIdentityInfoProperty 

type CfnUser_UserIdentityInfoProperty struct {
	// The email address.
	//
	// If you are using SAML for identity management and include this parameter, an error is returned.
	Email *string `json:"email" yaml:"email"`
	// The first name.
	//
	// This is required if you are using Amazon Connect or SAML for identity management.
	FirstName *string `json:"firstName" yaml:"firstName"`
	// The last name.
	//
	// This is required if you are using Amazon Connect or SAML for identity management.
	LastName *string `json:"lastName" yaml:"lastName"`
}

Contains information about the identity of a user.

TODO: EXAMPLE

type CfnUser_UserPhoneConfigProperty 

type CfnUser_UserPhoneConfigProperty struct {
	// The phone type.
	PhoneType *string `json:"phoneType" yaml:"phoneType"`
	// The After Call Work (ACW) timeout setting, in seconds.
	AfterContactWorkTimeLimit *float64 `json:"afterContactWorkTimeLimit" yaml:"afterContactWorkTimeLimit"`
	// The Auto accept setting.
	AutoAccept interface{} `json:"autoAccept" yaml:"autoAccept"`
	// The phone number for the user's desk phone.
	DeskPhoneNumber *string `json:"deskPhoneNumber" yaml:"deskPhoneNumber"`
}

Contains information about the phone configuration settings for a user.

TODO: EXAMPLE

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.