aws-cdk-lib.aws_connect

AWS::Connect Construct Library

This module is part of the AWS Cloud Development Kit project.

import * as connect from 'aws-cdk-lib/aws-connect';

import aws_cdk.aws_connect as connect

import software.amazon.awscdk.services.connect.*;

using Amazon.CDK.AWS.Connect;

import connect "github.com/aws/aws-cdk-go/awscdk"

There are no official hand-written (L2) constructs for this service yet. Here are some suggestions on how to proceed:

• Search Construct Hub for Connect construct libraries
• Use the automatically generated L1 constructs, in the same way you would use the CloudFormation AWS::Connect resources directly.

There are no hand-written (L2) constructs for this service yet. However, you can still use the automatically generated L1 constructs, and use this service exactly as you would using CloudFormation directly.

For more information on the resources and properties available for this service, see the CloudFormation documentation for AWS::Connect.

(Read the CDK Contributing Guide and submit an RFC if you are interested in contributing to this construct library.)

Types

Name	Kind	Summary
CfnAgentStatus	Construct (L1)	Contains information about an agent status.
CfnApprovedOrigin	Construct (L1)	The approved origin for the instance.
CfnContactFlow	Construct (L1)	Specifies a flow for an Connect Customer instance.
CfnContactFlowModule	Construct (L1)	Specifies a flow module for an Connect Customer instance.
CfnContactFlowModuleAlias	Construct (L1)	Resource Type definition for ContactFlowModuleAlias.
CfnContactFlowModuleVersion	Construct (L1)	Resource Type definition for ContactFlowModuleVersion.
CfnContactFlowVersion	Construct (L1)	Creates a version for the specified customer-managed flow within the specified instance.
CfnDataLakeAssociation	Construct (L1)	Resource schema for AWS::Connect::DataLakeAssociation.
CfnDataTable	Construct (L1)	Represents a data table in Amazon Connect.
CfnDataTableAttribute	Construct (L1)	Represents an attribute (column) in a data table.
CfnDataTableRecord	Construct (L1)	Resource Type definition for AWS::Connect::DataTableRecord.
CfnEmailAddress	Construct (L1)	Create new email address in the specified Amazon Connect instance.
CfnEvaluationForm	Construct (L1)	Creates an evaluation form for the specified Connect Customer instance.
CfnHoursOfOperation	Construct (L1)	Specifies hours of operation.
CfnInstance	Construct (L1)	This is a preview release for Connect Customer . It is subject to change..
CfnInstanceStorageConfig	Construct (L1)	The storage configuration for the instance.
CfnIntegrationAssociation	Construct (L1)	Specifies the association of an AWS resource such as Lex bot (both v1 and v2) and Lambda function with an Connect Customer instance.
CfnMetric	Construct (L1)	Resource Type definition for AWS::Connect::Metric, a custom metric configured for an Amazon Connect instance.
CfnNotification	Construct (L1)	Resource Type definition for AWS::Connect::Notification.
CfnPhoneNumber	Construct (L1)	Claims a phone number to the specified Connect Customer instance or traffic distribution group.
CfnPredefinedAttribute	Construct (L1)	Textual or numeric value that describes an attribute.
CfnPrompt	Construct (L1)	Creates a prompt for the specified Connect Customer instance.
CfnQueue	Construct (L1)	Contains information about a queue.
CfnQuickConnect	Construct (L1)	Specifies a quick connect for an Connect Customer instance.
CfnRoutingProfile	Construct (L1)	Creates a new routing profile.
CfnRule	Construct (L1)	Creates a rule for the specified Connect Customer instance.
CfnSecurityKey	Construct (L1)	The security key for the instance.
CfnSecurityProfile	Construct (L1)	Creates a security profile.
CfnTaskTemplate	Construct (L1)	Specifies a task template for a Connect Customer instance.
CfnTestCase	Construct (L1)	Resource Type definition for AWS::Connect::TestCase.
CfnTrafficDistributionGroup	Construct (L1)	Information about a traffic distribution group.
CfnUseCase	Construct (L1)	Resource Type definition for a use case associated with an Amazon Connect integration association.
CfnUser	Construct (L1)	Specifies a user account for an Connect Customer instance.
CfnUserHierarchyGroup	Construct (L1)	Specifies a new user hierarchy group.
CfnUserHierarchyStructure	Construct (L1)	Contains information about a hierarchy structure.
CfnView	Construct (L1)	Creates a customer-managed view in the published state within the specified instance.
CfnViewVersion	Construct (L1)	Creates a version for the specified customer-managed view within the specified instance.
CfnVocabulary	Construct (L1)	Resource type definition for AWS::Connect::Vocabulary.
CfnWorkspace	Construct (L1)	Contains information about a workspace, which defines the user experience by mapping views to pages.
CfnAgentStatusProps	Struct	Properties for defining a CfnAgentStatus.
CfnApprovedOriginProps	Struct	Properties for defining a CfnApprovedOrigin.
CfnContactFlowModule.ExternalInvocationConfigurationProperty	Struct	The external invocation configuration for the flow module.
CfnContactFlowModuleAliasProps	Struct	Properties for defining a CfnContactFlowModuleAlias.
CfnContactFlowModuleProps	Struct	Properties for defining a CfnContactFlowModule.
CfnContactFlowModuleVersionProps	Struct	Properties for defining a CfnContactFlowModuleVersion.
CfnContactFlowProps	Struct	Properties for defining a CfnContactFlow.
CfnContactFlowVersionProps	Struct	Properties for defining a CfnContactFlowVersion.
CfnDataLakeAssociationProps	Struct	Properties for defining a CfnDataLakeAssociation.
CfnDataTable.LockVersionProperty	Struct	The lock version of the Data Table.
CfnDataTableAttribute.EnumProperty	Struct
CfnDataTableAttribute.LockVersionProperty	Struct
CfnDataTableAttribute.ValidationProperty	Struct	Defines validation rules for data table attribute values.
CfnDataTableAttributeProps	Struct	Properties for defining a CfnDataTableAttribute.
CfnDataTableProps	Struct	Properties for defining a CfnDataTable.
CfnDataTableRecord.DataTableRecordProperty	Struct
CfnDataTableRecord.ValueProperty	Struct
CfnDataTableRecordProps	Struct	Properties for defining a CfnDataTableRecord.
CfnEmailAddress.AliasConfigurationProperty	Struct	Configuration information of an email alias.
CfnEmailAddressProps	Struct	Properties for defining a CfnEmailAddress.
CfnEvaluationForm.AutoEvaluationConfigurationProperty	Struct	Configuration information about automated evaluations.
CfnEvaluationForm.AutomaticFailConfigurationProperty	Struct	Information about automatic fail configuration for an evaluation form.
CfnEvaluationForm.EvaluationFormBaseItemProperty	Struct	An item at the root level.
CfnEvaluationForm.EvaluationFormItemEnablementConditionOperandProperty	Struct	An operand of the enablement condition.
CfnEvaluationForm.EvaluationFormItemEnablementConditionProperty	Struct	A condition for item enablement.
CfnEvaluationForm.EvaluationFormItemEnablementConfigurationProperty	Struct	An item enablement configuration.
CfnEvaluationForm.EvaluationFormItemEnablementExpressionProperty	Struct	An expression that defines a basic building block of conditional enablement.
CfnEvaluationForm.EvaluationFormItemEnablementSourceProperty	Struct	An enablement expression source item.
CfnEvaluationForm.EvaluationFormItemEnablementSourceValueProperty	Struct	An enablement expression source value.
CfnEvaluationForm.EvaluationFormItemProperty	Struct	Items that are part of the evaluation form.
CfnEvaluationForm.EvaluationFormLanguageConfigurationProperty	Struct	Language configuration for an evaluation form.
CfnEvaluationForm.EvaluationFormMetricConfigurationProperty	Struct	Information about the metric configuration for an evaluation form question.
CfnEvaluationForm.EvaluationFormMultiSelectQuestionAutomationOptionProperty	Struct	An automation option for a multi-select question.
CfnEvaluationForm.EvaluationFormMultiSelectQuestionAutomationProperty	Struct	Automation configuration for multi-select questions.
CfnEvaluationForm.EvaluationFormMultiSelectQuestionOptionProperty	Struct	An option for a multi-select question in an evaluation form.
CfnEvaluationForm.EvaluationFormMultiSelectQuestionPropertiesProperty	Struct	Properties for a multi-select question in an evaluation form.
CfnEvaluationForm.EvaluationFormNumericQuestionAutomationProperty	Struct	Information about the automation configuration in numeric questions.
CfnEvaluationForm.EvaluationFormNumericQuestionOptionProperty	Struct	Information about the option range used for scoring in numeric questions.
CfnEvaluationForm.EvaluationFormNumericQuestionPropertiesProperty	Struct	Information about properties for a numeric question in an evaluation form.
CfnEvaluationForm.EvaluationFormQuestionAutomationAnswerSourceProperty	Struct	A question automation answer.
CfnEvaluationForm.EvaluationFormQuestionProperty	Struct	Information about a question from an evaluation form.
CfnEvaluationForm.EvaluationFormQuestionScoringConfigurationProperty	Struct	Scoring configuration for a question in an evaluation form.
CfnEvaluationForm.EvaluationFormQuestionTypePropertiesProperty	Struct	Information about properties for a question in an evaluation form.
CfnEvaluationForm.EvaluationFormScoreThresholdProperty	Struct	Information about a score threshold for a performance category.
CfnEvaluationForm.EvaluationFormSectionProperty	Struct	Information about a section from an evaluation form.
CfnEvaluationForm.EvaluationFormSingleSelectQuestionAutomationOptionProperty	Struct	The automation options of the single select question.
CfnEvaluationForm.EvaluationFormSingleSelectQuestionAutomationProperty	Struct	Information about the automation configuration in single select questions.
CfnEvaluationForm.EvaluationFormSingleSelectQuestionOptionProperty	Struct	Information about the automation configuration in single select questions.
CfnEvaluationForm.EvaluationFormSingleSelectQuestionPropertiesProperty	Struct	Information about the options in single select questions.
CfnEvaluationForm.EvaluationFormTargetConfigurationProperty	Struct	Configuration that specifies the target for an evaluation form.
CfnEvaluationForm.EvaluationFormTextQuestionAutomationProperty	Struct	Information about the automation configuration in text questions.
CfnEvaluationForm.EvaluationFormTextQuestionPropertiesProperty	Struct	Information about properties for a text question in an evaluation form.
CfnEvaluationForm.EvaluationReviewConfigurationProperty	Struct	Configuration settings for evaluation reviews.
CfnEvaluationForm.EvaluationReviewNotificationRecipientProperty	Struct	Information about a recipient who should be notified when an evaluation review is requested.
CfnEvaluationForm.EvaluationReviewNotificationRecipientValueProperty	Struct	The value information for an evaluation review notification recipient.
CfnEvaluationForm.MultiSelectQuestionRuleCategoryAutomationProperty	Struct	Automation rule for multi-select questions based on rule categories.
CfnEvaluationForm.NumericQuestionPropertyValueAutomationProperty	Struct	Information about the property value used in automation of a numeric questions.
CfnEvaluationForm.QuestionOptionPointsConfigurationProperty	Struct	Information about the points configuration for an answer option.
CfnEvaluationForm.QuestionPointsConfigurationProperty	Struct	Information about the points configuration for a question.
CfnEvaluationForm.ScoringStrategyProperty	Struct	A scoring strategy of the evaluation form.
CfnEvaluationForm.SingleSelectQuestionRuleCategoryAutomationProperty	Struct	Information about the automation option based on a rule category for a single select question.
CfnEvaluationFormProps	Struct	Properties for defining a CfnEvaluationForm.
CfnHoursOfOperation.HoursOfOperationConfigProperty	Struct	Contains information about the hours of operation.
CfnHoursOfOperation.HoursOfOperationOverrideConfigProperty	Struct	Information about the hours of operation override config: day, start time, and end time.
CfnHoursOfOperation.HoursOfOperationOverrideProperty	Struct	Information about the hours of operations override.
CfnHoursOfOperation.HoursOfOperationsIdentifierProperty	Struct	Identifier for hours of operation.
CfnHoursOfOperation.HoursOfOperationTimeSliceProperty	Struct	The start time or end time for an hours of operation.
CfnHoursOfOperation.OverrideTimeSliceProperty	Struct	The start time or end time for an hours of operation override.
CfnHoursOfOperation.RecurrenceConfigProperty	Struct	Configuration for recurring hours of operation overrides.
CfnHoursOfOperation.RecurrencePatternProperty	Struct	Pattern for recurring hours of operation overrides.
CfnHoursOfOperationProps	Struct	Properties for defining a CfnHoursOfOperation.
CfnInstance.AttributesProperty	Struct	*This is a preview release for Connect Customer .
CfnInstanceProps	Struct	Properties for defining a CfnInstance.
CfnInstanceStorageConfig.EncryptionConfigProperty	Struct	The encryption configuration.
CfnInstanceStorageConfig.KinesisFirehoseConfigProperty	Struct	Configuration information of a Kinesis Data Firehose delivery stream.
CfnInstanceStorageConfig.KinesisStreamConfigProperty	Struct	Configuration information of a Kinesis data stream.
CfnInstanceStorageConfig.KinesisVideoStreamConfigProperty	Struct	Configuration information of a Kinesis video stream.
CfnInstanceStorageConfig.S3ConfigProperty	Struct	Information about the Amazon Simple Storage Service (Amazon S3) storage type.
CfnInstanceStorageConfigProps	Struct	Properties for defining a CfnInstanceStorageConfig.
CfnIntegrationAssociationProps	Struct	Properties for defining a CfnIntegrationAssociation.
CfnMetric.AvailableFilterProperty	Struct
CfnMetric.CalculationComponentProperty	Struct
CfnMetric.CreatedByInfoProperty	Struct
CfnMetric.MetricCalculationProperty	Struct	The calculation configuration for the metric.
CfnMetric.MetricFilterBooleanConditionProperty	Struct
CfnMetric.MetricFilterNumberConditionProperty	Struct
CfnMetric.MetricFilterProperty	Struct
CfnMetric.MetricFilterStringConditionProperty	Struct
CfnMetricProps	Struct	Properties for defining a CfnMetric.
CfnNotification.NotificationContentProperty	Struct	The content of a notification.
CfnNotificationProps	Struct	Properties for defining a CfnNotification.
CfnPhoneNumberProps	Struct	Properties for defining a CfnPhoneNumber.
CfnPredefinedAttribute.AttributeConfigurationProperty	Struct	Custom metadata associated to a Predefined attribute that controls how the attribute behaves when used by upstream services.
CfnPredefinedAttribute.ValuesProperty	Struct	The values of a predefined attribute.
CfnPredefinedAttributeProps	Struct	Properties for defining a CfnPredefinedAttribute.
CfnPromptProps	Struct	Properties for defining a CfnPrompt.
CfnQueue.EmailAddressProperty	Struct	An email address configuration for the queue.
CfnQueue.OutboundCallerConfigProperty	Struct	The outbound caller ID name, number, and outbound whisper flow.
CfnQueue.OutboundEmailConfigProperty	Struct	The outbound email address ID.
CfnQueueProps	Struct	Properties for defining a CfnQueue.
CfnQuickConnect.FlowQuickConnectConfigProperty	Struct	The flow configuration.
CfnQuickConnect.PhoneNumberQuickConnectConfigProperty	Struct	Contains information about a phone number for a quick connect.
CfnQuickConnect.QueueQuickConnectConfigProperty	Struct	Contains information about a queue for a quick connect.
CfnQuickConnect.QuickConnectConfigProperty	Struct	Contains configuration settings for a quick connect.
CfnQuickConnect.UserQuickConnectConfigProperty	Struct	Contains information about the quick connect configuration settings for a user.
CfnQuickConnectProps	Struct	Properties for defining a CfnQuickConnect.
CfnRoutingProfile.CrossChannelBehaviorProperty	Struct	Defines the cross-channel routing behavior that allows an agent working on a contact in one channel to be offered a contact from a different channel.
CfnRoutingProfile.MediaConcurrencyProperty	Struct	Contains information about which channels are supported, and how many contacts an agent can have on a channel simultaneously.
CfnRoutingProfile.RoutingProfileManualAssignmentQueueConfigProperty	Struct	Contains information about the queue and channel for manual assignment behaviour can be enabled.
CfnRoutingProfile.RoutingProfileQueueConfigProperty	Struct	Contains information about the queue and channel for which priority and delay can be set.
CfnRoutingProfile.RoutingProfileQueueReferenceProperty	Struct	Contains the channel and queue identifier for a routing profile.
CfnRoutingProfileProps	Struct	Properties for defining a CfnRoutingProfile.
CfnRule.ActionsProperty	Struct	A list of actions to be run when the rule is triggered.
CfnRule.AssignSlaActionProperty	Struct
CfnRule.CaseSlaConfigurationProperty	Struct
CfnRule.CreateCaseActionProperty	Struct
CfnRule.EventBridgeActionProperty	Struct	The EventBridge action definition.
CfnRule.FieldProperty	Struct
CfnRule.FieldValueProperty	Struct	Object for case field values.
CfnRule.NotificationRecipientTypeProperty	Struct	The type of notification recipient.
CfnRule.ReferenceProperty	Struct	Information about the reference when the referenceType is URL .
CfnRule.RuleTriggerEventSourceProperty	Struct	The name of the event source.
CfnRule.SendNotificationActionProperty	Struct	Information about the send notification action.
CfnRule.SlaTargetFieldValueProperty	Struct
CfnRule.SubmitAutoEvaluationActionProperty	Struct
CfnRule.TaskActionProperty	Struct	Information about the task action.
CfnRule.UpdateCaseActionProperty	Struct
CfnRuleProps	Struct	Properties for defining a CfnRule.
CfnSecurityKeyProps	Struct	Properties for defining a CfnSecurityKey.
CfnSecurityProfile.ApplicationProperty	Struct	This API is in preview release for Amazon Connect and is subject to change.
CfnSecurityProfile.DataTableAccessControlConfigurationProperty	Struct	A data table access control configuration.
CfnSecurityProfile.FlowModuleProperty	Struct	A first-party application's metadata.
CfnSecurityProfile.GranularAccessControlConfigurationProperty	Struct	Contains granular access control configuration for security profiles, including data table access permissions.
CfnSecurityProfile.PrimaryAttributeAccessControlConfigurationItemProperty	Struct	A primary attribute access control configuration item.
CfnSecurityProfile.PrimaryAttributeValueProperty	Struct	A primary attribute value.
CfnSecurityProfileProps	Struct	Properties for defining a CfnSecurityProfile.
CfnTaskTemplate.ConstraintsProperty	Struct	Describes constraints that apply to the template fields.
CfnTaskTemplate.DefaultFieldValueProperty	Struct	Describes a default field and its corresponding value.
CfnTaskTemplate.FieldIdentifierProperty	Struct	The identifier of the task template field.
CfnTaskTemplate.FieldProperty	Struct	Describes a single task template field.
CfnTaskTemplate.InvisibleFieldInfoProperty	Struct	A field that is invisible to an agent.
CfnTaskTemplate.ReadOnlyFieldInfoProperty	Struct	Indicates a field that is read-only to an agent.
CfnTaskTemplate.RequiredFieldInfoProperty	Struct	Information about a required field.
CfnTaskTemplateProps	Struct	Properties for defining a CfnTaskTemplate.
CfnTestCase.ChatEntryPointParametersProperty	Struct	The chat entry point parameters for the test case.
CfnTestCase.EntryPointProperty	Struct	The Entry Point associated with the test case.
CfnTestCase.VoiceCallEntryPointParametersProperty	Struct	The voice call entry point parameters for the test case.
CfnTestCaseProps	Struct	Properties for defining a CfnTestCase.
CfnTrafficDistributionGroupProps	Struct	Properties for defining a CfnTrafficDistributionGroup.
CfnUseCaseProps	Struct	Properties for defining a CfnUseCase.
CfnUser.AfterContactWorkConfigPerChannelProperty	Struct	After Contact Work configuration per channel.
CfnUser.AfterContactWorkConfigProperty	Struct	After Contact Work configuration.
CfnUser.AutoAcceptConfigProperty	Struct	Auto-accept configuration per channel.
CfnUser.PersistentConnectionConfigProperty	Struct	Persistent Connection configuration per channel.
CfnUser.PhoneNumberConfigProperty	Struct	Phone Number configuration per channel.
CfnUser.UserIdentityInfoProperty	Struct	Contains information about the identity of a user.
CfnUser.UserPhoneConfigProperty	Struct	Contains information about the phone configuration settings for a user.
CfnUser.UserProficiencyProperty	Struct	> A predefined attribute must be created before using UserProficiencies in the Cloudformation User template.
CfnUser.VoiceEnhancementConfigProperty	Struct	Voice Enhancement configuration per channel.
CfnUserHierarchyGroupProps	Struct	Properties for defining a CfnUserHierarchyGroup.
CfnUserHierarchyStructure.LevelFiveProperty	Struct	The update for level five.
CfnUserHierarchyStructure.LevelFourProperty	Struct	The update for level four.
CfnUserHierarchyStructure.LevelOneProperty	Struct	Information about level one.
CfnUserHierarchyStructure.LevelThreeProperty	Struct	The update for level three.
CfnUserHierarchyStructure.LevelTwoProperty	Struct	The update for level two.
CfnUserHierarchyStructure.UserHierarchyStructureProperty	Struct	Contains information about a hierarchy structure.
CfnUserHierarchyStructureProps	Struct	Properties for defining a CfnUserHierarchyStructure.
CfnUserProps	Struct	Properties for defining a CfnUser.
CfnViewProps	Struct	Properties for defining a CfnView.
CfnViewVersionProps	Struct	Properties for defining a CfnViewVersion.
CfnVocabularyProps	Struct	Properties for defining a CfnVocabulary.
CfnWorkspace.FontFamilyProperty	Struct	Contains font family configuration for workspace themes.
CfnWorkspace.MediaItemProperty	Struct	Contains information about a media asset used in a workspace.
CfnWorkspace.PaletteCanvasProperty	Struct	Contains color configuration for canvas elements in a workspace theme.
CfnWorkspace.PaletteHeaderProperty	Struct	Contains color configuration for header elements in a workspace theme.
CfnWorkspace.PaletteNavigationProperty	Struct	Contains color configuration for navigation elements in a workspace theme.
CfnWorkspace.PalettePrimaryProperty	Struct	Contains primary color configuration for a workspace theme.
CfnWorkspace.WorkspacePageProperty	Struct	Contains information about a page configuration in a workspace, including the view assigned to the page.
CfnWorkspace.WorkspaceThemeConfigProperty	Struct	Contains detailed theme configuration for a workspace, including colors, images, and typography.
CfnWorkspace.WorkspaceThemePaletteProperty	Struct	Contains color palette configuration for different areas of a workspace.
CfnWorkspace.WorkspaceThemeProperty	Struct	Contains theme configuration for a workspace, supporting both light and dark modes.
CfnWorkspace.WorkspaceThemeTypographyProperty	Struct	Contains typography configuration for a workspace theme.
CfnWorkspaceProps	Struct	Properties for defining a CfnWorkspace.