# Data Types


The Amazon Aurora DSQL API contains several data types that various actions use. This section describes each data type in detail.

**Note**  
The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order.

The following data types are supported:
+  [ClusterSummary](API_ClusterSummary.md) 
+  [EncryptionDetails](API_EncryptionDetails.md) 
+  [MultiRegionProperties](API_MultiRegionProperties.md) 
+  [ValidationExceptionField](API_ValidationExceptionField.md) 

# ClusterSummary


A summary of the properties of a cluster.

## Contents


 ** arn **   <a name="auroradsql-Type-ClusterSummary-arn"></a>
The ARN of the cluster.  
Type: String  
Pattern: `arn:aws(-[^:]+)?:dsql:[a-z0-9-]{1,20}:[0-9]{12}:cluster/[a-z0-9]{26}`   
Required: Yes

 ** identifier **   <a name="auroradsql-Type-ClusterSummary-identifier"></a>
The ID of the cluster.  
Type: String  
Pattern: `[a-z0-9]{26}`   
Required: Yes

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dsql-2018-05-10/ClusterSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dsql-2018-05-10/ClusterSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dsql-2018-05-10/ClusterSummary) 

# EncryptionDetails


Configuration details about encryption for the cluster including the AWS KMS key ARN, encryption type, and encryption status.

## Contents


 ** encryptionStatus **   <a name="auroradsql-Type-EncryptionDetails-encryptionStatus"></a>
The status of encryption for the cluster.  
Type: String  
Valid Values: `ENABLED | UPDATING | KMS_KEY_INACCESSIBLE | ENABLING`   
Required: Yes

 ** encryptionType **   <a name="auroradsql-Type-EncryptionDetails-encryptionType"></a>
The type of encryption that protects the data on your cluster.  
Type: String  
Valid Values: `AWS_OWNED_KMS_KEY | CUSTOMER_MANAGED_KMS_KEY`   
Required: Yes

 ** kmsKeyArn **   <a name="auroradsql-Type-EncryptionDetails-kmsKeyArn"></a>
The ARN of the AWS KMS key that encrypts data in the cluster.  
Type: String  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dsql-2018-05-10/EncryptionDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dsql-2018-05-10/EncryptionDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dsql-2018-05-10/EncryptionDetails) 

# MultiRegionProperties


Defines the structure for multi-Region cluster configurations, containing the witness region and linked cluster settings.

## Contents


 ** clusters **   <a name="auroradsql-Type-MultiRegionProperties-clusters"></a>
The set of peered clusters that form the multi-Region cluster configuration. Each peered cluster represents a database instance in a different Region.  
Type: Array of strings  
Pattern: `arn:aws(-[^:]+)?:dsql:[a-z0-9-]{1,20}:[0-9]{12}:cluster/[a-z0-9]{26}`   
Required: No

 ** witnessRegion **   <a name="auroradsql-Type-MultiRegionProperties-witnessRegion"></a>
The Region that serves as the witness region for a multi-Region cluster. The witness Region helps maintain cluster consistency and quorum.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 50.  
Required: No

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dsql-2018-05-10/MultiRegionProperties) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dsql-2018-05-10/MultiRegionProperties) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dsql-2018-05-10/MultiRegionProperties) 

# ValidationExceptionField


Stores information about a field passed inside a request that resulted in an validation error.

## Contents


 ** message **   <a name="auroradsql-Type-ValidationExceptionField-message"></a>
A message describing why this field failed validation.  
Type: String  
Required: Yes

 ** name **   <a name="auroradsql-Type-ValidationExceptionField-name"></a>
The name of the field.  
Type: String  
Required: Yes

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/dsql-2018-05-10/ValidationExceptionField) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/dsql-2018-05-10/ValidationExceptionField) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/dsql-2018-05-10/ValidationExceptionField)