aws-cdk-lib/aws-qbusiness/lib/qbusiness.generated.d.ts

Version 2 of the AWS Cloud Development Kit library

import * as cdk from "../../core/lib";
import * as constructs from "constructs";
import * as cfn_parse from "../../core/lib/helpers-internal";
import { ApplicationReference, DataAccessorReference, DataSourceReference, IApplicationRef, IDataAccessorRef, IDataSourceRef, IIndexRef, IndexReference, IPermissionRef, IPluginRef, IRetrieverRef, IWebExperienceRef, PermissionReference, PluginReference, RetrieverReference, WebExperienceReference } from "../../interfaces/generated/aws-qbusiness-interfaces.generated";
/**
 * Creates an Amazon Q Business application.
 *
 * > There are new tiers for Amazon Q Business. Not all features in Amazon Q Business Pro are also available in Amazon Q Business Lite. For information on what's included in Amazon Q Business Lite and what's included in Amazon Q Business Pro, see [Amazon Q Business tiers](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/tiers.html#user-sub-tiers) . You must use the Amazon Q Business console to assign subscription tiers to users.
 * >
 * > An Amazon Q Apps service linked role will be created if it's absent in the AWS account when `QAppsConfiguration` is enabled in the request. For more information, see [Using service-linked roles for Q Apps](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/using-service-linked-roles-qapps.html) .
 * >
 * > When you create an application, Amazon Q Business may securely transmit data for processing from your selected AWS region, but within your geography. For more information, see [Cross region inference in Amazon Q Business](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/cross-region-inference.html) .
 *
 * @cloudformationResource AWS::QBusiness::Application
 * @stability external
 * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-application.html
 */
