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

# AWS::QuickSight::ActionConnector APIKeyConnectionMetadata
<a name="aws-properties-quicksight-actionconnector-apikeyconnectionmetadata"></a>

Configuration for API key-based authentication to external services.

## Syntax
<a name="aws-properties-quicksight-actionconnector-apikeyconnectionmetadata-syntax"></a>

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

### JSON
<a name="aws-properties-quicksight-actionconnector-apikeyconnectionmetadata-syntax.json"></a>

```
{
  "[ApiKey](#cfn-quicksight-actionconnector-apikeyconnectionmetadata-apikey)" : {{String}},
  "[BaseEndpoint](#cfn-quicksight-actionconnector-apikeyconnectionmetadata-baseendpoint)" : {{String}},
  "[Email](#cfn-quicksight-actionconnector-apikeyconnectionmetadata-email)" : {{String}}
}
```

### YAML
<a name="aws-properties-quicksight-actionconnector-apikeyconnectionmetadata-syntax.yaml"></a>

```
  [ApiKey](#cfn-quicksight-actionconnector-apikeyconnectionmetadata-apikey): {{String}}
  [BaseEndpoint](#cfn-quicksight-actionconnector-apikeyconnectionmetadata-baseendpoint): {{String}}
  [Email](#cfn-quicksight-actionconnector-apikeyconnectionmetadata-email): {{String}}
```

## Properties
<a name="aws-properties-quicksight-actionconnector-apikeyconnectionmetadata-properties"></a>

`ApiKey`  <a name="cfn-quicksight-actionconnector-apikeyconnectionmetadata-apikey"></a>
The API key used for authentication.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`BaseEndpoint`  <a name="cfn-quicksight-actionconnector-apikeyconnectionmetadata-baseendpoint"></a>
The base URL endpoint for the external service.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^https://.*`  
*Minimum*: `1`  
*Maximum*: `8192`  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Email`  <a name="cfn-quicksight-actionconnector-apikeyconnectionmetadata-email"></a>
The email address associated with the API key, if required.  
*Required*: No  
*Type*: String  
*Pattern*: `^[\w.%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,}$`  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)