aws-cdk-lib.aws_quicksight.CfnActionConnectorProps

CfnActionConnectorProps Struct

Properties for defining a CfnActionConnector.

Source

Generated code

Type last changed

v2.260.0 · 16 Jun 2026

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 cfnActionConnectorProps: quicksight.CfnActionConnectorProps = {
  actionConnectorId: 'actionConnectorId',
  authenticationConfig: {
    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',
  },
  awsAccountId: 'awsAccountId',
  name: 'name',
  type: 'type',

  // the properties below are optional
  description: 'description',
  permissions: [{
    actions: ['actions'],
    principal: 'principal',
  }],
  tags: [{
    key: 'key',
    value: 'value',
  }],
  vpcConnectionArn: 'vpcConnectionArn',
};

Properties

actionConnectorIdstringaction_connector_idstractionConnectorIdStringActionConnectorIdstringActionConnectorId*stringrequired#

authenticationConfigIResolvable | CfnActionConnector.AuthConfigPropertyauthentication_configtyping.Union[IResolvable, AuthConfigProperty]authenticationConfigIResolvableAuthenticationConfigIResolvableAuthenticationConfiginterface{}required#

awsAccountIdstringaws_account_idstrawsAccountIdStringAwsAccountIdstringAwsAccountId*stringrequired#

descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string#

namestringnamestrnameStringNamestringName*stringrequired#

permissionsIResolvable | IResolvable | CfnActionConnector.ResourcePermissionProperty[]permissionstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ResourcePermissionProperty]]]permissionsIResolvablePermissionsIResolvablePermissionsinterface{}#

tagsCfnTag[]tagstyping.List[CfnTag]tagsList<CfnTag>TagsCfnTag[]Tags*[]CfnTag#

typestringtypestrtypeStringTypestringType*stringrequired#

vpcConnectionArnstringvpc_connection_arnstrvpcConnectionArnStringVpcConnectionArnstringVpcConnectionArn*string#

Used as props by

• CfnActionConnector