export declare class CfnApplication extends cdk.CfnResource implements cdk.IInspectable, IApplicationRef, cdk.ITaggableV2 {
    /**
     * The CloudFormation resource type name for this resource class.
     */
    static readonly CFN_RESOURCE_TYPE_NAME: string;
    /**
     * Build a CfnApplication from CloudFormation properties
     *
     * A factory method that creates a new instance of this class from an object
     * containing the CloudFormation properties of this resource.
     * Used in the @aws-cdk/cloudformation-include module.
     *
     * @internal
     */
    static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnApplication;
    /**
     * Checks whether the given object is a CfnApplication
     */
    static isCfnApplication(x: any): x is CfnApplication;
    /**
     * Creates a new IApplicationRef from an ARN
     */
    static fromApplicationArn(scope: constructs.Construct, id: string, arn: string): IApplicationRef;
    /**
     * Creates a new IApplicationRef from a applicationId
     */
    static fromApplicationId(scope: constructs.Construct, id: string, applicationId: string): IApplicationRef;
    static arnForApplication(resource: IApplicationRef): string;
    /**
     * Configuration information for the file upload during chat feature.
     */
    private _attachmentsConfiguration?;
    /**
     * Subscription configuration information for an Amazon Q Business application using IAM identity federation for user management.
     */
    private _autoSubscriptionConfiguration?;
    /**
     * Tag Manager which manages the tags for this resource
     */
    readonly cdkTagManager: cdk.TagManager;
    /**
     * The OIDC client ID for a Amazon Q Business application.
     */
    private _clientIdsForOidc?;
    /**
     * A description for the Amazon Q Business application.
     */
    private _description?;
    /**
     * The name of the Amazon Q Business application.
     */
    private _displayName;
    /**
     * Provides the identifier of the AWS  key used to encrypt data indexed by Amazon Q Business.
     */
    private _encryptionConfiguration?;
    /**
     * The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application.
     */
    private _iamIdentityProviderArn?;
    /**
     * The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application.
     */
    private _identityCenterInstanceArn?;
    /**
     * The authentication type being used by a Amazon Q Business application.
     */
    private _identityType?;
    /**
     * Configuration information about chat response personalization.
     */
    private _personalizationConfiguration?;
    /**
     * Configuration information about Amazon Q Apps.
     */
    private _qAppsConfiguration?;
    /**
     * The Amazon Quick Suite configuration for an Amazon Q Business application that uses Quick Suite as the identity provider.
     */
    private _quickSightConfiguration?;
    /**
     * The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics.
     */
    private _roleArn?;
    /**
     * A list of key-value pairs that identify or categorize your Amazon Q Business application.
     */
    private _tags?;
    protected readonly cfnPropertyNames: Record<string, string>;
    /**
     * Create a new `AWS::QBusiness::Application`.
     *
     * @param scope Scope in which this resource is defined
     * @param id Construct identifier for this resource (unique in its scope)
     * @param props Resource properties
     */
    constructor(scope: constructs.Construct, id: string, props: CfnApplicationProps);
    get applicationRef(): ApplicationReference;
    /**
     * Configuration information for the file upload during chat feature.
     */
    get attachmentsConfiguration(): CfnApplication.AttachmentsConfigurationProperty | cdk.IResolvable | undefined;
    /**
     * Configuration information for the file upload during chat feature.
     */
    set attachmentsConfiguration(value: CfnApplication.AttachmentsConfigurationProperty | cdk.IResolvable | undefined);
    /**
     * Subscription configuration information for an Amazon Q Business application using IAM identity federation for user management.
     */
    get autoSubscriptionConfiguration(): CfnApplication.AutoSubscriptionConfigurationProperty | cdk.IResolvable | undefined;
    /**
     * Subscription configuration information for an Amazon Q Business application using IAM identity federation for user management.
     */
    set autoSubscriptionConfiguration(value: CfnApplication.AutoSubscriptionConfigurationProperty | cdk.IResolvable | undefined);
    /**
     * The OIDC client ID for a Amazon Q Business application.
     */
    get clientIdsForOidc(): Array<string> | undefined;
    /**
     * The OIDC client ID for a Amazon Q Business application.
     */
    set clientIdsForOidc(value: Array<string> | undefined);
    /**
     * A description for the Amazon Q Business application.
     */
    get description(): string | undefined;
    /**
     * A description for the Amazon Q Business application.
     */
    set description(value: string | undefined);
    /**
     * The name of the Amazon Q Business application.
     */
    get displayName(): string;
    /**
     * The name of the Amazon Q Business application.
     */
    set displayName(value: string);
    /**
     * Provides the identifier of the AWS  key used to encrypt data indexed by Amazon Q Business.
     */
    get encryptionConfiguration(): CfnApplication.EncryptionConfigurationProperty | cdk.IResolvable | undefined;
    /**
     * Provides the identifier of the AWS  key used to encrypt data indexed by Amazon Q Business.
     */
    set encryptionConfiguration(value: CfnApplication.EncryptionConfigurationProperty | cdk.IResolvable | undefined);
    /**
     * The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application.
     */
    get iamIdentityProviderArn(): string | undefined;
    /**
     * The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application.
     */
    set iamIdentityProviderArn(value: string | undefined);
    /**
     * The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application.
     */
    get identityCenterInstanceArn(): string | undefined;
    /**
     * The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application.
     */
    set identityCenterInstanceArn(value: string | undefined);
    /**
     * The authentication type being used by a Amazon Q Business application.
     */
    get identityType(): string | undefined;
    /**
     * The authentication type being used by a Amazon Q Business application.
     */
    set identityType(value: string | undefined);
    /**
     * Configuration information about chat response personalization.
     */
    get personalizationConfiguration(): cdk.IResolvable | CfnApplication.PersonalizationConfigurationProperty | undefined;
    /**
     * Configuration information about chat response personalization.
     */
    set personalizationConfiguration(value: cdk.IResolvable | CfnApplication.PersonalizationConfigurationProperty | undefined);
    /**
     * Configuration information about Amazon Q Apps.
     */
    get qAppsConfiguration(): cdk.IResolvable | CfnApplication.QAppsConfigurationProperty | undefined;
    /**
     * Configuration information about Amazon Q Apps.
     */
    set qAppsConfiguration(value: cdk.IResolvable | CfnApplication.QAppsConfigurationProperty | undefined);
    /**
     * The Amazon Quick Suite configuration for an Amazon Q Business application that uses Quick Suite as the identity provider.
     */
    get quickSightConfiguration(): cdk.IResolvable | CfnApplication.QuickSightConfigurationProperty | undefined;
    /**
     * The Amazon Quick Suite configuration for an Amazon Q Business application that uses Quick Suite as the identity provider.
     */
    set quickSightConfiguration(value: cdk.IResolvable | CfnApplication.QuickSightConfigurationProperty | undefined);
    /**
     * The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics.
     */
    get roleArn(): string | undefined;
    /**
     * The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics.
     */
    set roleArn(value: string | undefined);
    /**
     * A list of key-value pairs that identify or categorize your Amazon Q Business application.
     */
    get tags(): Array<cdk.CfnTag> | undefined;
    /**
     * A list of key-value pairs that identify or categorize your Amazon Q Business application.
     */
    set tags(value: Array<cdk.CfnTag> | undefined);
    /**
     * The Amazon Resource Name (ARN) of the Amazon Q Business application.
     *
     * @cloudformationAttribute ApplicationArn
     */
    get attrApplicationArn(): string;
    /**
     * The identifier for the Amazon Q Business application.
     *
     * @cloudformationAttribute ApplicationId
     */
    get attrApplicationId(): string;
    /**
     * The Unix timestamp when the Amazon Q Business application was created.
     *
     * @cloudformationAttribute CreatedAt
     */
    get attrCreatedAt(): string;
    /**
     * The Amazon Resource Name (ARN) of the AWS SSO instance attached to your Amazon Q Business application.
     *
     * @cloudformationAttribute IdentityCenterApplicationArn
     */
    get attrIdentityCenterApplicationArn(): string;
    /**
     * The status of the Amazon Q Business application. The application is ready to use when the status is `ACTIVE` .
     *
     * @cloudformationAttribute Status
     */
    get attrStatus(): string;
    /**
     * The Unix timestamp when the Amazon Q Business application was last updated.
     *
     * @cloudformationAttribute UpdatedAt
     */
    get attrUpdatedAt(): string;
    protected get cfnProperties(): Record<string, any>;
    /**
     * Examines the CloudFormation resource and discloses attributes
     *
     * @param inspector tree inspector to collect and process attributes
     */
    inspect(inspector: cdk.TreeInspector): void;
    protected renderProperties(props: Record<string, any>): Record<string, any>;
}
export declare namespace CfnApplication {
    /**
     * Configuration information for the file upload during chat feature.
     *
     * @struct
     * @stability external
     * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-application-attachmentsconfiguration.html
     */
    interface AttachmentsConfigurationProperty {
        /**
         * Status information about whether file upload functionality is activated or deactivated for your end user.
         *
         * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-application-attachmentsconfiguration.html#cfn-qbusiness-application-attachmentsconfiguration-attachmentscontrolmode
         */
        readonly attachmentsControlMode: string;
    }
    /**
     * Subscription configuration information for an Amazon Q Business application using IAM identity federation for user management.
     *
     * @struct
     * @stability external
     * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-application-autosubscriptionconfiguration.html
     */
    interface AutoSubscriptionConfigurationProperty {
        /**
         * Describes whether automatic subscriptions are enabled for an Amazon Q Business application using IAM identity federation for user management.
         *
         * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-application-autosubscriptionconfiguration.html#cfn-qbusiness-application-autosubscriptionconfiguration-autosubscribe
         */
        readonly autoSubscribe: string;
        /**
         * Describes the default subscription type assigned to an Amazon Q Business application using IAM identity federation for user management.
         *
         * If the value for `autoSubscribe` is set to `ENABLED` you must select a value for this field.
         *
         * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-application-autosubscriptionconfiguration.html#cfn-qbusiness-application-autosubscriptionconfiguration-defaultsubscriptiontype
         */
        readonly defaultSubscriptionType?: string;
    }
    /**
     * Provides the identifier of the AWS  key used to encrypt data indexed by Amazon Q Business.
     *
     * Amazon Q Business doesn't support asymmetric keys.
     *
     * @struct
     * @stability external
     * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-application-encryptionconfiguration.html
     */
    interface EncryptionConfigurationProperty {
        /**
         * The identifier of the AWS  key.
         *
         * Amazon Q Business doesn't support asymmetric keys.
         *
         * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-application-encryptionconfiguration.html#cfn-qbusiness-application-encryptionconfiguration-kmskeyid
         */
        readonly kmsKeyId?: string;
    }
    /**
     * Configuration information about chat response personalization.
     *
     * For more information, see [Personalizing chat responses](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/personalizing-chat-responses.html) .
     *
     * @struct
     * @stability external
     * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-application-personalizationconfiguration.html
     */
    interface PersonalizationConfigurationProperty {
        /**
         * An option to allow Amazon Q Business to customize chat responses using user specific metadata—specifically, location and job information—in your IAM Identity Center instance.
         *
         * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-application-personalizationconfiguration.html#cfn-qbusiness-application-personalizationconfiguration-personalizationcontrolmode
         */
        readonly personalizationControlMode: string;
    }
    /**
     * Configuration information about Amazon Q Apps.
     *
     * @struct
     * @stability external
     * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-application-qappsconfiguration.html
     */
    interface QAppsConfigurationProperty {
        /**
         * Status information about whether end users can create and use Amazon Q Apps in the web experience.
         *
         * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-application-qappsconfiguration.html#cfn-qbusiness-application-qappsconfiguration-qappscontrolmode
         */
        readonly qAppsControlMode: string;
    }
    /**
     * The Amazon Quick Suite configuration for an Amazon Q Business application that uses Quick Suite as the identity provider.
     *
     * For more information, see [Creating an Amazon Quick Suite integrated application](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/create-quicksight-integrated-application.html) .
     *
     * @struct
     * @stability external
     * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-application-quicksightconfiguration.html
     */
    interface QuickSightConfigurationProperty {
        /**
         * The Amazon Quick Suite namespace that is used as the identity provider.
         *
         * For more information about Quick Suite namespaces, see [Namespace operations](https://docs.aws.amazon.com/quicksight/latest/developerguide/namespace-operations.html) .
         *
         * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-application-quicksightconfiguration.html#cfn-qbusiness-application-quicksightconfiguration-clientnamespace
         */
        readonly clientNamespace: string;
    }
}
/**
 * Properties for defining a `CfnApplication`
 *
 * @struct
 * @stability external
 * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-application.html
 */
