AWS::QuickSight::ActionConnector APIKeyConnectionMetadata - AWS CloudFormation
SyntaxProperties
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

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.

AWS::QuickSight::ActionConnector APIKeyConnectionMetadata

Configuration for API key-based authentication to external services.

Syntax

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

JSON

{
  "ApiKey" : String,
  "BaseEndpoint" : String,
  "Email" : String
}

YAML

  ApiKey: String
  BaseEndpoint: String
  Email: String

Properties

ApiKey

The API key used for authentication.

Required: Yes

Type: String

Update requires: No interruption

BaseEndpoint

The base URL endpoint for the external service.

Required: Yes

Type: String

Pattern: ^https://.*

Minimum: 1

Maximum: 8192

Update requires: No interruption

Email

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