View a markdown version of this page

AWS::QuickSight::DataSource OAuthClientCredentials - AWS CloudFormation
SyntaxProperties

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::DataSource OAuthClientCredentials

The OAuth 2.0 client credentials used for authenticating a data source connection. Use this structure to provide a client ID, client secret, and username directly instead of referencing a secret stored in Amazon Secrets Manager. This structure supports data sources that use two-legged OAuth (2LO) authentication, such as Snowflake.

Syntax

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

JSON

{
  "ClientId" : String,
  "ClientSecret" : String,
  "Username" : String
}

YAML

  ClientId: String
  ClientSecret: String
  Username: String

Properties

ClientId

The client ID of the OAuth 2.0 application that is registered with the data source provider.

Required: No

Type: String

Minimum: 1

Maximum: 256

Update requires: No interruption

ClientSecret

The client secret of the OAuth 2.0 application that is registered with the data source provider.

Required: No

Type: String

Minimum: 1

Maximum: 2048

Update requires: No interruption

Username

The username of the account that is used for OAuth 2.0 client credentials authentication with the data source provider.

Required: No

Type: String

Minimum: 1

Maximum: 64

Update requires: No interruption