# API Reference
## Constructs
### AppInstanceStreamingConfigurations
#### Initializers
```typescript
import { AppInstanceStreamingConfigurations } from 'cdk-amazon-chime-resources'
new AppInstanceStreamingConfigurations(scope: Construct, id: string, props: StreamingConfigurationProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`scope`](#cdkamazonchimeresourcesappinstancestreamingconfigurationsparameterscope)* | [`constructs.Construct`](#constructs.Construct) | *No description.* |
| [`id`](#cdkamazonchimeresourcesappinstancestreamingconfigurationsparameterid)* | `string` | *No description.* |
| [`props`](#cdkamazonchimeresourcesappinstancestreamingconfigurationsparameterprops)* | [`cdk-amazon-chime-resources.StreamingConfigurationProps`](#cdk-amazon-chime-resources.StreamingConfigurationProps) | *No description.* |
---
##### `scope`Required
- *Type:* [`constructs.Construct`](#constructs.Construct)
---
##### `id`Required
- *Type:* `string`
---
##### `props`Required
- *Type:* [`cdk-amazon-chime-resources.StreamingConfigurationProps`](#cdk-amazon-chime-resources.StreamingConfigurationProps)
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`streamingConfigs`](#cdkamazonchimeresourcesappinstancestreamingconfigurationspropertystreamingconfigs)* | [`cdk-amazon-chime-resources.StreamingConfig`](#cdk-amazon-chime-resources.StreamingConfig)[] | *No description.* |
---
##### `streamingConfigs`Required
```typescript
public readonly streamingConfigs: StreamingConfig[];
```
- *Type:* [`cdk-amazon-chime-resources.StreamingConfig`](#cdk-amazon-chime-resources.StreamingConfig)[]
---
### ChannelFlow
#### Initializers
```typescript
import { ChannelFlow } from 'cdk-amazon-chime-resources'
new ChannelFlow(scope: Construct, id: string, props: ChannelFlowProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`scope`](#cdkamazonchimeresourceschannelflowparameterscope)* | [`constructs.Construct`](#constructs.Construct) | *No description.* |
| [`id`](#cdkamazonchimeresourceschannelflowparameterid)* | `string` | *No description.* |
| [`props`](#cdkamazonchimeresourceschannelflowparameterprops)* | [`cdk-amazon-chime-resources.ChannelFlowProps`](#cdk-amazon-chime-resources.ChannelFlowProps) | *No description.* |
---
##### `scope`Required
- *Type:* [`constructs.Construct`](#constructs.Construct)
---
##### `id`Required
- *Type:* `string`
---
##### `props`Required
- *Type:* [`cdk-amazon-chime-resources.ChannelFlowProps`](#cdk-amazon-chime-resources.ChannelFlowProps)
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`channelFlowArn`](#cdkamazonchimeresourceschannelflowpropertychannelflowarn)* | `string` | *No description.* |
---
##### `channelFlowArn`Required
```typescript
public readonly channelFlowArn: string;
```
- *Type:* `string`
---
### ChimePhoneNumber
#### Initializers
```typescript
import { ChimePhoneNumber } from 'cdk-amazon-chime-resources'
new ChimePhoneNumber(scope: Construct, id: string, props: PhoneNumberProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`scope`](#cdkamazonchimeresourceschimephonenumberparameterscope)* | [`constructs.Construct`](#constructs.Construct) | *No description.* |
| [`id`](#cdkamazonchimeresourceschimephonenumberparameterid)* | `string` | *No description.* |
| [`props`](#cdkamazonchimeresourceschimephonenumberparameterprops)* | [`cdk-amazon-chime-resources.PhoneNumberProps`](#cdk-amazon-chime-resources.PhoneNumberProps) | *No description.* |
---
##### `scope`Required
- *Type:* [`constructs.Construct`](#constructs.Construct)
---
##### `id`Required
- *Type:* `string`
---
##### `props`Required
- *Type:* [`cdk-amazon-chime-resources.PhoneNumberProps`](#cdk-amazon-chime-resources.PhoneNumberProps)
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| [`associateWithVoiceConnector`](#cdkamazonchimeresourceschimephonenumberassociatewithvoiceconnector) | *No description.* |
---
##### `associateWithVoiceConnector`
```typescript
public associateWithVoiceConnector(voiceConnectorId: ChimeVoiceConnector)
```
###### `voiceConnectorId`Required
- *Type:* [`cdk-amazon-chime-resources.ChimeVoiceConnector`](#cdk-amazon-chime-resources.ChimeVoiceConnector)
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`phoneNumber`](#cdkamazonchimeresourceschimephonenumberpropertyphonenumber)* | `string` | *No description.* |
---
##### `phoneNumber`Required
```typescript
public readonly phoneNumber: string;
```
- *Type:* `string`
---
### ChimeSipMediaApp
#### Initializers
```typescript
import { ChimeSipMediaApp } from 'cdk-amazon-chime-resources'
new ChimeSipMediaApp(scope: Construct, id: string, props: SipMediaAppProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`scope`](#cdkamazonchimeresourceschimesipmediaappparameterscope)* | [`constructs.Construct`](#constructs.Construct) | *No description.* |
| [`id`](#cdkamazonchimeresourceschimesipmediaappparameterid)* | `string` | *No description.* |
| [`props`](#cdkamazonchimeresourceschimesipmediaappparameterprops)* | [`cdk-amazon-chime-resources.SipMediaAppProps`](#cdk-amazon-chime-resources.SipMediaAppProps) | *No description.* |
---
##### `scope`Required
- *Type:* [`constructs.Construct`](#constructs.Construct)
---
##### `id`Required
- *Type:* `string`
---
##### `props`Required
- *Type:* [`cdk-amazon-chime-resources.SipMediaAppProps`](#cdk-amazon-chime-resources.SipMediaAppProps)
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| [`alexaSkill`](#cdkamazonchimeresourceschimesipmediaappalexaskill) | *No description.* |
| [`logging`](#cdkamazonchimeresourceschimesipmediaapplogging) | *No description.* |
---
##### `alexaSkill`
```typescript
public alexaSkill(sipMediaApplicationAlexaSkillConfiguration: SipMediaApplicationAlexaSkillConfiguration)
```
###### `sipMediaApplicationAlexaSkillConfiguration`Required
- *Type:* [`cdk-amazon-chime-resources.SipMediaApplicationAlexaSkillConfiguration`](#cdk-amazon-chime-resources.SipMediaApplicationAlexaSkillConfiguration)
---
##### `logging`
```typescript
public logging(sipMediaApplicationLoggingConfiguration: SipMediaApplicationLoggingConfiguration)
```
###### `sipMediaApplicationLoggingConfiguration`Required
- *Type:* [`cdk-amazon-chime-resources.SipMediaApplicationLoggingConfiguration`](#cdk-amazon-chime-resources.SipMediaApplicationLoggingConfiguration)
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`sipMediaAppId`](#cdkamazonchimeresourceschimesipmediaapppropertysipmediaappid)* | `string` | *No description.* |
---
##### `sipMediaAppId`Required
```typescript
public readonly sipMediaAppId: string;
```
- *Type:* `string`
---
### ChimeSipRule
#### Initializers
```typescript
import { ChimeSipRule } from 'cdk-amazon-chime-resources'
new ChimeSipRule(scope: Construct, id: string, props: SipRuleProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`scope`](#cdkamazonchimeresourceschimesipruleparameterscope)* | [`constructs.Construct`](#constructs.Construct) | *No description.* |
| [`id`](#cdkamazonchimeresourceschimesipruleparameterid)* | `string` | *No description.* |
| [`props`](#cdkamazonchimeresourceschimesipruleparameterprops)* | [`cdk-amazon-chime-resources.SipRuleProps`](#cdk-amazon-chime-resources.SipRuleProps) | *No description.* |
---
##### `scope`Required
- *Type:* [`constructs.Construct`](#constructs.Construct)
---
##### `id`Required
- *Type:* `string`
---
##### `props`Required
- *Type:* [`cdk-amazon-chime-resources.SipRuleProps`](#cdk-amazon-chime-resources.SipRuleProps)
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`sipRuleId`](#cdkamazonchimeresourceschimesiprulepropertysipruleid)* | `string` | *No description.* |
---
##### `sipRuleId`Required
```typescript
public readonly sipRuleId: string;
```
- *Type:* `string`
---
### ChimeVoiceConnector
#### Initializers
```typescript
import { ChimeVoiceConnector } from 'cdk-amazon-chime-resources'
new ChimeVoiceConnector(scope: Construct, id: string, props: VoiceConnectorProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`scope`](#cdkamazonchimeresourceschimevoiceconnectorparameterscope)* | [`constructs.Construct`](#constructs.Construct) | *No description.* |
| [`id`](#cdkamazonchimeresourceschimevoiceconnectorparameterid)* | `string` | *No description.* |
| [`props`](#cdkamazonchimeresourceschimevoiceconnectorparameterprops)* | [`cdk-amazon-chime-resources.VoiceConnectorProps`](#cdk-amazon-chime-resources.VoiceConnectorProps) | *No description.* |
---
##### `scope`Required
- *Type:* [`constructs.Construct`](#constructs.Construct)
---
##### `id`Required
- *Type:* `string`
---
##### `props`Required
- *Type:* [`cdk-amazon-chime-resources.VoiceConnectorProps`](#cdk-amazon-chime-resources.VoiceConnectorProps)
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`voiceConnectorId`](#cdkamazonchimeresourceschimevoiceconnectorpropertyvoiceconnectorid)* | `string` | *No description.* |
---
##### `voiceConnectorId`Required
```typescript
public readonly voiceConnectorId: string;
```
- *Type:* `string`
---
### ChimeVoiceProfileDomain
#### Initializers
```typescript
import { ChimeVoiceProfileDomain } from 'cdk-amazon-chime-resources'
new ChimeVoiceProfileDomain(scope: Construct, id: string, props: VoiceProfileDomainProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`scope`](#cdkamazonchimeresourceschimevoiceprofiledomainparameterscope)* | [`constructs.Construct`](#constructs.Construct) | *No description.* |
| [`id`](#cdkamazonchimeresourceschimevoiceprofiledomainparameterid)* | `string` | *No description.* |
| [`props`](#cdkamazonchimeresourceschimevoiceprofiledomainparameterprops)* | [`cdk-amazon-chime-resources.VoiceProfileDomainProps`](#cdk-amazon-chime-resources.VoiceProfileDomainProps) | *No description.* |
---
##### `scope`Required
- *Type:* [`constructs.Construct`](#constructs.Construct)
---
##### `id`Required
- *Type:* `string`
---
##### `props`Required
- *Type:* [`cdk-amazon-chime-resources.VoiceProfileDomainProps`](#cdk-amazon-chime-resources.VoiceProfileDomainProps)
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`voiceProfileDomainArn`](#cdkamazonchimeresourceschimevoiceprofiledomainpropertyvoiceprofiledomainarn)* | `string` | *No description.* |
| [`voiceProfileDomainId`](#cdkamazonchimeresourceschimevoiceprofiledomainpropertyvoiceprofiledomainid)* | `string` | *No description.* |
| [`voiceProfileDomainName`](#cdkamazonchimeresourceschimevoiceprofiledomainpropertyvoiceprofiledomainname)* | `string` | *No description.* |
---
##### `voiceProfileDomainArn`Required
```typescript
public readonly voiceProfileDomainArn: string;
```
- *Type:* `string`
---
##### `voiceProfileDomainId`Required
```typescript
public readonly voiceProfileDomainId: string;
```
- *Type:* `string`
---
##### `voiceProfileDomainName`Required
```typescript
public readonly voiceProfileDomainName: string;
```
- *Type:* `string`
---
### MediaInsightsPipeline
#### Initializers
```typescript
import { MediaInsightsPipeline } from 'cdk-amazon-chime-resources'
new MediaInsightsPipeline(scope: Construct, id: string, props: MediaInsightsPipelineProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`scope`](#cdkamazonchimeresourcesmediainsightspipelineparameterscope)* | [`constructs.Construct`](#constructs.Construct) | *No description.* |
| [`id`](#cdkamazonchimeresourcesmediainsightspipelineparameterid)* | `string` | *No description.* |
| [`props`](#cdkamazonchimeresourcesmediainsightspipelineparameterprops)* | [`cdk-amazon-chime-resources.MediaInsightsPipelineProps`](#cdk-amazon-chime-resources.MediaInsightsPipelineProps) | *No description.* |
---
##### `scope`Required
- *Type:* [`constructs.Construct`](#constructs.Construct)
---
##### `id`Required
- *Type:* `string`
---
##### `props`Required
- *Type:* [`cdk-amazon-chime-resources.MediaInsightsPipelineProps`](#cdk-amazon-chime-resources.MediaInsightsPipelineProps)
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`mediaInsightsPipelineConfigurationArn`](#cdkamazonchimeresourcesmediainsightspipelinepropertymediainsightspipelineconfigurationarn)* | `string` | *No description.* |
| [`mediaInsightsPipelineConfigurationId`](#cdkamazonchimeresourcesmediainsightspipelinepropertymediainsightspipelineconfigurationid)* | `string` | *No description.* |
| [`mediaInsightsPipelineConfigurationName`](#cdkamazonchimeresourcesmediainsightspipelinepropertymediainsightspipelineconfigurationname)* | `string` | *No description.* |
---
##### `mediaInsightsPipelineConfigurationArn`Required
```typescript
public readonly mediaInsightsPipelineConfigurationArn: string;
```
- *Type:* `string`
---
##### `mediaInsightsPipelineConfigurationId`Required
```typescript
public readonly mediaInsightsPipelineConfigurationId: string;
```
- *Type:* `string`
---
##### `mediaInsightsPipelineConfigurationName`Required
```typescript
public readonly mediaInsightsPipelineConfigurationName: string;
```
- *Type:* `string`
---
### MessagingAppInstance
#### Initializers
```typescript
import { MessagingAppInstance } from 'cdk-amazon-chime-resources'
new MessagingAppInstance(scope: Construct, id: string, props: AppInstanceProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`scope`](#cdkamazonchimeresourcesmessagingappinstanceparameterscope)* | [`constructs.Construct`](#constructs.Construct) | *No description.* |
| [`id`](#cdkamazonchimeresourcesmessagingappinstanceparameterid)* | `string` | *No description.* |
| [`props`](#cdkamazonchimeresourcesmessagingappinstanceparameterprops)* | [`cdk-amazon-chime-resources.AppInstanceProps`](#cdk-amazon-chime-resources.AppInstanceProps) | *No description.* |
---
##### `scope`Required
- *Type:* [`constructs.Construct`](#constructs.Construct)
---
##### `id`Required
- *Type:* `string`
---
##### `props`Required
- *Type:* [`cdk-amazon-chime-resources.AppInstanceProps`](#cdk-amazon-chime-resources.AppInstanceProps)
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| [`retention`](#cdkamazonchimeresourcesmessagingappinstanceretention) | *No description.* |
| [`streaming`](#cdkamazonchimeresourcesmessagingappinstancestreaming) | *No description.* |
---
##### `retention`
```typescript
public retention(days: number)
```
###### `days`Required
- *Type:* `number`
---
##### `streaming`
```typescript
public streaming(streamingConfigs: StreamingConfig[])
```
###### `streamingConfigs`Required
- *Type:* [`cdk-amazon-chime-resources.StreamingConfig`](#cdk-amazon-chime-resources.StreamingConfig)[]
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`appInstanceArn`](#cdkamazonchimeresourcesmessagingappinstancepropertyappinstancearn)* | `string` | *No description.* |
---
##### `appInstanceArn`Required
```typescript
public readonly appInstanceArn: string;
```
- *Type:* `string`
---
### MessagingAppInstanceAdmin
#### Initializers
```typescript
import { MessagingAppInstanceAdmin } from 'cdk-amazon-chime-resources'
new MessagingAppInstanceAdmin(scope: Construct, id: string, props: AppInstanceAdminProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`scope`](#cdkamazonchimeresourcesmessagingappinstanceadminparameterscope)* | [`constructs.Construct`](#constructs.Construct) | *No description.* |
| [`id`](#cdkamazonchimeresourcesmessagingappinstanceadminparameterid)* | `string` | *No description.* |
| [`props`](#cdkamazonchimeresourcesmessagingappinstanceadminparameterprops)* | [`cdk-amazon-chime-resources.AppInstanceAdminProps`](#cdk-amazon-chime-resources.AppInstanceAdminProps) | *No description.* |
---
##### `scope`Required
- *Type:* [`constructs.Construct`](#constructs.Construct)
---
##### `id`Required
- *Type:* `string`
---
##### `props`Required
- *Type:* [`cdk-amazon-chime-resources.AppInstanceAdminProps`](#cdk-amazon-chime-resources.AppInstanceAdminProps)
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`appInstanceAdminArn`](#cdkamazonchimeresourcesmessagingappinstanceadminpropertyappinstanceadminarn)* | `string` | *No description.* |
| [`appInstanceAdminName`](#cdkamazonchimeresourcesmessagingappinstanceadminpropertyappinstanceadminname)* | `string` | *No description.* |
---
##### `appInstanceAdminArn`Required
```typescript
public readonly appInstanceAdminArn: string;
```
- *Type:* `string`
---
##### `appInstanceAdminName`Required
```typescript
public readonly appInstanceAdminName: string;
```
- *Type:* `string`
---
### MessagingAppInstanceBot
#### Initializers
```typescript
import { MessagingAppInstanceBot } from 'cdk-amazon-chime-resources'
new MessagingAppInstanceBot(scope: Construct, id: string, props: AppInstanceBotProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`scope`](#cdkamazonchimeresourcesmessagingappinstancebotparameterscope)* | [`constructs.Construct`](#constructs.Construct) | *No description.* |
| [`id`](#cdkamazonchimeresourcesmessagingappinstancebotparameterid)* | `string` | *No description.* |
| [`props`](#cdkamazonchimeresourcesmessagingappinstancebotparameterprops)* | [`cdk-amazon-chime-resources.AppInstanceBotProps`](#cdk-amazon-chime-resources.AppInstanceBotProps) | *No description.* |
---
##### `scope`Required
- *Type:* [`constructs.Construct`](#constructs.Construct)
---
##### `id`Required
- *Type:* `string`
---
##### `props`Required
- *Type:* [`cdk-amazon-chime-resources.AppInstanceBotProps`](#cdk-amazon-chime-resources.AppInstanceBotProps)
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`appInstanceBotArn`](#cdkamazonchimeresourcesmessagingappinstancebotpropertyappinstancebotarn)* | `string` | *No description.* |
---
##### `appInstanceBotArn`Required
```typescript
public readonly appInstanceBotArn: string;
```
- *Type:* `string`
---
### MessagingAppInstanceUser
#### Initializers
```typescript
import { MessagingAppInstanceUser } from 'cdk-amazon-chime-resources'
new MessagingAppInstanceUser(scope: Construct, id: string, props: AppInstanceUserProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`scope`](#cdkamazonchimeresourcesmessagingappinstanceuserparameterscope)* | [`constructs.Construct`](#constructs.Construct) | *No description.* |
| [`id`](#cdkamazonchimeresourcesmessagingappinstanceuserparameterid)* | `string` | *No description.* |
| [`props`](#cdkamazonchimeresourcesmessagingappinstanceuserparameterprops)* | [`cdk-amazon-chime-resources.AppInstanceUserProps`](#cdk-amazon-chime-resources.AppInstanceUserProps) | *No description.* |
---
##### `scope`Required
- *Type:* [`constructs.Construct`](#constructs.Construct)
---
##### `id`Required
- *Type:* `string`
---
##### `props`Required
- *Type:* [`cdk-amazon-chime-resources.AppInstanceUserProps`](#cdk-amazon-chime-resources.AppInstanceUserProps)
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`appInstanceUserArn`](#cdkamazonchimeresourcesmessagingappinstanceuserpropertyappinstanceuserarn)* | `string` | *No description.* |
---
##### `appInstanceUserArn`Required
```typescript
public readonly appInstanceUserArn: string;
```
- *Type:* `string`
---
### MessagingResources
#### Initializers
```typescript
import { MessagingResources } from 'cdk-amazon-chime-resources'
new MessagingResources(scope: Construct, id: string, props: MessagingResourceProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`scope`](#cdkamazonchimeresourcesmessagingresourcesparameterscope)* | [`constructs.Construct`](#constructs.Construct) | *No description.* |
| [`id`](#cdkamazonchimeresourcesmessagingresourcesparameterid)* | `string` | *No description.* |
| [`props`](#cdkamazonchimeresourcesmessagingresourcesparameterprops)* | [`cdk-amazon-chime-resources.MessagingResourceProps`](#cdk-amazon-chime-resources.MessagingResourceProps) | *No description.* |
---
##### `scope`Required
- *Type:* [`constructs.Construct`](#constructs.Construct)
---
##### `id`Required
- *Type:* `string`
---
##### `props`Required
- *Type:* [`cdk-amazon-chime-resources.MessagingResourceProps`](#cdk-amazon-chime-resources.MessagingResourceProps)
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`lambda`](#cdkamazonchimeresourcesmessagingresourcespropertylambda)* | [`aws-cdk-lib.aws_lambda.IFunction`](#aws-cdk-lib.aws_lambda.IFunction) | *No description.* |
| [`messagingCustomResource`](#cdkamazonchimeresourcesmessagingresourcespropertymessagingcustomresource)* | [`aws-cdk-lib.CustomResource`](#aws-cdk-lib.CustomResource) | *No description.* |
---
##### `lambda`Required
```typescript
public readonly lambda: IFunction;
```
- *Type:* [`aws-cdk-lib.aws_lambda.IFunction`](#aws-cdk-lib.aws_lambda.IFunction)
---
##### `messagingCustomResource`Required
```typescript
public readonly messagingCustomResource: CustomResource;
```
- *Type:* [`aws-cdk-lib.CustomResource`](#aws-cdk-lib.CustomResource)
---
### PhoneAssociation
#### Initializers
```typescript
import { PhoneAssociation } from 'cdk-amazon-chime-resources'
new PhoneAssociation(scope: Construct, id: string, props: PhoneAssociationProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`scope`](#cdkamazonchimeresourcesphoneassociationparameterscope)* | [`constructs.Construct`](#constructs.Construct) | *No description.* |
| [`id`](#cdkamazonchimeresourcesphoneassociationparameterid)* | `string` | *No description.* |
| [`props`](#cdkamazonchimeresourcesphoneassociationparameterprops)* | [`cdk-amazon-chime-resources.PhoneAssociationProps`](#cdk-amazon-chime-resources.PhoneAssociationProps) | *No description.* |
---
##### `scope`Required
- *Type:* [`constructs.Construct`](#constructs.Construct)
---
##### `id`Required
- *Type:* `string`
---
##### `props`Required
- *Type:* [`cdk-amazon-chime-resources.PhoneAssociationProps`](#cdk-amazon-chime-resources.PhoneAssociationProps)
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`phoneAssociationResource`](#cdkamazonchimeresourcesphoneassociationpropertyphoneassociationresource)* | [`aws-cdk-lib.custom_resources.AwsCustomResource`](#aws-cdk-lib.custom_resources.AwsCustomResource) | *No description.* |
---
##### `phoneAssociationResource`Required
```typescript
public readonly phoneAssociationResource: AwsCustomResource;
```
- *Type:* [`aws-cdk-lib.custom_resources.AwsCustomResource`](#aws-cdk-lib.custom_resources.AwsCustomResource)
---
### PSTNResources
#### Initializers
```typescript
import { PSTNResources } from 'cdk-amazon-chime-resources'
new PSTNResources(scope: Construct, id: string, props: PSTNResourceProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`scope`](#cdkamazonchimeresourcespstnresourcesparameterscope)* | [`constructs.Construct`](#constructs.Construct) | *No description.* |
| [`id`](#cdkamazonchimeresourcespstnresourcesparameterid)* | `string` | *No description.* |
| [`props`](#cdkamazonchimeresourcespstnresourcesparameterprops)* | [`cdk-amazon-chime-resources.PSTNResourceProps`](#cdk-amazon-chime-resources.PSTNResourceProps) | *No description.* |
---
##### `scope`Required
- *Type:* [`constructs.Construct`](#constructs.Construct)
---
##### `id`Required
- *Type:* `string`
---
##### `props`Required
- *Type:* [`cdk-amazon-chime-resources.PSTNResourceProps`](#cdk-amazon-chime-resources.PSTNResourceProps)
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`lambda`](#cdkamazonchimeresourcespstnresourcespropertylambda)* | [`aws-cdk-lib.aws_lambda.IFunction`](#aws-cdk-lib.aws_lambda.IFunction) | *No description.* |
| [`pstnCustomResource`](#cdkamazonchimeresourcespstnresourcespropertypstncustomresource)* | [`aws-cdk-lib.CustomResource`](#aws-cdk-lib.CustomResource) | *No description.* |
---
##### `lambda`Required
```typescript
public readonly lambda: IFunction;
```
- *Type:* [`aws-cdk-lib.aws_lambda.IFunction`](#aws-cdk-lib.aws_lambda.IFunction)
---
##### `pstnCustomResource`Required
```typescript
public readonly pstnCustomResource: CustomResource;
```
- *Type:* [`aws-cdk-lib.CustomResource`](#aws-cdk-lib.CustomResource)
---
## Structs
### AmazonTranscribeCallAnalyticsProcessorConfiguration
#### Initializer
```typescript
import { AmazonTranscribeCallAnalyticsProcessorConfiguration } from 'cdk-amazon-chime-resources'
const amazonTranscribeCallAnalyticsProcessorConfiguration: AmazonTranscribeCallAnalyticsProcessorConfiguration = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`languageCode`](#cdkamazonchimeresourcesamazontranscribecallanalyticsprocessorconfigurationpropertylanguagecode)* | [`cdk-amazon-chime-resources.LanguageCode`](#cdk-amazon-chime-resources.LanguageCode) | *No description.* |
| [`callAnalyticsStreamCategories`](#cdkamazonchimeresourcesamazontranscribecallanalyticsprocessorconfigurationpropertycallanalyticsstreamcategories) | `string`[] | *No description.* |
| [`contentIdentificationType`](#cdkamazonchimeresourcesamazontranscribecallanalyticsprocessorconfigurationpropertycontentidentificationtype) | [`cdk-amazon-chime-resources.ContentIdentificationType`](#cdk-amazon-chime-resources.ContentIdentificationType) | *No description.* |
| [`contentRedactionType`](#cdkamazonchimeresourcesamazontranscribecallanalyticsprocessorconfigurationpropertycontentredactiontype) | [`cdk-amazon-chime-resources.ContentRedactionType`](#cdk-amazon-chime-resources.ContentRedactionType) | *No description.* |
| [`enablePartialResultsStabilization`](#cdkamazonchimeresourcesamazontranscribecallanalyticsprocessorconfigurationpropertyenablepartialresultsstabilization) | `boolean` | *No description.* |
| [`filterPartialResults`](#cdkamazonchimeresourcesamazontranscribecallanalyticsprocessorconfigurationpropertyfilterpartialresults) | `boolean` | *No description.* |
| [`languageModelName`](#cdkamazonchimeresourcesamazontranscribecallanalyticsprocessorconfigurationpropertylanguagemodelname) | `string` | *No description.* |
| [`partialResultsStability`](#cdkamazonchimeresourcesamazontranscribecallanalyticsprocessorconfigurationpropertypartialresultsstability) | [`cdk-amazon-chime-resources.PartialResultsStability`](#cdk-amazon-chime-resources.PartialResultsStability) | *No description.* |
| [`piiEntityTypes`](#cdkamazonchimeresourcesamazontranscribecallanalyticsprocessorconfigurationpropertypiientitytypes) | `string` | *No description.* |
| [`postCallAnalyticsSettings`](#cdkamazonchimeresourcesamazontranscribecallanalyticsprocessorconfigurationpropertypostcallanalyticssettings) | [`cdk-amazon-chime-resources.PostCallAnalyticsSettings`](#cdk-amazon-chime-resources.PostCallAnalyticsSettings) | *No description.* |
| [`vocabularyFilterMethod`](#cdkamazonchimeresourcesamazontranscribecallanalyticsprocessorconfigurationpropertyvocabularyfiltermethod) | [`cdk-amazon-chime-resources.VocabularyFilterMethod`](#cdk-amazon-chime-resources.VocabularyFilterMethod) | *No description.* |
| [`vocabularyFilterName`](#cdkamazonchimeresourcesamazontranscribecallanalyticsprocessorconfigurationpropertyvocabularyfiltername) | `string` | *No description.* |
| [`vocabularyName`](#cdkamazonchimeresourcesamazontranscribecallanalyticsprocessorconfigurationpropertyvocabularyname) | `string` | *No description.* |
---
##### `languageCode`Required
```typescript
public readonly languageCode: LanguageCode;
```
- *Type:* [`cdk-amazon-chime-resources.LanguageCode`](#cdk-amazon-chime-resources.LanguageCode)
---
##### `callAnalyticsStreamCategories`Optional
```typescript
public readonly callAnalyticsStreamCategories: string[];
```
- *Type:* `string`[]
---
##### `contentIdentificationType`Optional
```typescript
public readonly contentIdentificationType: ContentIdentificationType;
```
- *Type:* [`cdk-amazon-chime-resources.ContentIdentificationType`](#cdk-amazon-chime-resources.ContentIdentificationType)
---
##### `contentRedactionType`Optional
```typescript
public readonly contentRedactionType: ContentRedactionType;
```
- *Type:* [`cdk-amazon-chime-resources.ContentRedactionType`](#cdk-amazon-chime-resources.ContentRedactionType)
---
##### `enablePartialResultsStabilization`Optional
```typescript
public readonly enablePartialResultsStabilization: boolean;
```
- *Type:* `boolean`
---
##### `filterPartialResults`Optional
```typescript
public readonly filterPartialResults: boolean;
```
- *Type:* `boolean`
---
##### `languageModelName`Optional
```typescript
public readonly languageModelName: string;
```
- *Type:* `string`
---
##### `partialResultsStability`Optional
```typescript
public readonly partialResultsStability: PartialResultsStability;
```
- *Type:* [`cdk-amazon-chime-resources.PartialResultsStability`](#cdk-amazon-chime-resources.PartialResultsStability)
---
##### `piiEntityTypes`Optional
```typescript
public readonly piiEntityTypes: string;
```
- *Type:* `string`
---
##### `postCallAnalyticsSettings`Optional
```typescript
public readonly postCallAnalyticsSettings: PostCallAnalyticsSettings;
```
- *Type:* [`cdk-amazon-chime-resources.PostCallAnalyticsSettings`](#cdk-amazon-chime-resources.PostCallAnalyticsSettings)
---
##### `vocabularyFilterMethod`Optional
```typescript
public readonly vocabularyFilterMethod: VocabularyFilterMethod;
```
- *Type:* [`cdk-amazon-chime-resources.VocabularyFilterMethod`](#cdk-amazon-chime-resources.VocabularyFilterMethod)
---
##### `vocabularyFilterName`Optional
```typescript
public readonly vocabularyFilterName: string;
```
- *Type:* `string`
---
##### `vocabularyName`Optional
```typescript
public readonly vocabularyName: string;
```
- *Type:* `string`
---
### AmazonTranscribeProcessorConfiguration
#### Initializer
```typescript
import { AmazonTranscribeProcessorConfiguration } from 'cdk-amazon-chime-resources'
const amazonTranscribeProcessorConfiguration: AmazonTranscribeProcessorConfiguration = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`languageCode`](#cdkamazonchimeresourcesamazontranscribeprocessorconfigurationpropertylanguagecode)* | [`cdk-amazon-chime-resources.LanguageCode`](#cdk-amazon-chime-resources.LanguageCode) | *No description.* |
| [`contentIdentificationType`](#cdkamazonchimeresourcesamazontranscribeprocessorconfigurationpropertycontentidentificationtype) | [`cdk-amazon-chime-resources.ContentIdentificationType`](#cdk-amazon-chime-resources.ContentIdentificationType) | *No description.* |
| [`contentRedactionType`](#cdkamazonchimeresourcesamazontranscribeprocessorconfigurationpropertycontentredactiontype) | [`cdk-amazon-chime-resources.ContentRedactionType`](#cdk-amazon-chime-resources.ContentRedactionType) | *No description.* |
| [`enablePartialResultsStabilization`](#cdkamazonchimeresourcesamazontranscribeprocessorconfigurationpropertyenablepartialresultsstabilization) | `boolean` | *No description.* |
| [`filterPartialResults`](#cdkamazonchimeresourcesamazontranscribeprocessorconfigurationpropertyfilterpartialresults) | `boolean` | *No description.* |
| [`languageModelName`](#cdkamazonchimeresourcesamazontranscribeprocessorconfigurationpropertylanguagemodelname) | `string` | *No description.* |
| [`partialResultsStability`](#cdkamazonchimeresourcesamazontranscribeprocessorconfigurationpropertypartialresultsstability) | [`cdk-amazon-chime-resources.PartialResultsStability`](#cdk-amazon-chime-resources.PartialResultsStability) | *No description.* |
| [`piiEntityTypes`](#cdkamazonchimeresourcesamazontranscribeprocessorconfigurationpropertypiientitytypes) | `string` | *No description.* |
| [`showSpeakerLabel`](#cdkamazonchimeresourcesamazontranscribeprocessorconfigurationpropertyshowspeakerlabel) | `boolean` | *No description.* |
| [`vocabularyFilterMethod`](#cdkamazonchimeresourcesamazontranscribeprocessorconfigurationpropertyvocabularyfiltermethod) | [`cdk-amazon-chime-resources.VocabularyFilterMethod`](#cdk-amazon-chime-resources.VocabularyFilterMethod) | *No description.* |
| [`vocabularyFilterName`](#cdkamazonchimeresourcesamazontranscribeprocessorconfigurationpropertyvocabularyfiltername) | `string` | *No description.* |
| [`vocabularyName`](#cdkamazonchimeresourcesamazontranscribeprocessorconfigurationpropertyvocabularyname) | `string` | *No description.* |
---
##### `languageCode`Required
```typescript
public readonly languageCode: LanguageCode;
```
- *Type:* [`cdk-amazon-chime-resources.LanguageCode`](#cdk-amazon-chime-resources.LanguageCode)
---
##### `contentIdentificationType`Optional
```typescript
public readonly contentIdentificationType: ContentIdentificationType;
```
- *Type:* [`cdk-amazon-chime-resources.ContentIdentificationType`](#cdk-amazon-chime-resources.ContentIdentificationType)
---
##### `contentRedactionType`Optional
```typescript
public readonly contentRedactionType: ContentRedactionType;
```
- *Type:* [`cdk-amazon-chime-resources.ContentRedactionType`](#cdk-amazon-chime-resources.ContentRedactionType)
---
##### `enablePartialResultsStabilization`Optional
```typescript
public readonly enablePartialResultsStabilization: boolean;
```
- *Type:* `boolean`
---
##### `filterPartialResults`Optional
```typescript
public readonly filterPartialResults: boolean;
```
- *Type:* `boolean`
---
##### `languageModelName`Optional
```typescript
public readonly languageModelName: string;
```
- *Type:* `string`
---
##### `partialResultsStability`Optional
```typescript
public readonly partialResultsStability: PartialResultsStability;
```
- *Type:* [`cdk-amazon-chime-resources.PartialResultsStability`](#cdk-amazon-chime-resources.PartialResultsStability)
---
##### `piiEntityTypes`Optional
```typescript
public readonly piiEntityTypes: string;
```
- *Type:* `string`
---
##### `showSpeakerLabel`Optional
```typescript
public readonly showSpeakerLabel: boolean;
```
- *Type:* `boolean`
---
##### `vocabularyFilterMethod`Optional
```typescript
public readonly vocabularyFilterMethod: VocabularyFilterMethod;
```
- *Type:* [`cdk-amazon-chime-resources.VocabularyFilterMethod`](#cdk-amazon-chime-resources.VocabularyFilterMethod)
---
##### `vocabularyFilterName`Optional
```typescript
public readonly vocabularyFilterName: string;
```
- *Type:* `string`
---
##### `vocabularyName`Optional
```typescript
public readonly vocabularyName: string;
```
- *Type:* `string`
---
### AppInstanceAdminProps
Props for `AppInstance`.
#### Initializer
```typescript
import { AppInstanceAdminProps } from 'cdk-amazon-chime-resources'
const appInstanceAdminProps: AppInstanceAdminProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`appInstanceAdminArn`](#cdkamazonchimeresourcesappinstanceadminpropspropertyappinstanceadminarn)* | `string` | The name of the app instance. |
| [`appInstanceArn`](#cdkamazonchimeresourcesappinstanceadminpropspropertyappinstancearn)* | `string` | The name of the app instance. |
---
##### `appInstanceAdminArn`Required
```typescript
public readonly appInstanceAdminArn: string;
```
- *Type:* `string`
- *Default:* None
The name of the app instance.
---
##### `appInstanceArn`Required
```typescript
public readonly appInstanceArn: string;
```
- *Type:* `string`
- *Default:* None
The name of the app instance.
---
### AppInstanceBotConfiguration
Props for `Configuration`.
#### Initializer
```typescript
import { AppInstanceBotConfiguration } from 'cdk-amazon-chime-resources'
const appInstanceBotConfiguration: AppInstanceBotConfiguration = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`lex`](#cdkamazonchimeresourcesappinstancebotconfigurationpropertylex)* | [`cdk-amazon-chime-resources.AppInstanceBotLexConfiguration`](#cdk-amazon-chime-resources.AppInstanceBotLexConfiguration) | *No description.* |
---
##### `lex`Required
```typescript
public readonly lex: AppInstanceBotLexConfiguration;
```
- *Type:* [`cdk-amazon-chime-resources.AppInstanceBotLexConfiguration`](#cdk-amazon-chime-resources.AppInstanceBotLexConfiguration)
---
### AppInstanceBotLexConfiguration
Configuration for AppInstanceBot with Lex.
#### Initializer
```typescript
import { AppInstanceBotLexConfiguration } from 'cdk-amazon-chime-resources'
const appInstanceBotLexConfiguration: AppInstanceBotLexConfiguration = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`lexBotAliasArn`](#cdkamazonchimeresourcesappinstancebotlexconfigurationpropertylexbotaliasarn)* | `string` | Lex `BotAliasArn` from setup Lex Bot. |
| [`localeId`](#cdkamazonchimeresourcesappinstancebotlexconfigurationpropertylocaleid)* | `string` | LocaleId to use. |
| [`respondsTo`](#cdkamazonchimeresourcesappinstancebotlexconfigurationpropertyrespondsto)* | [`cdk-amazon-chime-resources.LexConfigurationRespondsTo`](#cdk-amazon-chime-resources.LexConfigurationRespondsTo) | Setting for when Lex is invoked. |
| [`welcomeIntent`](#cdkamazonchimeresourcesappinstancebotlexconfigurationpropertywelcomeintent) | `string` | An optional welcome intent to trigger when the Bot is added to the channel. |
---
##### `lexBotAliasArn`Required
```typescript
public readonly lexBotAliasArn: string;
```
- *Type:* `string`
Lex `BotAliasArn` from setup Lex Bot.
---
##### `localeId`Required
```typescript
public readonly localeId: string;
```
- *Type:* `string`
LocaleId to use.
This needs to match one of the localIds that BotAliasArn is configured with.
---
##### `respondsTo`Required
```typescript
public readonly respondsTo: LexConfigurationRespondsTo;
```
- *Type:* [`cdk-amazon-chime-resources.LexConfigurationRespondsTo`](#cdk-amazon-chime-resources.LexConfigurationRespondsTo)
Setting for when Lex is invoked.
---
##### `welcomeIntent`Optional
```typescript
public readonly welcomeIntent: string;
```
- *Type:* `string`
An optional welcome intent to trigger when the Bot is added to the channel.
---
### AppInstanceBotProps
Props for `AppInstance`.
#### Initializer
```typescript
import { AppInstanceBotProps } from 'cdk-amazon-chime-resources'
const appInstanceBotProps: AppInstanceBotProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`appInstanceArn`](#cdkamazonchimeresourcesappinstancebotpropspropertyappinstancearn)* | `string` | The name of the app instance. |
| [`configuration`](#cdkamazonchimeresourcesappinstancebotpropspropertyconfiguration)* | [`cdk-amazon-chime-resources.AppInstanceBotConfiguration`](#cdk-amazon-chime-resources.AppInstanceBotConfiguration) | The configuration of the bot. |
| [`clientRequestToken`](#cdkamazonchimeresourcesappinstancebotpropspropertyclientrequesttoken) | `string` | The ClientRequestToken of the app instance. |
| [`metadata`](#cdkamazonchimeresourcesappinstancebotpropspropertymetadata) | `string` | The metadata of the app instance. |
| [`name`](#cdkamazonchimeresourcesappinstancebotpropspropertyname) | `string` | The name of the app instance. |
| [`tags`](#cdkamazonchimeresourcesappinstancebotpropspropertytags) | [`cdk-amazon-chime-resources.InstanceBotTags`](#cdk-amazon-chime-resources.InstanceBotTags)[] | The tags for the creation request. |
---
##### `appInstanceArn`Required
```typescript
public readonly appInstanceArn: string;
```
- *Type:* `string`
- *Default:* None
The name of the app instance.
---
##### `configuration`Required
```typescript
public readonly configuration: AppInstanceBotConfiguration;
```
- *Type:* [`cdk-amazon-chime-resources.AppInstanceBotConfiguration`](#cdk-amazon-chime-resources.AppInstanceBotConfiguration)
The configuration of the bot.
This field populates Lex settings.
---
##### `clientRequestToken`Optional
```typescript
public readonly clientRequestToken: string;
```
- *Type:* `string`
- *Default:* None
The ClientRequestToken of the app instance.
This field is autopopulated if not provided.
---
##### `metadata`Optional
```typescript
public readonly metadata: string;
```
- *Type:* `string`
- *Default:* None
The metadata of the app instance.
Limited to a 1KB string in UTF-8.
---
##### `name`Optional
```typescript
public readonly name: string;
```
- *Type:* `string`
- *Default:* None
The name of the app instance.
---
##### `tags`Optional
```typescript
public readonly tags: InstanceBotTags[];
```
- *Type:* [`cdk-amazon-chime-resources.InstanceBotTags`](#cdk-amazon-chime-resources.InstanceBotTags)[]
- *Default:* None
The tags for the creation request.
---
### AppInstanceProps
Props for `AppInstance`.
#### Initializer
```typescript
import { AppInstanceProps } from 'cdk-amazon-chime-resources'
const appInstanceProps: AppInstanceProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`clientRequestToken`](#cdkamazonchimeresourcesappinstancepropspropertyclientrequesttoken) | `string` | The ClientRequestToken of the app instance. |
| [`metadata`](#cdkamazonchimeresourcesappinstancepropspropertymetadata) | `string` | The metadata of the app instance. |
| [`name`](#cdkamazonchimeresourcesappinstancepropspropertyname) | `string` | The name of the app instance. |
| [`tags`](#cdkamazonchimeresourcesappinstancepropspropertytags) | [`cdk-amazon-chime-resources.AppInstanceTags`](#cdk-amazon-chime-resources.AppInstanceTags)[] | The tags for the creation request. |
---
##### `clientRequestToken`Optional
```typescript
public readonly clientRequestToken: string;
```
- *Type:* `string`
- *Default:* None
The ClientRequestToken of the app instance.
This field is autopopulated if not provided.
---
##### `metadata`Optional
```typescript
public readonly metadata: string;
```
- *Type:* `string`
- *Default:* None
The metadata of the app instance.
Limited to a 1KB string in UTF-8.
---
##### `name`Optional
```typescript
public readonly name: string;
```
- *Type:* `string`
- *Default:* None
The name of the app instance.
---
##### `tags`Optional
```typescript
public readonly tags: AppInstanceTags[];
```
- *Type:* [`cdk-amazon-chime-resources.AppInstanceTags`](#cdk-amazon-chime-resources.AppInstanceTags)[]
- *Default:* None
The tags for the creation request.
---
### AppInstanceTags
#### Initializer
```typescript
import { AppInstanceTags } from 'cdk-amazon-chime-resources'
const appInstanceTags: AppInstanceTags = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`key`](#cdkamazonchimeresourcesappinstancetagspropertykey)* | `string` | *No description.* |
| [`value`](#cdkamazonchimeresourcesappinstancetagspropertyvalue)* | `string` | *No description.* |
---
##### `key`Required
```typescript
public readonly key: string;
```
- *Type:* `string`
---
##### `value`Required
```typescript
public readonly value: string;
```
- *Type:* `string`
---
### AppInstanceUserProps
Props for `AppInstance`.
#### Initializer
```typescript
import { AppInstanceUserProps } from 'cdk-amazon-chime-resources'
const appInstanceUserProps: AppInstanceUserProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`appInstanceArn`](#cdkamazonchimeresourcesappinstanceuserpropspropertyappinstancearn)* | `string` | The name of the app instance. |
| [`appInstanceUserId`](#cdkamazonchimeresourcesappinstanceuserpropspropertyappinstanceuserid)* | `string` | The id of the app instance user. |
| [`clientRequestToken`](#cdkamazonchimeresourcesappinstanceuserpropspropertyclientrequesttoken) | `string` | The ClientRequestToken of the app instance. |
| [`metadata`](#cdkamazonchimeresourcesappinstanceuserpropspropertymetadata) | `string` | The metadata of the app instance. |
| [`name`](#cdkamazonchimeresourcesappinstanceuserpropspropertyname) | `string` | The name of the app instance. |
| [`tags`](#cdkamazonchimeresourcesappinstanceuserpropspropertytags) | [`cdk-amazon-chime-resources.InstanceUserTags`](#cdk-amazon-chime-resources.InstanceUserTags)[] | The tags for the creation request. |
---
##### `appInstanceArn`Required
```typescript
public readonly appInstanceArn: string;
```
- *Type:* `string`
- *Default:* None
The name of the app instance.
---
##### `appInstanceUserId`Required
```typescript
public readonly appInstanceUserId: string;
```
- *Type:* `string`
- *Default:* None
The id of the app instance user.
---
##### `clientRequestToken`Optional
```typescript
public readonly clientRequestToken: string;
```
- *Type:* `string`
- *Default:* None
The ClientRequestToken of the app instance.
This field is autopopulated if not provided.
---
##### `metadata`Optional
```typescript
public readonly metadata: string;
```
- *Type:* `string`
- *Default:* None
The metadata of the app instance.
Limited to a 1KB string in UTF-8.
---
##### `name`Optional
```typescript
public readonly name: string;
```
- *Type:* `string`
- *Default:* None
The name of the app instance.
---
##### `tags`Optional
```typescript
public readonly tags: InstanceUserTags[];
```
- *Type:* [`cdk-amazon-chime-resources.InstanceUserTags`](#cdk-amazon-chime-resources.InstanceUserTags)[]
- *Default:* None
The tags for the creation request.
---
### ChannelFlowProps
Props for `AppInstance`.
See: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_CreateChannelFlow.html
#### Initializer
```typescript
import { ChannelFlowProps } from 'cdk-amazon-chime-resources'
const channelFlowProps: ChannelFlowProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`appInstanceArn`](#cdkamazonchimeresourceschannelflowpropspropertyappinstancearn)* | `string` | The ARN of the App Instance. |
| [`clientRequestToken`](#cdkamazonchimeresourceschannelflowpropspropertyclientrequesttoken)* | `string` | The client token for the request. |
| [`processors`](#cdkamazonchimeresourceschannelflowpropspropertyprocessors)* | [`cdk-amazon-chime-resources.Processors`](#cdk-amazon-chime-resources.Processors)[] | Information about the processor Lambda functions. |
| [`name`](#cdkamazonchimeresourceschannelflowpropspropertyname) | `string` | The name of the channel flow. |
| [`tags`](#cdkamazonchimeresourceschannelflowpropspropertytags) | [`cdk-amazon-chime-resources.ChannelFlowTags`](#cdk-amazon-chime-resources.ChannelFlowTags)[] | The tags for the creation request. |
---
##### `appInstanceArn`Required
```typescript
public readonly appInstanceArn: string;
```
- *Type:* `string`
- *Default:* None
The ARN of the App Instance.
---
##### `clientRequestToken`Required
```typescript
public readonly clientRequestToken: string;
```
- *Type:* `string`
- *Default:* None
The client token for the request.
An Idempotency token.
---
##### `processors`Required
```typescript
public readonly processors: Processors[];
```
- *Type:* [`cdk-amazon-chime-resources.Processors`](#cdk-amazon-chime-resources.Processors)[]
- *Default:* None
Information about the processor Lambda functions.
---
##### `name`Optional
```typescript
public readonly name: string;
```
- *Type:* `string`
- *Default:* None
The name of the channel flow.
---
##### `tags`Optional
```typescript
public readonly tags: ChannelFlowTags[];
```
- *Type:* [`cdk-amazon-chime-resources.ChannelFlowTags`](#cdk-amazon-chime-resources.ChannelFlowTags)[]
- *Default:* None
The tags for the creation request.
---
### ChannelFlowTags
#### Initializer
```typescript
import { ChannelFlowTags } from 'cdk-amazon-chime-resources'
const channelFlowTags: ChannelFlowTags = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`key`](#cdkamazonchimeresourceschannelflowtagspropertykey)* | `string` | *No description.* |
| [`value`](#cdkamazonchimeresourceschannelflowtagspropertyvalue)* | `string` | *No description.* |
---
##### `key`Required
```typescript
public readonly key: string;
```
- *Type:* `string`
---
##### `value`Required
```typescript
public readonly value: string;
```
- *Type:* `string`
---
### Configuration
Props for `Configuration`.
See: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_ProcessorConfiguration.html
#### Initializer
```typescript
import { Configuration } from 'cdk-amazon-chime-resources'
const configuration: Configuration = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`lambda`](#cdkamazonchimeresourcesconfigurationpropertylambda)* | [`cdk-amazon-chime-resources.Lambda`](#cdk-amazon-chime-resources.Lambda) | Indicates that the processor is of type Lambda. |
---
##### `lambda`Required
```typescript
public readonly lambda: Lambda;
```
- *Type:* [`cdk-amazon-chime-resources.Lambda`](#cdk-amazon-chime-resources.Lambda)
- *Default:* None
Indicates that the processor is of type Lambda.
---
### Elements
#### Initializer
```typescript
import { Elements } from 'cdk-amazon-chime-resources'
const elements: Elements = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`type`](#cdkamazonchimeresourceselementspropertytype)* | [`cdk-amazon-chime-resources.ElementsType`](#cdk-amazon-chime-resources.ElementsType) | *No description.* |
| [`amazonTranscribeCallAnalyticsProcessorConfiguration`](#cdkamazonchimeresourceselementspropertyamazontranscribecallanalyticsprocessorconfiguration) | [`cdk-amazon-chime-resources.AmazonTranscribeCallAnalyticsProcessorConfiguration`](#cdk-amazon-chime-resources.AmazonTranscribeCallAnalyticsProcessorConfiguration) | *No description.* |
| [`amazonTranscribeProcessorConfiguration`](#cdkamazonchimeresourceselementspropertyamazontranscribeprocessorconfiguration) | [`cdk-amazon-chime-resources.AmazonTranscribeProcessorConfiguration`](#cdk-amazon-chime-resources.AmazonTranscribeProcessorConfiguration) | *No description.* |
| [`kinesisDataStreamSinkConfiguration`](#cdkamazonchimeresourceselementspropertykinesisdatastreamsinkconfiguration) | [`cdk-amazon-chime-resources.KinesisDataStreamSinkConfiguration`](#cdk-amazon-chime-resources.KinesisDataStreamSinkConfiguration) | *No description.* |
| [`lambdaFunctionSinkConfiguration`](#cdkamazonchimeresourceselementspropertylambdafunctionsinkconfiguration) | [`cdk-amazon-chime-resources.LambdaFunctionSinkConfiguration`](#cdk-amazon-chime-resources.LambdaFunctionSinkConfiguration) | *No description.* |
| [`s3RecordingSinkConfiguration`](#cdkamazonchimeresourceselementspropertys3recordingsinkconfiguration) | [`cdk-amazon-chime-resources.S3RecordingSinkConfiguration`](#cdk-amazon-chime-resources.S3RecordingSinkConfiguration) | *No description.* |
| [`snsTopicSinkConfiguration`](#cdkamazonchimeresourceselementspropertysnstopicsinkconfiguration) | [`cdk-amazon-chime-resources.SnsTopicSinkConfiguration`](#cdk-amazon-chime-resources.SnsTopicSinkConfiguration) | *No description.* |
| [`sqsQueueSinkConfiguration`](#cdkamazonchimeresourceselementspropertysqsqueuesinkconfiguration) | [`cdk-amazon-chime-resources.SqsQueueSinkConfiguration`](#cdk-amazon-chime-resources.SqsQueueSinkConfiguration) | *No description.* |
| [`voiceAnalyticsProcessorConfiguration`](#cdkamazonchimeresourceselementspropertyvoiceanalyticsprocessorconfiguration) | [`cdk-amazon-chime-resources.VoiceAnalyticsProcessorConfiguration`](#cdk-amazon-chime-resources.VoiceAnalyticsProcessorConfiguration) | *No description.* |
---
##### `type`Required
```typescript
public readonly type: ElementsType;
```
- *Type:* [`cdk-amazon-chime-resources.ElementsType`](#cdk-amazon-chime-resources.ElementsType)
---
##### `amazonTranscribeCallAnalyticsProcessorConfiguration`Optional
```typescript
public readonly amazonTranscribeCallAnalyticsProcessorConfiguration: AmazonTranscribeCallAnalyticsProcessorConfiguration;
```
- *Type:* [`cdk-amazon-chime-resources.AmazonTranscribeCallAnalyticsProcessorConfiguration`](#cdk-amazon-chime-resources.AmazonTranscribeCallAnalyticsProcessorConfiguration)
---
##### `amazonTranscribeProcessorConfiguration`Optional
```typescript
public readonly amazonTranscribeProcessorConfiguration: AmazonTranscribeProcessorConfiguration;
```
- *Type:* [`cdk-amazon-chime-resources.AmazonTranscribeProcessorConfiguration`](#cdk-amazon-chime-resources.AmazonTranscribeProcessorConfiguration)
---
##### `kinesisDataStreamSinkConfiguration`Optional
```typescript
public readonly kinesisDataStreamSinkConfiguration: KinesisDataStreamSinkConfiguration;
```
- *Type:* [`cdk-amazon-chime-resources.KinesisDataStreamSinkConfiguration`](#cdk-amazon-chime-resources.KinesisDataStreamSinkConfiguration)
---
##### `lambdaFunctionSinkConfiguration`Optional
```typescript
public readonly lambdaFunctionSinkConfiguration: LambdaFunctionSinkConfiguration;
```
- *Type:* [`cdk-amazon-chime-resources.LambdaFunctionSinkConfiguration`](#cdk-amazon-chime-resources.LambdaFunctionSinkConfiguration)
---
##### `s3RecordingSinkConfiguration`Optional
```typescript
public readonly s3RecordingSinkConfiguration: S3RecordingSinkConfiguration;
```
- *Type:* [`cdk-amazon-chime-resources.S3RecordingSinkConfiguration`](#cdk-amazon-chime-resources.S3RecordingSinkConfiguration)
---
##### `snsTopicSinkConfiguration`Optional
```typescript
public readonly snsTopicSinkConfiguration: SnsTopicSinkConfiguration;
```
- *Type:* [`cdk-amazon-chime-resources.SnsTopicSinkConfiguration`](#cdk-amazon-chime-resources.SnsTopicSinkConfiguration)
---
##### `sqsQueueSinkConfiguration`Optional
```typescript
public readonly sqsQueueSinkConfiguration: SqsQueueSinkConfiguration;
```
- *Type:* [`cdk-amazon-chime-resources.SqsQueueSinkConfiguration`](#cdk-amazon-chime-resources.SqsQueueSinkConfiguration)
---
##### `voiceAnalyticsProcessorConfiguration`Optional
```typescript
public readonly voiceAnalyticsProcessorConfiguration: VoiceAnalyticsProcessorConfiguration;
```
- *Type:* [`cdk-amazon-chime-resources.VoiceAnalyticsProcessorConfiguration`](#cdk-amazon-chime-resources.VoiceAnalyticsProcessorConfiguration)
---
### InstanceBotTags
#### Initializer
```typescript
import { InstanceBotTags } from 'cdk-amazon-chime-resources'
const instanceBotTags: InstanceBotTags = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`key`](#cdkamazonchimeresourcesinstancebottagspropertykey)* | `string` | *No description.* |
| [`value`](#cdkamazonchimeresourcesinstancebottagspropertyvalue)* | `string` | *No description.* |
---
##### `key`Required
```typescript
public readonly key: string;
```
- *Type:* `string`
---
##### `value`Required
```typescript
public readonly value: string;
```
- *Type:* `string`
---
### InstanceUserTags
#### Initializer
```typescript
import { InstanceUserTags } from 'cdk-amazon-chime-resources'
const instanceUserTags: InstanceUserTags = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`key`](#cdkamazonchimeresourcesinstanceusertagspropertykey)* | `string` | *No description.* |
| [`value`](#cdkamazonchimeresourcesinstanceusertagspropertyvalue)* | `string` | *No description.* |
---
##### `key`Required
```typescript
public readonly key: string;
```
- *Type:* `string`
---
##### `value`Required
```typescript
public readonly value: string;
```
- *Type:* `string`
---
### IssueDetectionConfiguration
#### Initializer
```typescript
import { IssueDetectionConfiguration } from 'cdk-amazon-chime-resources'
const issueDetectionConfiguration: IssueDetectionConfiguration = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`ruleName`](#cdkamazonchimeresourcesissuedetectionconfigurationpropertyrulename)* | `string` | *No description.* |
---
##### `ruleName`Required
```typescript
public readonly ruleName: string;
```
- *Type:* `string`
---
### KeywordMatchConfiguration
#### Initializer
```typescript
import { KeywordMatchConfiguration } from 'cdk-amazon-chime-resources'
const keywordMatchConfiguration: KeywordMatchConfiguration = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`keywords`](#cdkamazonchimeresourceskeywordmatchconfigurationpropertykeywords)* | `string`[] | *No description.* |
| [`ruleName`](#cdkamazonchimeresourceskeywordmatchconfigurationpropertyrulename)* | `string` | *No description.* |
| [`negate`](#cdkamazonchimeresourceskeywordmatchconfigurationpropertynegate) | `boolean` | *No description.* |
---
##### `keywords`Required
```typescript
public readonly keywords: string[];
```
- *Type:* `string`[]
---
##### `ruleName`Required
```typescript
public readonly ruleName: string;
```
- *Type:* `string`
---
##### `negate`Optional
```typescript
public readonly negate: boolean;
```
- *Type:* `boolean`
---
### KinesisDataStreamSinkConfiguration
#### Initializer
```typescript
import { KinesisDataStreamSinkConfiguration } from 'cdk-amazon-chime-resources'
const kinesisDataStreamSinkConfiguration: KinesisDataStreamSinkConfiguration = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`insightsTarget`](#cdkamazonchimeresourceskinesisdatastreamsinkconfigurationpropertyinsightstarget)* | `string` | *No description.* |
---
##### `insightsTarget`Required
```typescript
public readonly insightsTarget: string;
```
- *Type:* `string`
---
### Lambda
Props for `LambdaConfiguration`.
See: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_LambdaConfiguration.html
#### Initializer
```typescript
import { Lambda } from 'cdk-amazon-chime-resources'
const lambda: Lambda = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`invocationType`](#cdkamazonchimeresourceslambdapropertyinvocationtype)* | [`cdk-amazon-chime-resources.InvocationType`](#cdk-amazon-chime-resources.InvocationType) | Controls how the Lambda function is invoked. |
| [`resourceArn`](#cdkamazonchimeresourceslambdapropertyresourcearn)* | `string` | The ARN of the Lambda message processing function. |
---
##### `invocationType`Required
```typescript
public readonly invocationType: InvocationType;
```
- *Type:* [`cdk-amazon-chime-resources.InvocationType`](#cdk-amazon-chime-resources.InvocationType)
- *Default:* None
Controls how the Lambda function is invoked.
---
##### `resourceArn`Required
```typescript
public readonly resourceArn: string;
```
- *Type:* `string`
- *Default:* None
The ARN of the Lambda message processing function.
---
### LambdaFunctionSinkConfiguration
#### Initializer
```typescript
import { LambdaFunctionSinkConfiguration } from 'cdk-amazon-chime-resources'
const lambdaFunctionSinkConfiguration: LambdaFunctionSinkConfiguration = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`insightsTarget`](#cdkamazonchimeresourceslambdafunctionsinkconfigurationpropertyinsightstarget)* | `string` | *No description.* |
---
##### `insightsTarget`Required
```typescript
public readonly insightsTarget: string;
```
- *Type:* `string`
---
### MediaInsightsConfiguration
#### Initializer
```typescript
import { MediaInsightsConfiguration } from 'cdk-amazon-chime-resources'
const mediaInsightsConfiguration: MediaInsightsConfiguration = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`configurationArn`](#cdkamazonchimeresourcesmediainsightsconfigurationpropertyconfigurationarn)* | `string` | *No description.* |
| [`disabled`](#cdkamazonchimeresourcesmediainsightsconfigurationpropertydisabled)* | `boolean` | *No description.* |
---
##### `configurationArn`Required
```typescript
public readonly configurationArn: string;
```
- *Type:* `string`
---
##### `disabled`Required
```typescript
public readonly disabled: boolean;
```
- *Type:* `boolean`
---
### MediaInsightsPipelineProps
#### Initializer
```typescript
import { MediaInsightsPipelineProps } from 'cdk-amazon-chime-resources'
const mediaInsightsPipelineProps: MediaInsightsPipelineProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`elements`](#cdkamazonchimeresourcesmediainsightspipelinepropspropertyelements)* | [`cdk-amazon-chime-resources.Elements`](#cdk-amazon-chime-resources.Elements)[] | *No description.* |
| [`resourceAccessRoleArn`](#cdkamazonchimeresourcesmediainsightspipelinepropspropertyresourceaccessrolearn)* | `string` | *No description.* |
| [`clientRequestToken`](#cdkamazonchimeresourcesmediainsightspipelinepropspropertyclientrequesttoken) | `string` | *No description.* |
| [`mediaInsightsPipelineConfigurationName`](#cdkamazonchimeresourcesmediainsightspipelinepropspropertymediainsightspipelineconfigurationname) | `string` | *No description.* |
| [`realTimeAlertConfiguration`](#cdkamazonchimeresourcesmediainsightspipelinepropspropertyrealtimealertconfiguration) | [`cdk-amazon-chime-resources.RealTimeAlertConfiguration`](#cdk-amazon-chime-resources.RealTimeAlertConfiguration) | *No description.* |
| [`tags`](#cdkamazonchimeresourcesmediainsightspipelinepropspropertytags) | [`cdk-amazon-chime-resources.MediaPipelineInsightsTag`](#cdk-amazon-chime-resources.MediaPipelineInsightsTag)[] | *No description.* |
---
##### `elements`Required
```typescript
public readonly elements: Elements[];
```
- *Type:* [`cdk-amazon-chime-resources.Elements`](#cdk-amazon-chime-resources.Elements)[]
---
##### `resourceAccessRoleArn`Required
```typescript
public readonly resourceAccessRoleArn: string;
```
- *Type:* `string`
---
##### `clientRequestToken`Optional
```typescript
public readonly clientRequestToken: string;
```
- *Type:* `string`
---
##### `mediaInsightsPipelineConfigurationName`Optional
```typescript
public readonly mediaInsightsPipelineConfigurationName: string;
```
- *Type:* `string`
---
##### `realTimeAlertConfiguration`Optional
```typescript
public readonly realTimeAlertConfiguration: RealTimeAlertConfiguration;
```
- *Type:* [`cdk-amazon-chime-resources.RealTimeAlertConfiguration`](#cdk-amazon-chime-resources.RealTimeAlertConfiguration)
---
##### `tags`Optional
```typescript
public readonly tags: MediaPipelineInsightsTag[];
```
- *Type:* [`cdk-amazon-chime-resources.MediaPipelineInsightsTag`](#cdk-amazon-chime-resources.MediaPipelineInsightsTag)[]
---
### MediaPipelineInsightsTag
#### Initializer
```typescript
import { MediaPipelineInsightsTag } from 'cdk-amazon-chime-resources'
const mediaPipelineInsightsTag: MediaPipelineInsightsTag = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`key`](#cdkamazonchimeresourcesmediapipelineinsightstagpropertykey)* | `string` | *No description.* |
| [`value`](#cdkamazonchimeresourcesmediapipelineinsightstagpropertyvalue)* | `string` | *No description.* |
---
##### `key`Required
```typescript
public readonly key: string;
```
- *Type:* `string`
---
##### `value`Required
```typescript
public readonly value: string;
```
- *Type:* `string`
---
### MessagingResourceProps
#### Initializer
```typescript
import { MessagingResourceProps } from 'cdk-amazon-chime-resources'
const messagingResourceProps: MessagingResourceProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`account`](#cdkamazonchimeresourcesmessagingresourcepropspropertyaccount) | `string` | The AWS account ID this resource belongs to. |
| [`environmentFromArn`](#cdkamazonchimeresourcesmessagingresourcepropspropertyenvironmentfromarn) | `string` | ARN to deduce region and account from. |
| [`physicalName`](#cdkamazonchimeresourcesmessagingresourcepropspropertyphysicalname) | `string` | The value passed in by users to the physical name prop of the resource. |
| [`region`](#cdkamazonchimeresourcesmessagingresourcepropspropertyregion) | `string` | The AWS region this resource belongs to. |
| [`properties`](#cdkamazonchimeresourcesmessagingresourcepropspropertyproperties)* | {[ key: string ]: `any`} | *No description.* |
| [`resourceType`](#cdkamazonchimeresourcesmessagingresourcepropspropertyresourcetype)* | `string` | *No description.* |
| [`uid`](#cdkamazonchimeresourcesmessagingresourcepropspropertyuid)* | `string` | *No description.* |
---
##### `account`Optional
```typescript
public readonly account: string;
```
- *Type:* `string`
- *Default:* the resource is in the same account as the stack it belongs to
The AWS account ID this resource belongs to.
---
##### `environmentFromArn`Optional
```typescript
public readonly environmentFromArn: string;
```
- *Type:* `string`
- *Default:* take environment from `account`, `region` parameters, or use Stack environment.
ARN to deduce region and account from.
The ARN is parsed and the account and region are taken from the ARN. This should be used for imported resources. Cannot be supplied together with either `account` or `region`.
---
##### `physicalName`Optional
```typescript
public readonly physicalName: string;
```
- *Type:* `string`
- *Default:* The physical name will be allocated by CloudFormation at deployment time
The value passed in by users to the physical name prop of the resource.
`undefined` implies that a physical name will be allocated by CloudFormation during deployment. - a concrete value implies a specific physical name - `PhysicalName.GENERATE_IF_NEEDED` is a marker that indicates that a physical will only be generated by the CDK if it is needed for cross-environment references. Otherwise, it will be allocated by CloudFormation.
---
##### `region`Optional
```typescript
public readonly region: string;
```
- *Type:* `string`
- *Default:* the resource is in the same region as the stack it belongs to
The AWS region this resource belongs to.
---
##### `properties`Required
```typescript
public readonly properties: {[ key: string ]: any};
```
- *Type:* {[ key: string ]: `any`}
---
##### `resourceType`Required
```typescript
public readonly resourceType: string;
```
- *Type:* `string`
---
##### `uid`Required
```typescript
public readonly uid: string;
```
- *Type:* `string`
---
### PhoneAssociationProps
#### Initializer
```typescript
import { PhoneAssociationProps } from 'cdk-amazon-chime-resources'
const phoneAssociationProps: PhoneAssociationProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`account`](#cdkamazonchimeresourcesphoneassociationpropspropertyaccount) | `string` | The AWS account ID this resource belongs to. |
| [`environmentFromArn`](#cdkamazonchimeresourcesphoneassociationpropspropertyenvironmentfromarn) | `string` | ARN to deduce region and account from. |
| [`physicalName`](#cdkamazonchimeresourcesphoneassociationpropspropertyphysicalname) | `string` | The value passed in by users to the physical name prop of the resource. |
| [`region`](#cdkamazonchimeresourcesphoneassociationpropspropertyregion) | `string` | The AWS region this resource belongs to. |
| [`e164PhoneNumber`](#cdkamazonchimeresourcesphoneassociationpropspropertye164phonenumber)* | `string` | *No description.* |
| [`voiceConnectorId`](#cdkamazonchimeresourcesphoneassociationpropspropertyvoiceconnectorid)* | `string` | *No description.* |
---
##### `account`Optional
```typescript
public readonly account: string;
```
- *Type:* `string`
- *Default:* the resource is in the same account as the stack it belongs to
The AWS account ID this resource belongs to.
---
##### `environmentFromArn`Optional
```typescript
public readonly environmentFromArn: string;
```
- *Type:* `string`
- *Default:* take environment from `account`, `region` parameters, or use Stack environment.
ARN to deduce region and account from.
The ARN is parsed and the account and region are taken from the ARN. This should be used for imported resources. Cannot be supplied together with either `account` or `region`.
---
##### `physicalName`Optional
```typescript
public readonly physicalName: string;
```
- *Type:* `string`
- *Default:* The physical name will be allocated by CloudFormation at deployment time
The value passed in by users to the physical name prop of the resource.
`undefined` implies that a physical name will be allocated by CloudFormation during deployment. - a concrete value implies a specific physical name - `PhysicalName.GENERATE_IF_NEEDED` is a marker that indicates that a physical will only be generated by the CDK if it is needed for cross-environment references. Otherwise, it will be allocated by CloudFormation.
---
##### `region`Optional
```typescript
public readonly region: string;
```
- *Type:* `string`
- *Default:* the resource is in the same region as the stack it belongs to
The AWS region this resource belongs to.
---
##### `e164PhoneNumber`Required
```typescript
public readonly e164PhoneNumber: string;
```
- *Type:* `string`
---
##### `voiceConnectorId`Required
```typescript
public readonly voiceConnectorId: string;
```
- *Type:* `string`
---
### PhoneNumberProps
Props for `PhoneNumber`.
#### Initializer
```typescript
import { PhoneNumberProps } from 'cdk-amazon-chime-resources'
const phoneNumberProps: PhoneNumberProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`phoneProductType`](#cdkamazonchimeresourcesphonenumberpropspropertyphoneproducttype)* | [`cdk-amazon-chime-resources.PhoneProductType`](#cdk-amazon-chime-resources.PhoneProductType) | Phone Product Type (required) - SipMediaApplicationDialIn or VoiceConnector. |
| [`phoneAreaCode`](#cdkamazonchimeresourcesphonenumberpropspropertyphoneareacode) | `number` | Area Code for phone number request (optional) - Usable only with US Country. |
| [`phoneCity`](#cdkamazonchimeresourcesphonenumberpropspropertyphonecity) | `string` | City for phone number request (optional) - Usable only with US Country. |
| [`phoneCountry`](#cdkamazonchimeresourcesphonenumberpropspropertyphonecountry) | [`cdk-amazon-chime-resources.PhoneCountry`](#cdk-amazon-chime-resources.PhoneCountry) | Country for phone number request (optional) - See https://docs.aws.amazon.com/chime/latest/ag/phone-country-reqs.html for more details. |
| [`phoneNumberTollFreePrefix`](#cdkamazonchimeresourcesphonenumberpropspropertyphonenumbertollfreeprefix) | `number` | Toll Free Prefix for phone number request (optional). |
| [`phoneNumberType`](#cdkamazonchimeresourcesphonenumberpropspropertyphonenumbertype) | [`cdk-amazon-chime-resources.PhoneNumberType`](#cdk-amazon-chime-resources.PhoneNumberType) | Phone Number Type for phone number request (optional) - Local or TollFree - Required with non-US country. |
| [`phoneState`](#cdkamazonchimeresourcesphonenumberpropspropertyphonestate) | `string` | State for phone number request (optional) - Usable only with US Country. |
---
##### `phoneProductType`Required
```typescript
public readonly phoneProductType: PhoneProductType;
```
- *Type:* [`cdk-amazon-chime-resources.PhoneProductType`](#cdk-amazon-chime-resources.PhoneProductType)
- *Default:* None
Phone Product Type (required) - SipMediaApplicationDialIn or VoiceConnector.
---
##### `phoneAreaCode`Optional
```typescript
public readonly phoneAreaCode: number;
```
- *Type:* `number`
- *Default:* None
Area Code for phone number request (optional) - Usable only with US Country.
---
##### `phoneCity`Optional
```typescript
public readonly phoneCity: string;
```
- *Type:* `string`
- *Default:* None
City for phone number request (optional) - Usable only with US Country.
---
##### `phoneCountry`Optional
```typescript
public readonly phoneCountry: PhoneCountry;
```
- *Type:* [`cdk-amazon-chime-resources.PhoneCountry`](#cdk-amazon-chime-resources.PhoneCountry)
- *Default:* US
Country for phone number request (optional) - See https://docs.aws.amazon.com/chime/latest/ag/phone-country-reqs.html for more details.
---
##### `phoneNumberTollFreePrefix`Optional
```typescript
public readonly phoneNumberTollFreePrefix: number;
```
- *Type:* `number`
- *Default:* None
Toll Free Prefix for phone number request (optional).
---
##### `phoneNumberType`Optional
```typescript
public readonly phoneNumberType: PhoneNumberType;
```
- *Type:* [`cdk-amazon-chime-resources.PhoneNumberType`](#cdk-amazon-chime-resources.PhoneNumberType)
- *Default:* None
Phone Number Type for phone number request (optional) - Local or TollFree - Required with non-US country.
---
##### `phoneState`Optional
```typescript
public readonly phoneState: string;
```
- *Type:* `string`
- *Default:* None
State for phone number request (optional) - Usable only with US Country.
---
### PostCallAnalyticsSettings
#### Initializer
```typescript
import { PostCallAnalyticsSettings } from 'cdk-amazon-chime-resources'
const postCallAnalyticsSettings: PostCallAnalyticsSettings = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`dataAccessRoleArn`](#cdkamazonchimeresourcespostcallanalyticssettingspropertydataaccessrolearn)* | `string` | *No description.* |
| [`outputLocation`](#cdkamazonchimeresourcespostcallanalyticssettingspropertyoutputlocation)* | `string` | *No description.* |
| [`contentRedactionOutput`](#cdkamazonchimeresourcespostcallanalyticssettingspropertycontentredactionoutput) | [`cdk-amazon-chime-resources.ContentRedactionOutput`](#cdk-amazon-chime-resources.ContentRedactionOutput) | *No description.* |
| [`outputEncryptionKMSKeyId`](#cdkamazonchimeresourcespostcallanalyticssettingspropertyoutputencryptionkmskeyid) | `string` | *No description.* |
---
##### `dataAccessRoleArn`Required
```typescript
public readonly dataAccessRoleArn: string;
```
- *Type:* `string`
---
##### `outputLocation`Required
```typescript
public readonly outputLocation: string;
```
- *Type:* `string`
---
##### `contentRedactionOutput`Optional
```typescript
public readonly contentRedactionOutput: ContentRedactionOutput;
```
- *Type:* [`cdk-amazon-chime-resources.ContentRedactionOutput`](#cdk-amazon-chime-resources.ContentRedactionOutput)
---
##### `outputEncryptionKMSKeyId`Optional
```typescript
public readonly outputEncryptionKMSKeyId: string;
```
- *Type:* `string`
---
### Processors
Props for `Processors`.
See: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_messaging-chime_Processor.html
#### Initializer
```typescript
import { Processors } from 'cdk-amazon-chime-resources'
const processors: Processors = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`configuration`](#cdkamazonchimeresourcesprocessorspropertyconfiguration)* | [`cdk-amazon-chime-resources.Configuration`](#cdk-amazon-chime-resources.Configuration) | The information about the type of processor and its identifier. |
| [`executionOrder`](#cdkamazonchimeresourcesprocessorspropertyexecutionorder)* | `number` | The sequence in which processors run. |
| [`fallbackAction`](#cdkamazonchimeresourcesprocessorspropertyfallbackaction)* | [`cdk-amazon-chime-resources.FallbackAction`](#cdk-amazon-chime-resources.FallbackAction) | Determines whether to continue with message processing or stop it in cases where communication with a processor fails. |
| [`name`](#cdkamazonchimeresourcesprocessorspropertyname)* | `string` | The name of the Channel Flow Processor. |
---
##### `configuration`Required
```typescript
public readonly configuration: Configuration;
```
- *Type:* [`cdk-amazon-chime-resources.Configuration`](#cdk-amazon-chime-resources.Configuration)
- *Default:* None
The information about the type of processor and its identifier.
---
##### `executionOrder`Required
```typescript
public readonly executionOrder: number;
```
- *Type:* `number`
- *Default:* None
The sequence in which processors run.
If you have multiple processors in a channel flow, message processing goes through each processor in the sequence. The value determines the sequence. At this point, we support only 1 processor within a flow.
---
##### `fallbackAction`Required
```typescript
public readonly fallbackAction: FallbackAction;
```
- *Type:* [`cdk-amazon-chime-resources.FallbackAction`](#cdk-amazon-chime-resources.FallbackAction)
- *Default:* None
Determines whether to continue with message processing or stop it in cases where communication with a processor fails.
If a processor has a fallback action of ABORT and communication with it fails, the processor sets the message status to FAILED and does not send the message to any recipients. Note that if the last processor in the channel flow sequence has a fallback action of CONTINUE and communication with the processor fails, then the message is considered processed and sent to recipients of the channel.
---
##### `name`Required
```typescript
public readonly name: string;
```
- *Type:* `string`
- *Default:* None
The name of the Channel Flow Processor.
---
### PSTNResourceProps
#### Initializer
```typescript
import { PSTNResourceProps } from 'cdk-amazon-chime-resources'
const pSTNResourceProps: PSTNResourceProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`account`](#cdkamazonchimeresourcespstnresourcepropspropertyaccount) | `string` | The AWS account ID this resource belongs to. |
| [`environmentFromArn`](#cdkamazonchimeresourcespstnresourcepropspropertyenvironmentfromarn) | `string` | ARN to deduce region and account from. |
| [`physicalName`](#cdkamazonchimeresourcespstnresourcepropspropertyphysicalname) | `string` | The value passed in by users to the physical name prop of the resource. |
| [`region`](#cdkamazonchimeresourcespstnresourcepropspropertyregion) | `string` | The AWS region this resource belongs to. |
| [`properties`](#cdkamazonchimeresourcespstnresourcepropspropertyproperties)* | {[ key: string ]: `any`} | *No description.* |
| [`resourceType`](#cdkamazonchimeresourcespstnresourcepropspropertyresourcetype)* | `string` | *No description.* |
| [`uid`](#cdkamazonchimeresourcespstnresourcepropspropertyuid)* | `string` | *No description.* |
---
##### `account`Optional
```typescript
public readonly account: string;
```
- *Type:* `string`
- *Default:* the resource is in the same account as the stack it belongs to
The AWS account ID this resource belongs to.
---
##### `environmentFromArn`Optional
```typescript
public readonly environmentFromArn: string;
```
- *Type:* `string`
- *Default:* take environment from `account`, `region` parameters, or use Stack environment.
ARN to deduce region and account from.
The ARN is parsed and the account and region are taken from the ARN. This should be used for imported resources. Cannot be supplied together with either `account` or `region`.
---
##### `physicalName`Optional
```typescript
public readonly physicalName: string;
```
- *Type:* `string`
- *Default:* The physical name will be allocated by CloudFormation at deployment time
The value passed in by users to the physical name prop of the resource.
`undefined` implies that a physical name will be allocated by CloudFormation during deployment. - a concrete value implies a specific physical name - `PhysicalName.GENERATE_IF_NEEDED` is a marker that indicates that a physical will only be generated by the CDK if it is needed for cross-environment references. Otherwise, it will be allocated by CloudFormation.
---
##### `region`Optional
```typescript
public readonly region: string;
```
- *Type:* `string`
- *Default:* the resource is in the same region as the stack it belongs to
The AWS region this resource belongs to.
---
##### `properties`Required
```typescript
public readonly properties: {[ key: string ]: any};
```
- *Type:* {[ key: string ]: `any`}
---
##### `resourceType`Required
```typescript
public readonly resourceType: string;
```
- *Type:* `string`
---
##### `uid`Required
```typescript
public readonly uid: string;
```
- *Type:* `string`
---
### RealTimeAlertConfiguration
#### Initializer
```typescript
import { RealTimeAlertConfiguration } from 'cdk-amazon-chime-resources'
const realTimeAlertConfiguration: RealTimeAlertConfiguration = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`disabled`](#cdkamazonchimeresourcesrealtimealertconfigurationpropertydisabled)* | `boolean` | *No description.* |
| [`rules`](#cdkamazonchimeresourcesrealtimealertconfigurationpropertyrules)* | [`cdk-amazon-chime-resources.Rules`](#cdk-amazon-chime-resources.Rules)[] | *No description.* |
---
##### `disabled`Required
```typescript
public readonly disabled: boolean;
```
- *Type:* `boolean`
---
##### `rules`Required
```typescript
public readonly rules: Rules[];
```
- *Type:* [`cdk-amazon-chime-resources.Rules`](#cdk-amazon-chime-resources.Rules)[]
---
### Routes
#### Initializer
```typescript
import { Routes } from 'cdk-amazon-chime-resources'
const routes: Routes = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`host`](#cdkamazonchimeresourcesroutespropertyhost)* | `string` | *No description.* |
| [`port`](#cdkamazonchimeresourcesroutespropertyport)* | `number` | *No description.* |
| [`priority`](#cdkamazonchimeresourcesroutespropertypriority)* | `number` | *No description.* |
| [`protocol`](#cdkamazonchimeresourcesroutespropertyprotocol)* | [`cdk-amazon-chime-resources.Protocol`](#cdk-amazon-chime-resources.Protocol) | *No description.* |
| [`weight`](#cdkamazonchimeresourcesroutespropertyweight)* | `number` | *No description.* |
---
##### `host`Required
```typescript
public readonly host: string;
```
- *Type:* `string`
---
##### `port`Required
```typescript
public readonly port: number;
```
- *Type:* `number`
---
##### `priority`Required
```typescript
public readonly priority: number;
```
- *Type:* `number`
---
##### `protocol`Required
```typescript
public readonly protocol: Protocol;
```
- *Type:* [`cdk-amazon-chime-resources.Protocol`](#cdk-amazon-chime-resources.Protocol)
---
##### `weight`Required
```typescript
public readonly weight: number;
```
- *Type:* `number`
---
### Rules
#### Initializer
```typescript
import { Rules } from 'cdk-amazon-chime-resources'
const rules: Rules = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`type`](#cdkamazonchimeresourcesrulespropertytype)* | [`cdk-amazon-chime-resources.RulesType`](#cdk-amazon-chime-resources.RulesType) | *No description.* |
| [`issueDetectionConfiguration`](#cdkamazonchimeresourcesrulespropertyissuedetectionconfiguration) | [`cdk-amazon-chime-resources.IssueDetectionConfiguration`](#cdk-amazon-chime-resources.IssueDetectionConfiguration) | *No description.* |
| [`keywordMatchConfiguration`](#cdkamazonchimeresourcesrulespropertykeywordmatchconfiguration) | [`cdk-amazon-chime-resources.KeywordMatchConfiguration`](#cdk-amazon-chime-resources.KeywordMatchConfiguration) | *No description.* |
| [`sentimentConfiguration`](#cdkamazonchimeresourcesrulespropertysentimentconfiguration) | [`cdk-amazon-chime-resources.SentimentConfiguration`](#cdk-amazon-chime-resources.SentimentConfiguration) | *No description.* |
---
##### `type`Required
```typescript
public readonly type: RulesType;
```
- *Type:* [`cdk-amazon-chime-resources.RulesType`](#cdk-amazon-chime-resources.RulesType)
---
##### `issueDetectionConfiguration`Optional
```typescript
public readonly issueDetectionConfiguration: IssueDetectionConfiguration;
```
- *Type:* [`cdk-amazon-chime-resources.IssueDetectionConfiguration`](#cdk-amazon-chime-resources.IssueDetectionConfiguration)
---
##### `keywordMatchConfiguration`Optional
```typescript
public readonly keywordMatchConfiguration: KeywordMatchConfiguration;
```
- *Type:* [`cdk-amazon-chime-resources.KeywordMatchConfiguration`](#cdk-amazon-chime-resources.KeywordMatchConfiguration)
---
##### `sentimentConfiguration`Optional
```typescript
public readonly sentimentConfiguration: SentimentConfiguration;
```
- *Type:* [`cdk-amazon-chime-resources.SentimentConfiguration`](#cdk-amazon-chime-resources.SentimentConfiguration)
---
### S3RecordingSinkConfiguration
#### Initializer
```typescript
import { S3RecordingSinkConfiguration } from 'cdk-amazon-chime-resources'
const s3RecordingSinkConfiguration: S3RecordingSinkConfiguration = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`destination`](#cdkamazonchimeresourcess3recordingsinkconfigurationpropertydestination)* | `string` | *No description.* |
---
##### `destination`Required
```typescript
public readonly destination: string;
```
- *Type:* `string`
---
### SentimentConfiguration
#### Initializer
```typescript
import { SentimentConfiguration } from 'cdk-amazon-chime-resources'
const sentimentConfiguration: SentimentConfiguration = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`ruleName`](#cdkamazonchimeresourcessentimentconfigurationpropertyrulename)* | `string` | *No description.* |
| [`sentimentType`](#cdkamazonchimeresourcessentimentconfigurationpropertysentimenttype)* | [`cdk-amazon-chime-resources.SentimentType`](#cdk-amazon-chime-resources.SentimentType) | *No description.* |
| [`timePeriod`](#cdkamazonchimeresourcessentimentconfigurationpropertytimeperiod)* | `number` | *No description.* |
---
##### `ruleName`Required
```typescript
public readonly ruleName: string;
```
- *Type:* `string`
---
##### `sentimentType`Required
```typescript
public readonly sentimentType: SentimentType;
```
- *Type:* [`cdk-amazon-chime-resources.SentimentType`](#cdk-amazon-chime-resources.SentimentType)
---
##### `timePeriod`Required
```typescript
public readonly timePeriod: number;
```
- *Type:* `number`
---
### ServerSideEncryptionConfiguration
#### Initializer
```typescript
import { ServerSideEncryptionConfiguration } from 'cdk-amazon-chime-resources'
const serverSideEncryptionConfiguration: ServerSideEncryptionConfiguration = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`kmsKeyArn`](#cdkamazonchimeresourcesserversideencryptionconfigurationpropertykmskeyarn)* | `string` | *No description.* |
---
##### `kmsKeyArn`Required
```typescript
public readonly kmsKeyArn: string;
```
- *Type:* `string`
---
### SipMediaApplicationAlexaSkillConfiguration
#### Initializer
```typescript
import { SipMediaApplicationAlexaSkillConfiguration } from 'cdk-amazon-chime-resources'
const sipMediaApplicationAlexaSkillConfiguration: SipMediaApplicationAlexaSkillConfiguration = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`alexaSkillIds`](#cdkamazonchimeresourcessipmediaapplicationalexaskillconfigurationpropertyalexaskillids)* | `string`[] | *No description.* |
| [`alexaSkillStatus`](#cdkamazonchimeresourcessipmediaapplicationalexaskillconfigurationpropertyalexaskillstatus)* | [`cdk-amazon-chime-resources.AlexaSkillStatus`](#cdk-amazon-chime-resources.AlexaSkillStatus) | *No description.* |
---
##### `alexaSkillIds`Required
```typescript
public readonly alexaSkillIds: string[];
```
- *Type:* `string`[]
---
##### `alexaSkillStatus`Required
```typescript
public readonly alexaSkillStatus: AlexaSkillStatus;
```
- *Type:* [`cdk-amazon-chime-resources.AlexaSkillStatus`](#cdk-amazon-chime-resources.AlexaSkillStatus)
---
### SipMediaApplicationLoggingConfiguration
Props for `AppInstanceStreamingConfiguration`.
See: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_AppInstanceStreamingConfiguration.html
#### Initializer
```typescript
import { SipMediaApplicationLoggingConfiguration } from 'cdk-amazon-chime-resources'
const sipMediaApplicationLoggingConfiguration: SipMediaApplicationLoggingConfiguration = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`enableSipMediaApplicationMessageLogs`](#cdkamazonchimeresourcessipmediaapplicationloggingconfigurationpropertyenablesipmediaapplicationmessagelogs)* | `boolean` | Enables message logging for the specified SIP media application. |
---
##### `enableSipMediaApplicationMessageLogs`Required
```typescript
public readonly enableSipMediaApplicationMessageLogs: boolean;
```
- *Type:* `boolean`
Enables message logging for the specified SIP media application.
---
### SipMediaAppProps
Props for `SipMediaApplication`.
#### Initializer
```typescript
import { SipMediaAppProps } from 'cdk-amazon-chime-resources'
const sipMediaAppProps: SipMediaAppProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`endpoint`](#cdkamazonchimeresourcessipmediaapppropspropertyendpoint)* | `string` | endpoint for SipMediaApplication(required). |
| [`name`](#cdkamazonchimeresourcessipmediaapppropspropertyname) | `string` | name for SipMediaApplication (optional). |
| [`region`](#cdkamazonchimeresourcessipmediaapppropspropertyregion) | `string` | region for SipMediaApplication(required) - Must us-east-1 or us-west-2 and in the same region as the SipMediaApplication Lambda handler. |
---
##### `endpoint`Required
```typescript
public readonly endpoint: string;
```
- *Type:* `string`
- *Default:* none
endpoint for SipMediaApplication(required).
---
##### `name`Optional
```typescript
public readonly name: string;
```
- *Type:* `string`
- *Default:* unique ID for resource
name for SipMediaApplication (optional).
---
##### `region`Optional
```typescript
public readonly region: string;
```
- *Type:* `string`
- *Default:* same region as stack deployment
region for SipMediaApplication(required) - Must us-east-1 or us-west-2 and in the same region as the SipMediaApplication Lambda handler.
---
### SipRuleProps
Props for `SipRule`.
#### Initializer
```typescript
import { SipRuleProps } from 'cdk-amazon-chime-resources'
const sipRuleProps: SipRuleProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`targetApplications`](#cdkamazonchimeresourcessiprulepropspropertytargetapplications)* | [`cdk-amazon-chime-resources.SipRuleTargetApplication`](#cdk-amazon-chime-resources.SipRuleTargetApplication)[] | *No description.* |
| [`triggerType`](#cdkamazonchimeresourcessiprulepropspropertytriggertype)* | [`cdk-amazon-chime-resources.TriggerType`](#cdk-amazon-chime-resources.TriggerType) | Trigger Type for SipRule (required) - TO_PHONE_NUMBER or REQUEST_URI_HOSTNAME. |
| [`triggerValue`](#cdkamazonchimeresourcessiprulepropspropertytriggervalue)* | `string` | Trigger Value for SipRule (required) - EE.164 Phone Number or Voice Connector URI. |
| [`name`](#cdkamazonchimeresourcessiprulepropspropertyname) | `string` | name for SipRule (optional). |
---
##### `targetApplications`Required
```typescript
public readonly targetApplications: SipRuleTargetApplication[];
```
- *Type:* [`cdk-amazon-chime-resources.SipRuleTargetApplication`](#cdk-amazon-chime-resources.SipRuleTargetApplication)[]
---
##### `triggerType`Required
```typescript
public readonly triggerType: TriggerType;
```
- *Type:* [`cdk-amazon-chime-resources.TriggerType`](#cdk-amazon-chime-resources.TriggerType)
- *Default:* none
Trigger Type for SipRule (required) - TO_PHONE_NUMBER or REQUEST_URI_HOSTNAME.
---
##### `triggerValue`Required
```typescript
public readonly triggerValue: string;
```
- *Type:* `string`
- *Default:* none
Trigger Value for SipRule (required) - EE.164 Phone Number or Voice Connector URI.
---
##### `name`Optional
```typescript
public readonly name: string;
```
- *Type:* `string`
- *Default:* unique ID for resource
name for SipRule (optional).
---
### SipRuleTargetApplication
#### Initializer
```typescript
import { SipRuleTargetApplication } from 'cdk-amazon-chime-resources'
const sipRuleTargetApplication: SipRuleTargetApplication = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`priority`](#cdkamazonchimeresourcessipruletargetapplicationpropertypriority)* | `number` | Priority for SipRule (required) - 1 to 25. |
| [`sipMediaApplicationId`](#cdkamazonchimeresourcessipruletargetapplicationpropertysipmediaapplicationid)* | `string` | SipMediaApplicationId for SipRule (required). |
| [`region`](#cdkamazonchimeresourcessipruletargetapplicationpropertyregion) | `string` | Region for SipRule (optional). |
---
##### `priority`Required
```typescript
public readonly priority: number;
```
- *Type:* `number`
- *Default:* none
Priority for SipRule (required) - 1 to 25.
---
##### `sipMediaApplicationId`Required
```typescript
public readonly sipMediaApplicationId: string;
```
- *Type:* `string`
- *Default:* none
SipMediaApplicationId for SipRule (required).
---
##### `region`Optional
```typescript
public readonly region: string;
```
- *Type:* `string`
- *Default:* same region as stack deployment
Region for SipRule (optional).
---
### SnsTopicSinkConfiguration
#### Initializer
```typescript
import { SnsTopicSinkConfiguration } from 'cdk-amazon-chime-resources'
const snsTopicSinkConfiguration: SnsTopicSinkConfiguration = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`insightsTarget`](#cdkamazonchimeresourcessnstopicsinkconfigurationpropertyinsightstarget)* | `string` | *No description.* |
---
##### `insightsTarget`Required
```typescript
public readonly insightsTarget: string;
```
- *Type:* `string`
---
### SqsQueueSinkConfiguration
#### Initializer
```typescript
import { SqsQueueSinkConfiguration } from 'cdk-amazon-chime-resources'
const sqsQueueSinkConfiguration: SqsQueueSinkConfiguration = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`insightsTarget`](#cdkamazonchimeresourcessqsqueuesinkconfigurationpropertyinsightstarget)* | `string` | *No description.* |
---
##### `insightsTarget`Required
```typescript
public readonly insightsTarget: string;
```
- *Type:* `string`
---
### Streaming
#### Initializer
```typescript
import { Streaming } from 'cdk-amazon-chime-resources'
const streaming: Streaming = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`dataRetention`](#cdkamazonchimeresourcesstreamingpropertydataretention)* | `number` | Streaming data retention for VoiceConnector. |
| [`enabled`](#cdkamazonchimeresourcesstreamingpropertyenabled)* | `boolean` | *No description.* |
| [`notificationTargets`](#cdkamazonchimeresourcesstreamingpropertynotificationtargets)* | [`cdk-amazon-chime-resources.NotificationTargetType`](#cdk-amazon-chime-resources.NotificationTargetType)[] | Streaming data retention for VoiceConnector. |
| [`mediaInsightsConfiguration`](#cdkamazonchimeresourcesstreamingpropertymediainsightsconfiguration) | [`cdk-amazon-chime-resources.MediaInsightsConfiguration`](#cdk-amazon-chime-resources.MediaInsightsConfiguration) | *No description.* |
---
##### `dataRetention`Required
```typescript
public readonly dataRetention: number;
```
- *Type:* `number`
- *Default:* 0
Streaming data retention for VoiceConnector.
---
##### `enabled`Required
```typescript
public readonly enabled: boolean;
```
- *Type:* `boolean`
---
##### `notificationTargets`Required
```typescript
public readonly notificationTargets: NotificationTargetType[];
```
- *Type:* [`cdk-amazon-chime-resources.NotificationTargetType`](#cdk-amazon-chime-resources.NotificationTargetType)[]
- *Default:* 0
Streaming data retention for VoiceConnector.
---
##### `mediaInsightsConfiguration`Optional
```typescript
public readonly mediaInsightsConfiguration: MediaInsightsConfiguration;
```
- *Type:* [`cdk-amazon-chime-resources.MediaInsightsConfiguration`](#cdk-amazon-chime-resources.MediaInsightsConfiguration)
---
### StreamingConfig
Props for `AppInstanceStreamingConfiguration`.
See: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_AppInstanceStreamingConfiguration.html
#### Initializer
```typescript
import { StreamingConfig } from 'cdk-amazon-chime-resources'
const streamingConfig: StreamingConfig = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`appInstanceDataType`](#cdkamazonchimeresourcesstreamingconfigpropertyappinstancedatatype)* | [`cdk-amazon-chime-resources.AppInstanceDataType`](#cdk-amazon-chime-resources.AppInstanceDataType) | The type of data to be streamed. |
| [`resourceArn`](#cdkamazonchimeresourcesstreamingconfigpropertyresourcearn)* | `string` | The resource ARN of a Kinesis Stream. |
---
##### `appInstanceDataType`Required
```typescript
public readonly appInstanceDataType: AppInstanceDataType;
```
- *Type:* [`cdk-amazon-chime-resources.AppInstanceDataType`](#cdk-amazon-chime-resources.AppInstanceDataType)
The type of data to be streamed.
---
##### `resourceArn`Required
```typescript
public readonly resourceArn: string;
```
- *Type:* `string`
The resource ARN of a Kinesis Stream.
---
### StreamingConfigurationProps
Props for `PutAppInstanceStreamingConfigurations`.
See: https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_PutAppInstanceStreamingConfigurations.html
#### Initializer
```typescript
import { StreamingConfigurationProps } from 'cdk-amazon-chime-resources'
const streamingConfigurationProps: StreamingConfigurationProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`appInstanceArn`](#cdkamazonchimeresourcesstreamingconfigurationpropspropertyappinstancearn)* | `string` | The ARN of the App Instance. |
| [`streamingConfigs`](#cdkamazonchimeresourcesstreamingconfigurationpropspropertystreamingconfigs)* | [`cdk-amazon-chime-resources.StreamingConfig`](#cdk-amazon-chime-resources.StreamingConfig)[] | The AppInstanceStreamingConfigurations. |
---
##### `appInstanceArn`Required
```typescript
public readonly appInstanceArn: string;
```
- *Type:* `string`
- *Default:* None
The ARN of the App Instance.
---
##### `streamingConfigs`Required
```typescript
public readonly streamingConfigs: StreamingConfig[];
```
- *Type:* [`cdk-amazon-chime-resources.StreamingConfig`](#cdk-amazon-chime-resources.StreamingConfig)[]
- *Default:* None
The AppInstanceStreamingConfigurations.
---
### Termination
#### Initializer
```typescript
import { Termination } from 'cdk-amazon-chime-resources'
const termination: Termination = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`callingRegions`](#cdkamazonchimeresourcesterminationpropertycallingregions)* | `string`[] | Calling Regions for VoiceConnector (optional). |
| [`terminationCidrs`](#cdkamazonchimeresourcesterminationpropertyterminationcidrs)* | `string`[] | termination IP for VoiceConnector (optional). |
| [`cps`](#cdkamazonchimeresourcesterminationpropertycps) | `number` | CPS Limit. |
---
##### `callingRegions`Required
```typescript
public readonly callingRegions: string[];
```
- *Type:* `string`[]
- *Default:* ['US']
Calling Regions for VoiceConnector (optional).
---
##### `terminationCidrs`Required
```typescript
public readonly terminationCidrs: string[];
```
- *Type:* `string`[]
- *Default:* none
termination IP for VoiceConnector (optional).
---
##### `cps`Optional
```typescript
public readonly cps: number;
```
- *Type:* `number`
- *Default:* 1
CPS Limit.
---
### VoiceAnalyticsProcessorConfiguration
#### Initializer
```typescript
import { VoiceAnalyticsProcessorConfiguration } from 'cdk-amazon-chime-resources'
const voiceAnalyticsProcessorConfiguration: VoiceAnalyticsProcessorConfiguration = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`speakerSearchStatus`](#cdkamazonchimeresourcesvoiceanalyticsprocessorconfigurationpropertyspeakersearchstatus)* | [`cdk-amazon-chime-resources.SpeakerSearchStatus`](#cdk-amazon-chime-resources.SpeakerSearchStatus) | *No description.* |
| [`voiceToneAnalysisStatus`](#cdkamazonchimeresourcesvoiceanalyticsprocessorconfigurationpropertyvoicetoneanalysisstatus)* | [`cdk-amazon-chime-resources.VoiceToneAnalysisStatus`](#cdk-amazon-chime-resources.VoiceToneAnalysisStatus) | *No description.* |
---
##### `speakerSearchStatus`Required
```typescript
public readonly speakerSearchStatus: SpeakerSearchStatus;
```
- *Type:* [`cdk-amazon-chime-resources.SpeakerSearchStatus`](#cdk-amazon-chime-resources.SpeakerSearchStatus)
---
##### `voiceToneAnalysisStatus`Required
```typescript
public readonly voiceToneAnalysisStatus: VoiceToneAnalysisStatus;
```
- *Type:* [`cdk-amazon-chime-resources.VoiceToneAnalysisStatus`](#cdk-amazon-chime-resources.VoiceToneAnalysisStatus)
---
### VoiceConnectorLoggingConfiguration
#### Initializer
```typescript
import { VoiceConnectorLoggingConfiguration } from 'cdk-amazon-chime-resources'
const voiceConnectorLoggingConfiguration: VoiceConnectorLoggingConfiguration = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`enableMediaMetricLogs`](#cdkamazonchimeresourcesvoiceconnectorloggingconfigurationpropertyenablemediametriclogs) | `boolean` | *No description.* |
| [`enableSIPLogs`](#cdkamazonchimeresourcesvoiceconnectorloggingconfigurationpropertyenablesiplogs) | `boolean` | *No description.* |
---
##### `enableMediaMetricLogs`Optional
```typescript
public readonly enableMediaMetricLogs: boolean;
```
- *Type:* `boolean`
---
##### `enableSIPLogs`Optional
```typescript
public readonly enableSIPLogs: boolean;
```
- *Type:* `boolean`
---
### VoiceConnectorProps
Props for `SipMediaApplication`.
#### Initializer
```typescript
import { VoiceConnectorProps } from 'cdk-amazon-chime-resources'
const voiceConnectorProps: VoiceConnectorProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`encryption`](#cdkamazonchimeresourcesvoiceconnectorpropspropertyencryption) | `boolean` | Encryption boolean for VoiceConnector. |
| [`loggingConfiguration`](#cdkamazonchimeresourcesvoiceconnectorpropspropertyloggingconfiguration) | [`cdk-amazon-chime-resources.VoiceConnectorLoggingConfiguration`](#cdk-amazon-chime-resources.VoiceConnectorLoggingConfiguration) | *No description.* |
| [`name`](#cdkamazonchimeresourcesvoiceconnectorpropspropertyname) | `string` | name for VoiceConnector. |
| [`origination`](#cdkamazonchimeresourcesvoiceconnectorpropspropertyorigination) | [`cdk-amazon-chime-resources.Routes`](#cdk-amazon-chime-resources.Routes)[] | *No description.* |
| [`region`](#cdkamazonchimeresourcesvoiceconnectorpropspropertyregion) | `string` | region for SipMediaApplication(required) - Must us-east-1 or us-west-2 and in the same region as the SipMediaApplication Lambda handler. |
| [`streaming`](#cdkamazonchimeresourcesvoiceconnectorpropspropertystreaming) | [`cdk-amazon-chime-resources.Streaming`](#cdk-amazon-chime-resources.Streaming) | *No description.* |
| [`termination`](#cdkamazonchimeresourcesvoiceconnectorpropspropertytermination) | [`cdk-amazon-chime-resources.Termination`](#cdk-amazon-chime-resources.Termination) | *No description.* |
---
##### `encryption`Optional
```typescript
public readonly encryption: boolean;
```
- *Type:* `boolean`
- *Default:* False
Encryption boolean for VoiceConnector.
---
##### `loggingConfiguration`Optional
```typescript
public readonly loggingConfiguration: VoiceConnectorLoggingConfiguration;
```
- *Type:* [`cdk-amazon-chime-resources.VoiceConnectorLoggingConfiguration`](#cdk-amazon-chime-resources.VoiceConnectorLoggingConfiguration)
---
##### `name`Optional
```typescript
public readonly name: string;
```
- *Type:* `string`
- *Default:* unique ID for resource
name for VoiceConnector.
---
##### `origination`Optional
```typescript
public readonly origination: Routes[];
```
- *Type:* [`cdk-amazon-chime-resources.Routes`](#cdk-amazon-chime-resources.Routes)[]
---
##### `region`Optional
```typescript
public readonly region: string;
```
- *Type:* `string`
- *Default:* same region as stack deployment
region for SipMediaApplication(required) - Must us-east-1 or us-west-2 and in the same region as the SipMediaApplication Lambda handler.
---
##### `streaming`Optional
```typescript
public readonly streaming: Streaming;
```
- *Type:* [`cdk-amazon-chime-resources.Streaming`](#cdk-amazon-chime-resources.Streaming)
---
##### `termination`Optional
```typescript
public readonly termination: Termination;
```
- *Type:* [`cdk-amazon-chime-resources.Termination`](#cdk-amazon-chime-resources.Termination)
---
### VoiceProfileDomainProps
#### Initializer
```typescript
import { VoiceProfileDomainProps } from 'cdk-amazon-chime-resources'
const voiceProfileDomainProps: VoiceProfileDomainProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`serverSideEncryptionConfiguration`](#cdkamazonchimeresourcesvoiceprofiledomainpropspropertyserversideencryptionconfiguration)* | [`cdk-amazon-chime-resources.ServerSideEncryptionConfiguration`](#cdk-amazon-chime-resources.ServerSideEncryptionConfiguration) | *No description.* |
| [`clientRequestToken`](#cdkamazonchimeresourcesvoiceprofiledomainpropspropertyclientrequesttoken) | `string` | *No description.* |
| [`description`](#cdkamazonchimeresourcesvoiceprofiledomainpropspropertydescription) | `string` | *No description.* |
| [`name`](#cdkamazonchimeresourcesvoiceprofiledomainpropspropertyname) | `string` | *No description.* |
| [`tags`](#cdkamazonchimeresourcesvoiceprofiledomainpropspropertytags) | [`cdk-amazon-chime-resources.VoiceProfileDomainTag`](#cdk-amazon-chime-resources.VoiceProfileDomainTag)[] | *No description.* |
---
##### `serverSideEncryptionConfiguration`Required
```typescript
public readonly serverSideEncryptionConfiguration: ServerSideEncryptionConfiguration;
```
- *Type:* [`cdk-amazon-chime-resources.ServerSideEncryptionConfiguration`](#cdk-amazon-chime-resources.ServerSideEncryptionConfiguration)
---
##### `clientRequestToken`Optional
```typescript
public readonly clientRequestToken: string;
```
- *Type:* `string`
---
##### `description`Optional
```typescript
public readonly description: string;
```
- *Type:* `string`
---
##### `name`Optional
```typescript
public readonly name: string;
```
- *Type:* `string`
---
##### `tags`Optional
```typescript
public readonly tags: VoiceProfileDomainTag[];
```
- *Type:* [`cdk-amazon-chime-resources.VoiceProfileDomainTag`](#cdk-amazon-chime-resources.VoiceProfileDomainTag)[]
---
### VoiceProfileDomainTag
#### Initializer
```typescript
import { VoiceProfileDomainTag } from 'cdk-amazon-chime-resources'
const voiceProfileDomainTag: VoiceProfileDomainTag = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| [`key`](#cdkamazonchimeresourcesvoiceprofiledomaintagpropertykey)* | `string` | *No description.* |
| [`value`](#cdkamazonchimeresourcesvoiceprofiledomaintagpropertyvalue)* | `string` | *No description.* |
---
##### `key`Required
```typescript
public readonly key: string;
```
- *Type:* `string`
---
##### `value`Required
```typescript
public readonly value: string;
```
- *Type:* `string`
---
## Enums
### AlexaSkillStatus
| **Name** | **Description** |
| --- | --- |
| [`ACTIVE`](#cdkamazonchimeresourcesalexaskillstatusactive) | *No description.* |
| [`INACTIVE`](#cdkamazonchimeresourcesalexaskillstatusinactive) | *No description.* |
---
#### `ACTIVE`
---
#### `INACTIVE`
---
### AppInstanceDataType
| **Name** | **Description** |
| --- | --- |
| [`CHANNEL`](#cdkamazonchimeresourcesappinstancedatatypechannel) | *No description.* |
| [`CHANNELMESSAGE`](#cdkamazonchimeresourcesappinstancedatatypechannelmessage) | *No description.* |
---
#### `CHANNEL`
---
#### `CHANNELMESSAGE`
---
### ContentIdentificationType
| **Name** | **Description** |
| --- | --- |
| [`PII`](#cdkamazonchimeresourcescontentidentificationtypepii) | *No description.* |
---
#### `PII`
---
### ContentRedactionOutput
| **Name** | **Description** |
| --- | --- |
| [`REDACTED`](#cdkamazonchimeresourcescontentredactionoutputredacted) | *No description.* |
| [`REDACTED_AND_UNREDACTED`](#cdkamazonchimeresourcescontentredactionoutputredactedandunredacted) | *No description.* |
---
#### `REDACTED`
---
#### `REDACTED_AND_UNREDACTED`
---
### ContentRedactionType
| **Name** | **Description** |
| --- | --- |
| [`PII`](#cdkamazonchimeresourcescontentredactiontypepii) | *No description.* |
---
#### `PII`
---
### ElementsType
| **Name** | **Description** |
| --- | --- |
| [`AMAZON_TRANSCRIPT_CALL_ANALYTICS_PROCESS`](#cdkamazonchimeresourceselementstypeamazontranscriptcallanalyticsprocess) | *No description.* |
| [`VOICE_ANALYTICS_PROCESSOR`](#cdkamazonchimeresourceselementstypevoiceanalyticsprocessor) | *No description.* |
| [`AMAZON_TRANSCRIBE_PROCESSOR`](#cdkamazonchimeresourceselementstypeamazontranscribeprocessor) | *No description.* |
| [`KINESIS_DATA_STREAM_SINK`](#cdkamazonchimeresourceselementstypekinesisdatastreamsink) | *No description.* |
| [`LAMBDA_FUNCTION_SINK`](#cdkamazonchimeresourceselementstypelambdafunctionsink) | *No description.* |
| [`SQS_QUEUE_SINK`](#cdkamazonchimeresourceselementstypesqsqueuesink) | *No description.* |
| [`SNS_TOPICS_SINK`](#cdkamazonchimeresourceselementstypesnstopicssink) | *No description.* |
| [`S3_RECORDING_SINK`](#cdkamazonchimeresourceselementstypes3recordingsink) | *No description.* |
---
#### `AMAZON_TRANSCRIPT_CALL_ANALYTICS_PROCESS`
---
#### `VOICE_ANALYTICS_PROCESSOR`
---
#### `AMAZON_TRANSCRIBE_PROCESSOR`
---
#### `KINESIS_DATA_STREAM_SINK`
---
#### `LAMBDA_FUNCTION_SINK`
---
#### `SQS_QUEUE_SINK`
---
#### `SNS_TOPICS_SINK`
---
#### `S3_RECORDING_SINK`
---
### FallbackAction
| **Name** | **Description** |
| --- | --- |
| [`CONTINUE`](#cdkamazonchimeresourcesfallbackactioncontinue) | *No description.* |
| [`ABORT`](#cdkamazonchimeresourcesfallbackactionabort) | *No description.* |
---
#### `CONTINUE`
---
#### `ABORT`
---
### InvocationType
| **Name** | **Description** |
| --- | --- |
| [`ASYNC`](#cdkamazonchimeresourcesinvocationtypeasync) | *No description.* |
---
#### `ASYNC`
---
### LanguageCode
| **Name** | **Description** |
| --- | --- |
| [`EN_US`](#cdkamazonchimeresourceslanguagecodeenus) | *No description.* |
| [`EN_GB`](#cdkamazonchimeresourceslanguagecodeengb) | *No description.* |
| [`ES_US`](#cdkamazonchimeresourceslanguagecodeesus) | *No description.* |
| [`FR_CA`](#cdkamazonchimeresourceslanguagecodefrca) | *No description.* |
| [`FR_FR`](#cdkamazonchimeresourceslanguagecodefrfr) | *No description.* |
| [`EN_AU`](#cdkamazonchimeresourceslanguagecodeenau) | *No description.* |
| [`IT_IT`](#cdkamazonchimeresourceslanguagecodeitit) | *No description.* |
| [`DE_DE`](#cdkamazonchimeresourceslanguagecodedede) | *No description.* |
| [`PT_BR`](#cdkamazonchimeresourceslanguagecodeptbr) | *No description.* |
---
#### `EN_US`
---
#### `EN_GB`
---
#### `ES_US`
---
#### `FR_CA`
---
#### `FR_FR`
---
#### `EN_AU`
---
#### `IT_IT`
---
#### `DE_DE`
---
#### `PT_BR`
---
### LexConfigurationRespondsTo
| **Name** | **Description** |
| --- | --- |
| [`STANDARD_MESSAGES`](#cdkamazonchimeresourceslexconfigurationrespondstostandardmessages) | *No description.* |
---
Props for `Configuration` when Configuration is for Lex.
#### `STANDARD_MESSAGES`
---
### NotificationTargetType
| **Name** | **Description** |
| --- | --- |
| [`EVENTBRIDGE`](#cdkamazonchimeresourcesnotificationtargettypeeventbridge) | *No description.* |
| [`SNS`](#cdkamazonchimeresourcesnotificationtargettypesns) | *No description.* |
| [`SQS`](#cdkamazonchimeresourcesnotificationtargettypesqs) | *No description.* |
---
#### `EVENTBRIDGE`
---
#### `SNS`
---
#### `SQS`
---
### PartialResultsStability
| **Name** | **Description** |
| --- | --- |
| [`HIGH`](#cdkamazonchimeresourcespartialresultsstabilityhigh) | *No description.* |
| [`MEDIUM`](#cdkamazonchimeresourcespartialresultsstabilitymedium) | *No description.* |
| [`LOW`](#cdkamazonchimeresourcespartialresultsstabilitylow) | *No description.* |
---
#### `HIGH`
---
#### `MEDIUM`
---
#### `LOW`
---
### PhoneCountry
| **Name** | **Description** |
| --- | --- |
| [`AU`](#cdkamazonchimeresourcesphonecountryau) | *No description.* |
| [`AT`](#cdkamazonchimeresourcesphonecountryat) | *No description.* |
| [`CA`](#cdkamazonchimeresourcesphonecountryca) | *No description.* |
| [`DK`](#cdkamazonchimeresourcesphonecountrydk) | *No description.* |
| [`DE`](#cdkamazonchimeresourcesphonecountryde) | *No description.* |
| [`IE`](#cdkamazonchimeresourcesphonecountryie) | *No description.* |
| [`IT`](#cdkamazonchimeresourcesphonecountryit) | *No description.* |
| [`NZ`](#cdkamazonchimeresourcesphonecountrynz) | *No description.* |
| [`NG`](#cdkamazonchimeresourcesphonecountryng) | *No description.* |
| [`PR`](#cdkamazonchimeresourcesphonecountrypr) | *No description.* |
| [`KR`](#cdkamazonchimeresourcesphonecountrykr) | *No description.* |
| [`SE`](#cdkamazonchimeresourcesphonecountryse) | *No description.* |
| [`CH`](#cdkamazonchimeresourcesphonecountrych) | *No description.* |
| [`UK`](#cdkamazonchimeresourcesphonecountryuk) | *No description.* |
| [`US`](#cdkamazonchimeresourcesphonecountryus) | *No description.* |
---
#### `AU`
---
#### `AT`
---
#### `CA`
---
#### `DK`
---
#### `DE`
---
#### `IE`
---
#### `IT`
---
#### `NZ`
---
#### `NG`
---
#### `PR`
---
#### `KR`
---
#### `SE`
---
#### `CH`
---
#### `UK`
---
#### `US`
---
### PhoneNumberType
| **Name** | **Description** |
| --- | --- |
| [`LOCAL`](#cdkamazonchimeresourcesphonenumbertypelocal) | *No description.* |
| [`TOLLFREE`](#cdkamazonchimeresourcesphonenumbertypetollfree) | *No description.* |
---
#### `LOCAL`
---
#### `TOLLFREE`
---
### PhoneProductType
| **Name** | **Description** |
| --- | --- |
| [`SMA`](#cdkamazonchimeresourcesphoneproducttypesma) | *No description.* |
| [`VC`](#cdkamazonchimeresourcesphoneproducttypevc) | *No description.* |
---
#### `SMA`
---
#### `VC`
---
### Protocol
| **Name** | **Description** |
| --- | --- |
| [`TCP`](#cdkamazonchimeresourcesprotocoltcp) | *No description.* |
| [`UDP`](#cdkamazonchimeresourcesprotocoludp) | *No description.* |
---
#### `TCP`
---
#### `UDP`
---
### RulesType
| **Name** | **Description** |
| --- | --- |
| [`KEYWORD_MATCH`](#cdkamazonchimeresourcesrulestypekeywordmatch) | *No description.* |
| [`SENTIMENT`](#cdkamazonchimeresourcesrulestypesentiment) | *No description.* |
| [`ISSUE_DETECTION`](#cdkamazonchimeresourcesrulestypeissuedetection) | *No description.* |
---
#### `KEYWORD_MATCH`
---
#### `SENTIMENT`
---
#### `ISSUE_DETECTION`
---
### SentimentType
| **Name** | **Description** |
| --- | --- |
| [`NEGATIVE`](#cdkamazonchimeresourcessentimenttypenegative) | *No description.* |
---
#### `NEGATIVE`
---
### SpeakerSearchStatus
| **Name** | **Description** |
| --- | --- |
| [`ENABLED`](#cdkamazonchimeresourcesspeakersearchstatusenabled) | *No description.* |
| [`DISABLED`](#cdkamazonchimeresourcesspeakersearchstatusdisabled) | *No description.* |
---
#### `ENABLED`
---
#### `DISABLED`
---
### TriggerType
| **Name** | **Description** |
| --- | --- |
| [`TO_PHONE_NUMBER`](#cdkamazonchimeresourcestriggertypetophonenumber) | *No description.* |
| [`REQUEST_URI_HOSTNAME`](#cdkamazonchimeresourcestriggertyperequesturihostname) | *No description.* |
---
#### `TO_PHONE_NUMBER`
---
#### `REQUEST_URI_HOSTNAME`
---
### VocabularyFilterMethod
| **Name** | **Description** |
| --- | --- |
| [`REMOVE`](#cdkamazonchimeresourcesvocabularyfiltermethodremove) | *No description.* |
| [`MASK`](#cdkamazonchimeresourcesvocabularyfiltermethodmask) | *No description.* |
| [`TAG`](#cdkamazonchimeresourcesvocabularyfiltermethodtag) | *No description.* |
---
#### `REMOVE`
---
#### `MASK`
---
#### `TAG`
---
### VoiceToneAnalysisStatus
| **Name** | **Description** |
| --- | --- |
| [`ENABLED`](#cdkamazonchimeresourcesvoicetoneanalysisstatusenabled) | *No description.* |
| [`DISABLED`](#cdkamazonchimeresourcesvoicetoneanalysisstatusdisabled) | *No description.* |
---
#### `ENABLED`
---
#### `DISABLED`
---