This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::VoiceID::Domain
<a name="aws-resource-voiceid-domain"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

Creates a domain that contains all Amazon Connect Voice ID data, such as speakers, fraudsters, customer audio, and voiceprints. Every domain is created with a default watchlist that fraudsters can be a part of.

## Syntax
<a name="aws-resource-voiceid-domain-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-voiceid-domain-syntax.json"></a>

```
{
  "Type" : "AWS::VoiceID::Domain",
  "Properties" : {
      "[Description](#cfn-voiceid-domain-description)" : String,
      "[Name](#cfn-voiceid-domain-name)" : String,
      "[ServerSideEncryptionConfiguration](#cfn-voiceid-domain-serversideencryptionconfiguration)" : ServerSideEncryptionConfiguration,
      "[Tags](#cfn-voiceid-domain-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-voiceid-domain-syntax.yaml"></a>

```
Type: AWS::VoiceID::Domain
Properties:
  [Description](#cfn-voiceid-domain-description): String
  [Name](#cfn-voiceid-domain-name): String
  [ServerSideEncryptionConfiguration](#cfn-voiceid-domain-serversideencryptionconfiguration): 
    ServerSideEncryptionConfiguration
  [Tags](#cfn-voiceid-domain-tags): 
    - Tag
```

## Properties
<a name="aws-resource-voiceid-domain-properties"></a>

`Description`  <a name="cfn-voiceid-domain-description"></a>
The description of the domain.  
*Required*: No  
*Type*: String  
*Pattern*: `^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$`  
*Minimum*: `1`  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-voiceid-domain-name"></a>
The name for the domain.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9][a-zA-Z0-9_-]*$`  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ServerSideEncryptionConfiguration`  <a name="cfn-voiceid-domain-serversideencryptionconfiguration"></a>
The server-side encryption configuration containing the KMS key identifier you want Voice ID to use to encrypt your data.  
*Required*: Yes  
*Type*: [ServerSideEncryptionConfiguration](aws-properties-voiceid-domain-serversideencryptionconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-voiceid-domain-tags"></a>
The tags used to organize, track, or control access for this resource.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-voiceid-domain-tag.md)  
*Minimum*: `0`  
*Maximum*: `200`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-voiceid-domain-return-values"></a>

### Ref
<a name="aws-resource-voiceid-domain-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the `DomainId` of the domain.

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-voiceid-domain-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-voiceid-domain-return-values-fn--getatt-fn--getatt"></a>

`DomainId`  <a name="DomainId-fn::getatt"></a>
The identifier of the domain.

# AWS::VoiceID::Domain ServerSideEncryptionConfiguration
<a name="aws-properties-voiceid-domain-serversideencryptionconfiguration"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

The configuration containing information about the customer managed key used for encrypting customer data.

## Syntax
<a name="aws-properties-voiceid-domain-serversideencryptionconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-voiceid-domain-serversideencryptionconfiguration-syntax.json"></a>

```
{
  "[KmsKeyId](#cfn-voiceid-domain-serversideencryptionconfiguration-kmskeyid)" : String
}
```

### YAML
<a name="aws-properties-voiceid-domain-serversideencryptionconfiguration-syntax.yaml"></a>

```
  [KmsKeyId](#cfn-voiceid-domain-serversideencryptionconfiguration-kmskeyid): String
```

## Properties
<a name="aws-properties-voiceid-domain-serversideencryptionconfiguration-properties"></a>

`KmsKeyId`  <a name="cfn-voiceid-domain-serversideencryptionconfiguration-kmskeyid"></a>
The identifier of the KMS key to use to encrypt data stored by Voice ID. Voice ID doesn't support asymmetric customer managed keys.   
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `2048`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::VoiceID::Domain Tag
<a name="aws-properties-voiceid-domain-tag"></a>

**Important**  
End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit [ Amazon Connect Voice ID end of support](https://docs.aws.amazon.com/connect/latest/adminguide/amazonconnect-voiceid-end-of-support.html).

The tags used to organize, track, or control access for this resource. For example, \$1 "tags": \$1"key1":"value1", "key2":"value2"\$1 \$1.

## Syntax
<a name="aws-properties-voiceid-domain-tag-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-voiceid-domain-tag-syntax.json"></a>

```
{
  "[Key](#cfn-voiceid-domain-tag-key)" : String,
  "[Value](#cfn-voiceid-domain-tag-value)" : String
}
```

### YAML
<a name="aws-properties-voiceid-domain-tag-syntax.yaml"></a>

```
  [Key](#cfn-voiceid-domain-tag-key): String
  [Value](#cfn-voiceid-domain-tag-value): String
```

## Properties
<a name="aws-properties-voiceid-domain-tag-properties"></a>

`Key`  <a name="cfn-voiceid-domain-tag-key"></a>
The first part of a key:value pair that forms a tag associated with a given resource. For example, in the tag 'Department':'Sales', the key is 'Department'.   
*Required*: Yes  
*Type*: String  
*Pattern*: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-voiceid-domain-tag-value"></a>
The second part of a key:value pair that forms a tag associated with a given resource. For example, in the tag 'Department':'Sales', the value is 'Sales'.   
*Required*: Yes  
*Type*: String  
*Pattern*: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)