interface CfnDataAccessorMixinProps

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.QBusiness.Mixins.CfnDataAccessorMixinProps
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsqbusiness/mixins#CfnDataAccessorMixinProps
Java	software.amazon.awscdk.mixins.preview.services.qbusiness.mixins.CfnDataAccessorMixinProps
Python	aws_cdk.mixins_preview.aws_qbusiness.mixins.CfnDataAccessorMixinProps
TypeScript	@aws-cdk/mixins-preview » aws_qbusiness » mixins » CfnDataAccessorMixinProps

Properties for CfnDataAccessorPropsMixin.

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 { mixins as qbusiness_mixins } from '@aws-cdk/mixins-preview/aws-qbusiness';

declare const attributeFilterProperty_: qbusiness_mixins.CfnDataAccessorPropsMixin.AttributeFilterProperty;
const cfnDataAccessorMixinProps: qbusiness_mixins.CfnDataAccessorMixinProps = {
  actionConfigurations: [{
    action: 'action',
    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',
  authenticationDetail: {
    authenticationConfiguration: {
      idcTrustedTokenIssuerConfiguration: {
        idcTrustedTokenIssuerArn: 'idcTrustedTokenIssuerArn',
      },
    },
    authenticationType: 'authenticationType',
    externalIds: ['externalIds'],
  },
  displayName: 'displayName',
  principal: 'principal',
  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.
authenticationDetail?	IResolvable | DataAccessorAuthenticationDetailProperty	The authentication configuration details for the data accessor.
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.
tags?	CfnTag[]	The tags to associate with the data accessor.

---

actionConfigurations?

Type: IResolvable | (IResolvable | ActionConfigurationProperty)[] (optional)

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 (optional)

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

---

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

---

displayName?

Type: string (optional)

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 (optional)

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

---

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