export interface CfnApplicationProps {
    /**
     * Configuration information for the file upload during chat feature.
     *
     * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-application.html#cfn-qbusiness-application-attachmentsconfiguration
     */
    readonly attachmentsConfiguration?: CfnApplication.AttachmentsConfigurationProperty | cdk.IResolvable;
    /**
     * Subscription configuration information for an Amazon Q Business application using IAM identity federation for user management.
     *
     * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-application.html#cfn-qbusiness-application-autosubscriptionconfiguration
     */
    readonly autoSubscriptionConfiguration?: CfnApplication.AutoSubscriptionConfigurationProperty | cdk.IResolvable;
    /**
     * The OIDC client ID for a Amazon Q Business application.
     *
     * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-application.html#cfn-qbusiness-application-clientidsforoidc
     */
    readonly clientIdsForOidc?: Array<string>;
    /**
     * A description for the Amazon Q Business application.
     *
     * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-application.html#cfn-qbusiness-application-description
     */
    readonly description?: string;
    /**
     * The name of the Amazon Q Business application.
     *
     * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-application.html#cfn-qbusiness-application-displayname
     */
    readonly displayName: string;
    /**
     * Provides the identifier of the AWS  key used to encrypt data indexed by Amazon Q Business.
     *
     * Amazon Q Business doesn't support asymmetric keys.
     *
     * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-application.html#cfn-qbusiness-application-encryptionconfiguration
     */
    readonly encryptionConfiguration?: CfnApplication.EncryptionConfigurationProperty | cdk.IResolvable;
    /**
     * The Amazon Resource Name (ARN) of an identity provider being used by an Amazon Q Business application.
     *
     * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-application.html#cfn-qbusiness-application-iamidentityproviderarn
     */
    readonly iamIdentityProviderArn?: string;
    /**
     * The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either creating for—or connecting to—your Amazon Q Business application.
     *
     * *Required* : `Yes`
     *
     * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-application.html#cfn-qbusiness-application-identitycenterinstancearn
     */
    readonly identityCenterInstanceArn?: string;
    /**
     * The authentication type being used by a Amazon Q Business application.
     *
     * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-application.html#cfn-qbusiness-application-identitytype
     */
    readonly identityType?: string;
    /**
     * Configuration information about chat response personalization.
     *
     * For more information, see [Personalizing chat responses](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/personalizing-chat-responses.html) .
     *
     * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-application.html#cfn-qbusiness-application-personalizationconfiguration
     */
    readonly personalizationConfiguration?: cdk.IResolvable | CfnApplication.PersonalizationConfigurationProperty;
    /**
     * Configuration information about Amazon Q Apps.
     *
     * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-application.html#cfn-qbusiness-application-qappsconfiguration
     */
    readonly qAppsConfiguration?: cdk.IResolvable | CfnApplication.QAppsConfigurationProperty;
    /**
     * The Amazon Quick Suite configuration for an Amazon Q Business application that uses Quick Suite as the identity provider.
     *
     * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-application.html#cfn-qbusiness-application-quicksightconfiguration
     */
    readonly quickSightConfiguration?: cdk.IResolvable | CfnApplication.QuickSightConfigurationProperty;
    /**
     * The Amazon Resource Name (ARN) of an IAM role with permissions to access your Amazon CloudWatch logs and metrics.
     *
     * If this property is not specified, Amazon Q Business will create a [service linked role (SLR)](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/using-service-linked-roles.html#slr-permissions) and use it as the application's role.
     *
     * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-application.html#cfn-qbusiness-application-rolearn
     */
    readonly roleArn?: string;
    /**
     * A list of key-value pairs that identify or categorize your Amazon Q Business application.
     *
     * You can also use tags to help control access to the application. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
     *
     * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-application.html#cfn-qbusiness-application-tags
     */
    readonly tags?: Array<cdk.CfnTag>;
}
/**
 * Creates a new data accessor for an ISV to access data from a Amazon Q Business application.
 *
 * The data accessor is an entity that represents the ISV's access to the Amazon Q Business application's data. It includes the IAM role ARN for the ISV, a friendly name, and a set of action configurations that define the specific actions the ISV is allowed to perform and any associated data filters. When the data accessor is created, an IAM Identity Center application is also created to manage the ISV's identity and authentication for accessing the Amazon Q Business application.
 *
 * @cloudformationResource AWS::QBusiness::DataAccessor
 * @stability external
 * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-dataaccessor.html
 */
