interface CfnDataAccessorProps

Language	Type name
.NET	Amazon.CDK.AWS.QBusiness.CfnDataAccessorProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsqbusiness#CfnDataAccessorProps
Java	software.amazon.awscdk.services.qbusiness.CfnDataAccessorProps
Python	aws_cdk.aws_qbusiness.CfnDataAccessorProps
TypeScript	aws-cdk-lib » aws_qbusiness » CfnDataAccessorProps

Properties for defining a CfnDataAccessor.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-dataaccessor.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_qbusiness as qbusiness } from 'aws-cdk-lib';

declare const attributeFilterProperty_: qbusiness.CfnDataAccessor.AttributeFilterProperty;
const cfnDataAccessorProps: qbusiness.CfnDataAccessorProps = {
  actionConfigurations: [{
    action: 'action',

    // the properties below are optional
    filterConfiguration: {
      documentAttributeFilter: {
        andAllFilters: [attributeFilterProperty_],
        containsAll: {
          name: 'name',
          value: {
            dateValue: 'dateValue',
            longValue: 123,
            stringListValue: ['stringListValue'],
            stringValue: 'stringValue',
          },
        },
        containsAny: {
          name: 'name',
          value: {
            dateValue: 'dateValue',
            longValue: 123,
            stringListValue: ['stringListValue'],
            stringValue: 'stringValue',
          },
        },
        equalsTo: {
          name: 'name',
          value: {
            dateValue: 'dateValue',
            longValue: 123,
            stringListValue: ['stringListValue'],
            stringValue: 'stringValue',
          },
        },
        greaterThan: {
          name: 'name',
          value: {
            dateValue: 'dateValue',
            longValue: 123,
            stringListValue: ['stringListValue'],
            stringValue: 'stringValue',
          },
        },
        greaterThanOrEquals: {
          name: 'name',
          value: {
            dateValue: 'dateValue',
            longValue: 123,
            stringListValue: ['stringListValue'],
            stringValue: 'stringValue',
          },
        },
        lessThan: {
          name: 'name',
          value: {
            dateValue: 'dateValue',
            longValue: 123,
            stringListValue: ['stringListValue'],
            stringValue: 'stringValue',
          },
        },
        lessThanOrEquals: {
          name: 'name',
          value: {
            dateValue: 'dateValue',
            longValue: 123,
            stringListValue: ['stringListValue'],
            stringValue: 'stringValue',
          },
        },
        notFilter: attributeFilterProperty_,
        orAllFilters: [attributeFilterProperty_],
      },
    },
  }],
  applicationId: 'applicationId',
  displayName: 'displayName',
  principal: 'principal',

  // the properties below are optional
  authenticationDetail: {
    authenticationType: 'authenticationType',

    // the properties below are optional
    authenticationConfiguration: {
      idcTrustedTokenIssuerConfiguration: {
        idcTrustedTokenIssuerArn: 'idcTrustedTokenIssuerArn',
      },
    },
    externalIds: ['externalIds'],
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
actionConfigurations	IResolvable | (IResolvable | ActionConfigurationProperty)[]	A list of action configurations specifying the allowed actions and any associated filters.
applicationId	string	The unique identifier of the Amazon Q Business application.
displayName	string	The friendly name of the data accessor.
principal	string	The Amazon Resource Name (ARN) of the IAM role for the ISV associated with this data accessor.
authenticationDetail?	IResolvable | DataAccessorAuthenticationDetailProperty	The authentication configuration details for the data accessor.
tags?	CfnTag[]	The tags to associate with the data accessor.

---

actionConfigurations

Type: IResolvable | (IResolvable | ActionConfigurationProperty)[]

A list of action configurations specifying the allowed actions and any associated filters.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-dataaccessor.html#cfn-qbusiness-dataaccessor-actionconfigurations

---

applicationId

Type: string

The unique identifier of the Amazon Q Business application.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-dataaccessor.html#cfn-qbusiness-dataaccessor-applicationid

---

displayName

Type: string

The friendly name of the data accessor.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-dataaccessor.html#cfn-qbusiness-dataaccessor-displayname

---

principal

Type: string

The Amazon Resource Name (ARN) of the IAM role for the ISV associated with this data accessor.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-dataaccessor.html#cfn-qbusiness-dataaccessor-principal

---

authenticationDetail?

Type: IResolvable | DataAccessorAuthenticationDetailProperty (optional)

The authentication configuration details for the data accessor.

This specifies how the ISV authenticates when accessing data through this data accessor.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-dataaccessor.html#cfn-qbusiness-dataaccessor-authenticationdetail

---

tags?

Type: CfnTag[] (optional)

The tags to associate with the data accessor.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-dataaccessor.html#cfn-qbusiness-dataaccessor-tags