interface AuthConfigProperty

Language	Type name
.NET	Amazon.CDK.AWS.QuickSight.CfnActionConnector.AuthConfigProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnActionConnector_AuthConfigProperty
Java	software.amazon.awscdk.services.quicksight.CfnActionConnector.AuthConfigProperty
Python	aws_cdk.aws_quicksight.CfnActionConnector.AuthConfigProperty
TypeScript	aws-cdk-lib » aws_quicksight » CfnActionConnector » AuthConfigProperty

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-actionconnector-authconfig.html

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 authConfigProperty: quicksight.CfnActionConnector.AuthConfigProperty = {
  authenticationMetadata: {
    apiKeyConnectionMetadata: {
      apiKey: 'apiKey',
      baseEndpoint: 'baseEndpoint',

      // the properties below are optional
      email: 'email',
    },
    authorizationCodeGrantMetadata: {
      baseEndpoint: 'baseEndpoint',
      redirectUrl: 'redirectUrl',

      // the properties below are optional
      authorizationCodeGrantCredentialsDetails: {
        authorizationCodeGrantDetails: {
          authorizationEndpoint: 'authorizationEndpoint',
          clientId: 'clientId',
          clientSecret: 'clientSecret',
          tokenEndpoint: 'tokenEndpoint',
        },
      },
      authorizationCodeGrantCredentialsSource: 'authorizationCodeGrantCredentialsSource',
    },
    basicAuthConnectionMetadata: {
      baseEndpoint: 'baseEndpoint',
      password: 'password',
      username: 'username',
    },
    clientCredentialsGrantMetadata: {
      baseEndpoint: 'baseEndpoint',

      // the properties below are optional
      clientCredentialsDetails: {
        clientCredentialsGrantDetails: {
          clientId: 'clientId',
          clientSecret: 'clientSecret',
          tokenEndpoint: 'tokenEndpoint',
        },
      },
      clientCredentialsSource: 'clientCredentialsSource',
    },
    iamConnectionMetadata: {
      roleArn: 'roleArn',
    },
    noneConnectionMetadata: {
      baseEndpoint: 'baseEndpoint',
    },
  },
  authenticationType: 'authenticationType',
};

Properties

Name	Type	Description
authenticationMetadata	IResolvable | AuthenticationMetadataProperty
authenticationType	string

---

authenticationMetadata

Type: IResolvable | AuthenticationMetadataProperty

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-actionconnector-authconfig.html#cfn-quicksight-actionconnector-authconfig-authenticationmetadata

---

authenticationType

Type: string

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-actionconnector-authconfig.html#cfn-quicksight-actionconnector-authconfig-authenticationtype