export declare class CfnDataAccessor extends cdk.CfnResource implements cdk.IInspectable, IDataAccessorRef, cdk.ITaggableV2 {
    /**
     * The CloudFormation resource type name for this resource class.
     */
    static readonly CFN_RESOURCE_TYPE_NAME: string;
    /**
     * Build a CfnDataAccessor from CloudFormation properties
     *
     * A factory method that creates a new instance of this class from an object
     * containing the CloudFormation properties of this resource.
     * Used in the @aws-cdk/cloudformation-include module.
     *
     * @internal
     */
    static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnDataAccessor;
    /**
     * Checks whether the given object is a CfnDataAccessor
     */
    static isCfnDataAccessor(x: any): x is CfnDataAccessor;
    static arnForDataAccessor(resource: IDataAccessorRef): string;
    /**
     * A list of action configurations specifying the allowed actions and any associated filters.
     */
    private _actionConfigurations;
    /**
     * The unique identifier of the Amazon Q Business application.
     */
    private _applicationId;
    /**
     * The authentication configuration details for the data accessor.
     */
    private _authenticationDetail?;
    /**
     * Tag Manager which manages the tags for this resource
     */
    readonly cdkTagManager: cdk.TagManager;
    /**
     * The friendly name of the data accessor.
     */
    private _displayName;
    /**
     * The Amazon Resource Name (ARN) of the IAM role for the ISV associated with this data accessor.
     */
    private _principal;
    /**
     * The tags to associate with the data accessor.
     */
    private _tags?;
    protected readonly cfnPropertyNames: Record<string, string>;
    /**
     * Create a new `AWS::QBusiness::DataAccessor`.
     *
     * @param scope Scope in which this resource is defined
     * @param id Construct identifier for this resource (unique in its scope)
     * @param props Resource properties
     */
    constructor(scope: constructs.Construct, id: string, props: CfnDataAccessorProps);
    get dataAccessorRef(): DataAccessorReference;
    /**
     * A list of action configurations specifying the allowed actions and any associated filters.
     */
    get actionConfigurations(): Array<CfnDataAccessor.ActionConfigurationProperty | cdk.IResolvable> | cdk.IResolvable;
    /**
     * A list of action configurations specifying the allowed actions and any associated filters.
     */
    set actionConfigurations(value: Array<CfnDataAccessor.ActionConfigurationProperty | cdk.IResolvable> | cdk.IResolvable);
    /**
     * The unique identifier of the Amazon Q Business application.
     */
    get applicationId(): string;
    /**
     * The unique identifier of the Amazon Q Business application.
     */
    set applicationId(value: string);
    /**
     * The authentication configuration details for the data accessor.
     */
    get authenticationDetail(): CfnDataAccessor.DataAccessorAuthenticationDetailProperty | cdk.IResolvable | undefined;
    /**
     * The authentication configuration details for the data accessor.
     */
    set authenticationDetail(value: CfnDataAccessor.DataAccessorAuthenticationDetailProperty | cdk.IResolvable | undefined);
    /**
     * The friendly name of the data accessor.
     */
    get displayName(): string;
    /**
     * The friendly name of the data accessor.
     */
    set displayName(value: string);
    /**
     * The Amazon Resource Name (ARN) of the IAM role for the ISV associated with this data accessor.
     */
    get principal(): string;
    /**
     * The Amazon Resource Name (ARN) of the IAM role for the ISV associated with this data accessor.
     */
    set principal(value: string);
    /**
     * The tags to associate with the data accessor.
     */
    get tags(): Array<cdk.CfnTag> | undefined;
    /**
     * The tags to associate with the data accessor.
     */
    set tags(value: Array<cdk.CfnTag> | undefined);
    /**
     * The timestamp when the data accessor was created.
     *
     * @cloudformationAttribute CreatedAt
     */
    get attrCreatedAt(): string;
    /**
     * The Amazon Resource Name (ARN) of the data accessor.
     *
     * @cloudformationAttribute DataAccessorArn
     */
    get attrDataAccessorArn(): string;
    /**
     * The unique identifier of the data accessor.
     *
     * @cloudformationAttribute DataAccessorId
     */
    get attrDataAccessorId(): string;
    /**
     * The Amazon Resource Name (ARN) of the associated IAM Identity Center application.
     *
     * @cloudformationAttribute IdcApplicationArn
     */
    get attrIdcApplicationArn(): string;
    /**
     * The timestamp when the data accessor was last updated.
     *
     * @cloudformationAttribute UpdatedAt
     */
    get attrUpdatedAt(): string;
    protected get cfnProperties(): Record<string, any>;
    /**
     * Examines the CloudFormation resource and discloses attributes
     *
     * @param inspector tree inspector to collect and process attributes
     */
    inspect(inspector: cdk.TreeInspector): void;
    protected renderProperties(props: Record<string, any>): Record<string, any>;
}
export declare namespace CfnDataAccessor {
    /**
     * Specifies an allowed action and its associated filter configuration.
     *
     * @struct
     * @stability external
     * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-actionconfiguration.html
     */
    interface ActionConfigurationProperty {
        /**
         * The Amazon Q Business action that is allowed.
         *
         * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-actionconfiguration.html#cfn-qbusiness-dataaccessor-actionconfiguration-action
         */
        readonly action: string;
        /**
         * The filter configuration for the action, if any.
         *
         * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-actionconfiguration.html#cfn-qbusiness-dataaccessor-actionconfiguration-filterconfiguration
         */
        readonly filterConfiguration?: CfnDataAccessor.ActionFilterConfigurationProperty | cdk.IResolvable;
    }
    /**
     * Specifies filters to apply to an allowed action.
     *
     * @struct
     * @stability external
     * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-actionfilterconfiguration.html
     */
    interface ActionFilterConfigurationProperty {
        /**
         * Enables filtering of responses based on document attributes or metadata fields.
         *
         * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-actionfilterconfiguration.html#cfn-qbusiness-dataaccessor-actionfilterconfiguration-documentattributefilter
         */
        readonly documentAttributeFilter: CfnDataAccessor.AttributeFilterProperty | cdk.IResolvable;
    }
    /**
     * Enables filtering of responses based on document attributes or metadata fields.
     *
     * @struct
     * @stability external
     * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html
     */
    interface AttributeFilterProperty {
        /**
         * Performs a logical `AND` operation on all supplied filters.
         *
         * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html#cfn-qbusiness-dataaccessor-attributefilter-andallfilters
         */
        readonly andAllFilters?: Array<CfnDataAccessor.AttributeFilterProperty | cdk.IResolvable> | cdk.IResolvable;
        /**
         * Returns `true` when a document contains all the specified document attributes or metadata fields.
         *
         * Supported for the following [document attribute value types](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html) : `stringListValue` .
         *
         * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html#cfn-qbusiness-dataaccessor-attributefilter-containsall
         */
        readonly containsAll?: CfnDataAccessor.DocumentAttributeProperty | cdk.IResolvable;
        /**
         * Returns `true` when a document contains any of the specified document attributes or metadata fields.
         *
         * Supported for the following [document attribute value types](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html) : `stringListValue` .
         *
         * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html#cfn-qbusiness-dataaccessor-attributefilter-containsany
         */
        readonly containsAny?: CfnDataAccessor.DocumentAttributeProperty | cdk.IResolvable;
        /**
         * Performs an equals operation on two document attributes or metadata fields.
         *
         * Supported for the following [document attribute value types](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html) : `dateValue` , `longValue` , `stringListValue` and `stringValue` .
         *
         * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html#cfn-qbusiness-dataaccessor-attributefilter-equalsto
         */
        readonly equalsTo?: CfnDataAccessor.DocumentAttributeProperty | cdk.IResolvable;
        /**
         * Performs a greater than operation on two document attributes or metadata fields.
         *
         * Supported for the following [document attribute value types](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html) : `dateValue` and `longValue` .
         *
         * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html#cfn-qbusiness-dataaccessor-attributefilter-greaterthan
         */
        readonly greaterThan?: CfnDataAccessor.DocumentAttributeProperty | cdk.IResolvable;
        /**
         * Performs a greater or equals than operation on two document attributes or metadata fields.
         *
         * Supported for the following [document attribute value types](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html) : `dateValue` and `longValue` .
         *
         * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html#cfn-qbusiness-dataaccessor-attributefilter-greaterthanorequals
         */
        readonly greaterThanOrEquals?: CfnDataAccessor.DocumentAttributeProperty | cdk.IResolvable;
        /**
         * Performs a less than operation on two document attributes or metadata fields.
         *
         * Supported for the following [document attribute value types](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html) : `dateValue` and `longValue` .
         *
         * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html#cfn-qbusiness-dataaccessor-attributefilter-lessthan
         */
        readonly lessThan?: CfnDataAccessor.DocumentAttributeProperty | cdk.IResolvable;
        /**
         * Performs a less than or equals operation on two document attributes or metadata fields.Supported for the following [document attribute value type](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html) : `dateValue` and `longValue` .
         *
         * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html#cfn-qbusiness-dataaccessor-attributefilter-lessthanorequals
         */
        readonly lessThanOrEquals?: CfnDataAccessor.DocumentAttributeProperty | cdk.IResolvable;
        /**
         * Performs a logical `NOT` operation on all supplied filters.
         *
         * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html#cfn-qbusiness-dataaccessor-attributefilter-notfilter
         */
        readonly notFilter?: CfnDataAccessor.AttributeFilterProperty | cdk.IResolvable;
        /**
         * Performs a logical `OR` operation on all supplied filters.
         *
         * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html#cfn-qbusiness-dataaccessor-attributefilter-orallfilters
         */
        readonly orAllFilters?: Array<CfnDataAccessor.AttributeFilterProperty | cdk.IResolvable> | cdk.IResolvable;
    }
    /**
     * A document attribute or metadata field.
     *
     * @struct
     * @stability external
     * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-documentattribute.html
     */
    interface DocumentAttributeProperty {
        /**
         * The identifier for the attribute.
         *
         * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-documentattribute.html#cfn-qbusiness-dataaccessor-documentattribute-name
         */
        readonly name: string;
        /**
         * The value of the attribute.
         *
         * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-documentattribute.html#cfn-qbusiness-dataaccessor-documentattribute-value
         */
        readonly value: CfnDataAccessor.DocumentAttributeValueProperty | cdk.IResolvable;
    }
    /**
     * The value of a document attribute.
     *
     * You can only provide one value for a document attribute.
     *
     * @struct
     * @stability external
     * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-documentattributevalue.html
     */
    interface DocumentAttributeValueProperty {
        /**
         * A date expressed as an ISO 8601 string.
         *
         * It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
         *
         * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-documentattributevalue.html#cfn-qbusiness-dataaccessor-documentattributevalue-datevalue
         */
        readonly dateValue?: string;
        /**
         * A long integer value.
         *
         * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-documentattributevalue.html#cfn-qbusiness-dataaccessor-documentattributevalue-longvalue
         */
        readonly longValue?: number;
        /**
         * A list of strings.
         *
         * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-documentattributevalue.html#cfn-qbusiness-dataaccessor-documentattributevalue-stringlistvalue
         */
        readonly stringListValue?: Array<string>;
        /**
         * A string.
         *
         * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-documentattributevalue.html#cfn-qbusiness-dataaccessor-documentattributevalue-stringvalue
         */
        readonly stringValue?: string;
    }
    /**
     * Contains the authentication configuration details for a data accessor.
     *
     * This structure defines how the ISV authenticates when accessing data through the data accessor.
     *
     * @struct
     * @stability external
     * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-dataaccessorauthenticationdetail.html
     */
    interface DataAccessorAuthenticationDetailProperty {
        /**
         * The specific authentication configuration based on the authentication type.
         *
         * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-dataaccessorauthenticationdetail.html#cfn-qbusiness-dataaccessor-dataaccessorauthenticationdetail-authenticationconfiguration
         */
        readonly authenticationConfiguration?: CfnDataAccessor.DataAccessorAuthenticationConfigurationProperty | cdk.IResolvable;
        /**
         * The type of authentication to use for the data accessor.
         *
         * This determines how the ISV authenticates when accessing data. You can use one of two authentication types:
         *
         * - `AWS_IAM_IDC_TTI` - Authentication using IAM Identity Center Trusted Token Issuer (TTI). This authentication type allows the ISV to use a trusted token issuer to generate tokens for accessing the data.
         * - `AWS_IAM_IDC_AUTH_CODE` - Authentication using IAM Identity Center authorization code flow. This authentication type uses the standard OAuth 2.0 authorization code flow for authentication.
         *
         * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-dataaccessorauthenticationdetail.html#cfn-qbusiness-dataaccessor-dataaccessorauthenticationdetail-authenticationtype
         */
        readonly authenticationType: string;
        /**
         * A list of external identifiers associated with this authentication configuration.
         *
         * These are used to correlate the data accessor with external systems.
         *
         * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-dataaccessorauthenticationdetail.html#cfn-qbusiness-dataaccessor-dataaccessorauthenticationdetail-externalids
         */
        readonly externalIds?: Array<string>;
    }
    /**
     * A union type that contains the specific authentication configuration based on the authentication type selected.
     *
     * @struct
     * @stability external
     * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-dataaccessorauthenticationconfiguration.html
     */
    interface DataAccessorAuthenticationConfigurationProperty {
        /**
         * Configuration for IAM Identity Center Trusted Token Issuer (TTI) authentication used when the authentication type is `AWS_IAM_IDC_TTI` .
         *
         * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-dataaccessorauthenticationconfiguration.html#cfn-qbusiness-dataaccessor-dataaccessorauthenticationconfiguration-idctrustedtokenissuerconfiguration
         */
        readonly idcTrustedTokenIssuerConfiguration: CfnDataAccessor.DataAccessorIdcTrustedTokenIssuerConfigurationProperty | cdk.IResolvable;
    }
    /**
     * Configuration details for IAM Identity Center Trusted Token Issuer (TTI) authentication.
     *
     * @struct
     * @stability external
     * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-dataaccessoridctrustedtokenissuerconfiguration.html
     */
    interface DataAccessorIdcTrustedTokenIssuerConfigurationProperty {
        /**
         * The Amazon Resource Name (ARN) of the IAM Identity Center Trusted Token Issuer that will be used for authentication.
         *
         * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-dataaccessoridctrustedtokenissuerconfiguration.html#cfn-qbusiness-dataaccessor-dataaccessoridctrustedtokenissuerconfiguration-idctrustedtokenissuerarn
         */
        readonly idcTrustedTokenIssuerArn: string;
    }
}
/**
 * Properties for defining a `CfnDataAccessor`
 *
 * @struct
 * @stability external
 * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-dataaccessor.html
 */
