class CfnDataAccessorPropsMixin

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

Implements IMixin

Extends Mixin

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.

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

declare const attributeFilterProperty_: qbusiness_mixins.CfnDataAccessorPropsMixin.AttributeFilterProperty;
const cfnDataAccessorPropsMixin = new qbusiness_mixins.CfnDataAccessorPropsMixin({
  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',
  }],
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnDataAccessorPropsMixin(props: CfnDataAccessorMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnDataAccessorMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::QBusiness::DataAccessor.

Properties

Name	Type	Description
props	CfnDataAccessorMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnDataAccessorMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.