CfnDataAccessorMixinProps

class aws_cdk.mixins_preview.aws_qbusiness.mixins.CfnDataAccessorMixinProps(*, action_configurations=None, application_id=None, authentication_detail=None, display_name=None, principal=None, tags=None)

Bases: object

Properties for CfnDataAccessorPropsMixin.

Parameters:
  • action_configurations (Union[IResolvable, Sequence[Union[IResolvable, ActionConfigurationProperty, Dict[str, Any]]], None]) – A list of action configurations specifying the allowed actions and any associated filters.

  • application_id (Optional[str]) – The unique identifier of the Amazon Q Business application.

  • authentication_detail (Union[IResolvable, DataAccessorAuthenticationDetailProperty, Dict[str, Any], None]) – The authentication configuration details for the data accessor. This specifies how the ISV authenticates when accessing data through this data accessor.

  • display_name (Optional[str]) – The friendly name of the data accessor.

  • principal (Optional[str]) – The Amazon Resource Name (ARN) of the IAM role for the ISV associated with this data accessor.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags to associate with the data accessor.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_qbusiness import mixins as qbusiness_mixins

# attribute_filter_property_: qbusiness_mixins.CfnDataAccessorPropsMixin.AttributeFilterProperty

cfn_data_accessor_mixin_props = qbusiness_mixins.CfnDataAccessorMixinProps(
    action_configurations=[qbusiness_mixins.CfnDataAccessorPropsMixin.ActionConfigurationProperty(
        action="action",
        filter_configuration=qbusiness_mixins.CfnDataAccessorPropsMixin.ActionFilterConfigurationProperty(
            document_attribute_filter=qbusiness_mixins.CfnDataAccessorPropsMixin.AttributeFilterProperty(
                and_all_filters=[attribute_filter_property_],
                contains_all=qbusiness_mixins.CfnDataAccessorPropsMixin.DocumentAttributeProperty(
                    name="name",
                    value=qbusiness_mixins.CfnDataAccessorPropsMixin.DocumentAttributeValueProperty(
                        date_value="dateValue",
                        long_value=123,
                        string_list_value=["stringListValue"],
                        string_value="stringValue"
                    )
                ),
                contains_any=qbusiness_mixins.CfnDataAccessorPropsMixin.DocumentAttributeProperty(
                    name="name",
                    value=qbusiness_mixins.CfnDataAccessorPropsMixin.DocumentAttributeValueProperty(
                        date_value="dateValue",
                        long_value=123,
                        string_list_value=["stringListValue"],
                        string_value="stringValue"
                    )
                ),
                equals_to=qbusiness_mixins.CfnDataAccessorPropsMixin.DocumentAttributeProperty(
                    name="name",
                    value=qbusiness_mixins.CfnDataAccessorPropsMixin.DocumentAttributeValueProperty(
                        date_value="dateValue",
                        long_value=123,
                        string_list_value=["stringListValue"],
                        string_value="stringValue"
                    )
                ),
                greater_than=qbusiness_mixins.CfnDataAccessorPropsMixin.DocumentAttributeProperty(
                    name="name",
                    value=qbusiness_mixins.CfnDataAccessorPropsMixin.DocumentAttributeValueProperty(
                        date_value="dateValue",
                        long_value=123,
                        string_list_value=["stringListValue"],
                        string_value="stringValue"
                    )
                ),
                greater_than_or_equals=qbusiness_mixins.CfnDataAccessorPropsMixin.DocumentAttributeProperty(
                    name="name",
                    value=qbusiness_mixins.CfnDataAccessorPropsMixin.DocumentAttributeValueProperty(
                        date_value="dateValue",
                        long_value=123,
                        string_list_value=["stringListValue"],
                        string_value="stringValue"
                    )
                ),
                less_than=qbusiness_mixins.CfnDataAccessorPropsMixin.DocumentAttributeProperty(
                    name="name",
                    value=qbusiness_mixins.CfnDataAccessorPropsMixin.DocumentAttributeValueProperty(
                        date_value="dateValue",
                        long_value=123,
                        string_list_value=["stringListValue"],
                        string_value="stringValue"
                    )
                ),
                less_than_or_equals=qbusiness_mixins.CfnDataAccessorPropsMixin.DocumentAttributeProperty(
                    name="name",
                    value=qbusiness_mixins.CfnDataAccessorPropsMixin.DocumentAttributeValueProperty(
                        date_value="dateValue",
                        long_value=123,
                        string_list_value=["stringListValue"],
                        string_value="stringValue"
                    )
                ),
                not_filter=attribute_filter_property_,
                or_all_filters=[attribute_filter_property_]
            )
        )
    )],
    application_id="applicationId",
    authentication_detail=qbusiness_mixins.CfnDataAccessorPropsMixin.DataAccessorAuthenticationDetailProperty(
        authentication_configuration=qbusiness_mixins.CfnDataAccessorPropsMixin.DataAccessorAuthenticationConfigurationProperty(
            idc_trusted_token_issuer_configuration=qbusiness_mixins.CfnDataAccessorPropsMixin.DataAccessorIdcTrustedTokenIssuerConfigurationProperty(
                idc_trusted_token_issuer_arn="idcTrustedTokenIssuerArn"
            )
        ),
        authentication_type="authenticationType",
        external_ids=["externalIds"]
    ),
    display_name="displayName",
    principal="principal",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

action_configurations

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

application_id

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

authentication_detail

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

display_name

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

principal

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

tags

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