export interface CfnDataAccessorProps {
    /**
     * A list of action configurations specifying the allowed actions and any associated filters.
     *
     * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-dataaccessor.html#cfn-qbusiness-dataaccessor-actionconfigurations
     */
    readonly actionConfigurations: Array<CfnDataAccessor.ActionConfigurationProperty | cdk.IResolvable> | cdk.IResolvable;
    /**
     * The unique identifier of the Amazon Q Business application.
     *
     * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-dataaccessor.html#cfn-qbusiness-dataaccessor-applicationid
     */
    readonly applicationId: string;
    /**
     * The authentication configuration details for the data accessor.
     *
     * This specifies how the ISV authenticates when accessing data through this data accessor.
     *
     * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-dataaccessor.html#cfn-qbusiness-dataaccessor-authenticationdetail
     */
    readonly authenticationDetail?: CfnDataAccessor.DataAccessorAuthenticationDetailProperty | cdk.IResolvable;
    /**
     * The friendly name of the data accessor.
     *
     * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-dataaccessor.html#cfn-qbusiness-dataaccessor-displayname
     */
    readonly displayName: string;
    /**
     * The Amazon Resource Name (ARN) of the IAM role for the ISV associated with this data accessor.
     *
     * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-dataaccessor.html#cfn-qbusiness-dataaccessor-principal
     */
    readonly principal: string;
    /**
     * The tags to associate with the data accessor.
     *
     * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-dataaccessor.html#cfn-qbusiness-dataaccessor-tags
     */
    readonly tags?: Array<cdk.CfnTag>;
}
/**
 * Creates a data source connector for an Amazon Q Business application.
 *
 * `CreateDataSource` is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.
 *
 * @cloudformationResource AWS::QBusiness::DataSource
 * @stability external
 * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-datasource.html
 */
