interface AuthenticationMetadataProperty

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-actionconnector-authenticationmetadata.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 authenticationMetadataProperty: quicksight.CfnActionConnector.AuthenticationMetadataProperty = {
  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',
  },
};

Properties

Name	Type	Description
apiKeyConnectionMetadata?	IResolvable | APIKeyConnectionMetadataProperty
authorizationCodeGrantMetadata?	IResolvable | AuthorizationCodeGrantMetadataProperty
basicAuthConnectionMetadata?	IResolvable | BasicAuthConnectionMetadataProperty
clientCredentialsGrantMetadata?	IResolvable | ClientCredentialsGrantMetadataProperty
iamConnectionMetadata?	IResolvable | IAMConnectionMetadataProperty
noneConnectionMetadata?	IResolvable | NoneConnectionMetadataProperty

---

apiKeyConnectionMetadata?

Type: IResolvable | APIKeyConnectionMetadataProperty (optional)

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

---

authorizationCodeGrantMetadata?

Type: IResolvable | AuthorizationCodeGrantMetadataProperty (optional)

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

---

basicAuthConnectionMetadata?

Type: IResolvable | BasicAuthConnectionMetadataProperty (optional)

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

---

clientCredentialsGrantMetadata?

Type: IResolvable | ClientCredentialsGrantMetadataProperty (optional)

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

---

iamConnectionMetadata?

Type: IResolvable | IAMConnectionMetadataProperty (optional)

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

---

noneConnectionMetadata?

Type: IResolvable | NoneConnectionMetadataProperty (optional)

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