interface OAuthParametersProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.QuickSight.CfnDataSource.OAuthParametersProperty |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnDataSource_OAuthParametersProperty |
 Java | software.amazon.awscdk.services.quicksight.CfnDataSource.OAuthParametersProperty |
 Python | aws_cdk.aws_quicksight.CfnDataSource.OAuthParametersProperty |
 TypeScript | aws-cdk-lib » aws_quicksight » CfnDataSource » OAuthParametersProperty |
An object that contains information needed to create a data source connection that uses OAuth client credentials.
This option is available for data source connections that are made with Snowflake and Starburst.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_quicksight as quicksight } from 'aws-cdk-lib';
const oAuthParametersProperty: quicksight.CfnDataSource.OAuthParametersProperty = {
tokenProviderUrl: 'tokenProviderUrl',
// the properties below are optional
identityProviderResourceUri: 'identityProviderResourceUri',
identityProviderVpcConnectionProperties: {
vpcConnectionArn: 'vpcConnectionArn',
},
oAuthScope: 'oAuthScope',
};
Properties
| Name | Type | Description |
|---|---|---|
| token | string | The token endpoint URL of the identity provider. |
| identity | string | The resource uri of the identity provider. |
| identity | IResolvable | Vpc | VPC connection properties. . |
| o | string | The OAuth scope. |
tokenProviderUrl
Type:
string
The token endpoint URL of the identity provider.
identityProviderResourceUri?
Type:
string
(optional)
The resource uri of the identity provider.
identityProviderVpcConnectionProperties?
Type:
IResolvable | Vpc
(optional)
<p>VPC connection properties.
.oAuthScope?
Type:
string
(optional)
The OAuth scope.