export declare class CfnDataSource extends cdk.CfnResource implements cdk.IInspectable, IDataSourceRef, cdk.ITaggableV2 {
    /**
     * The CloudFormation resource type name for this resource class.
     */
    static readonly CFN_RESOURCE_TYPE_NAME: string;
    /**
     * Build a CfnDataSource from CloudFormation properties
     *
     * A factory method that creates a new instance of this class from an object
     * containing the CloudFormation properties of this resource.
     * Used in the @aws-cdk/cloudformation-include module.
     *
     * @internal
     */
    static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnDataSource;
    /**
     * Checks whether the given object is a CfnDataSource
     */
    static isCfnDataSource(x: any): x is CfnDataSource;
    static arnForDataSource(resource: IDataSourceRef): string;
    /**
     * The identifier of the Amazon Q Business application the data source will be attached to.
     */
    private _applicationId;
    /**
     * Tag Manager which manages the tags for this resource
     */
    readonly cdkTagManager: cdk.TagManager;
    /**
     * Use this property to specify a JSON or YAML schema with configuration properties specific to your data source connector to connect your data source repository to Amazon Q Business .
     */
    private _configuration;
    /**
     * A description for the data source connector.
     */
    private _description?;
    /**
     * The name of the Amazon Q Business data source.
     */
    private _displayName;
    /**
     * Provides the configuration information for altering document metadata and content during the document ingestion process.
     */
    private _documentEnrichmentConfiguration?;
    /**
     * The identifier of the index the data source is attached to.
     */
    private _indexId;
    /**
     * The configuration for extracting information from media in documents.
     */
    private _mediaExtractionConfiguration?;
    /**
     * The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.
     */
    private _roleArn?;
    /**
     * Sets the frequency for Amazon Q Business to check the documents in your d