CfnDataAccessorPropsMixin

class aws_cdk.mixins_preview.aws_qbusiness.mixins.CfnDataAccessorPropsMixin(props, *, strategy=None)

Bases: 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:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-dataaccessor.html
CloudformationResource:: AWS::QBusiness::DataAccessor
Mixin:: true
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 import mixins
from aws_cdk.mixins_preview.aws_qbusiness import mixins as qbusiness_mixins

# attribute_filter_property_: qbusiness_mixins.CfnDataAccessorPropsMixin.AttributeFilterProperty

cfn_data_accessor_props_mixin = qbusiness_mixins.CfnDataAccessorPropsMixin(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"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnDataAccessorMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['actionConfigurations', 'applicationId', 'authenticationDetail', 'displayName', 'principal', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

ActionConfigurationProperty

class CfnDataAccessorPropsMixin.ActionConfigurationProperty(*, action=None, filter_configuration=None)

Bases: object

Specifies an allowed action and its associated filter configuration.

Parameters:

action (Optional[str]) – The Amazon Q Business action that is allowed.
filter_configuration (Union[IResolvable, ActionFilterConfigurationProperty, Dict[str, Any], None]) – The filter configuration for the action, if any.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-actionconfiguration.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

action_configuration_property = 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_]
        )
    )
)

Attributes

action

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

filter_configuration

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

ActionFilterConfigurationProperty

class CfnDataAccessorPropsMixin.ActionFilterConfigurationProperty(*, document_attribute_filter=None)

Bases: object

Specifies filters to apply to an allowed action.

Parameters:: document_attribute_filter (Union[IResolvable, AttributeFilterProperty, Dict[str, Any], None]) – 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
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

action_filter_configuration_property = 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_]
    )
)

Attributes

document_attribute_filter

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

AttributeFilterProperty

class CfnDataAccessorPropsMixin.AttributeFilterProperty(*, and_all_filters=None, contains_all=None, contains_any=None, equals_to=None, greater_than=None, greater_than_or_equals=None, less_than=None, less_than_or_equals=None, not_filter=None, or_all_filters=None)

Bases: object

Enables filtering of responses based on document attributes or metadata fields.

Parameters:

and_all_filters (Union[IResolvable, Sequence[Union[IResolvable, AttributeFilterProperty, Dict[str, Any]]], None]) – Performs a logical AND operation on all supplied filters.
contains_all (Union[IResolvable, DocumentAttributeProperty, Dict[str, Any], None]) – Returns true when a document contains all the specified document attributes or metadata fields. Supported for the following document attribute value types : stringListValue .
contains_any (Union[IResolvable, DocumentAttributeProperty, Dict[str, Any], None]) –
Returns true when a document contains any of the specified document attributes or metadata fields. Supported for the following document attribute value types : stringListValue .
equals_to (Union[IResolvable, DocumentAttributeProperty, Dict[str, Any], None]) –
Performs an equals operation on two document attributes or metadata fields. Supported for the following document attribute value types : dateValue , longValue , stringListValue and stringValue .
greater_than (Union[IResolvable, DocumentAttributeProperty, Dict[str, Any], None]) –
Performs a greater than operation on two document attributes or metadata fields. Supported for the following document attribute value types : dateValue and longValue .
greater_than_or_equals (Union[IResolvable, DocumentAttributeProperty, Dict[str, Any], None]) –
Performs a greater or equals than operation on two document attributes or metadata fields. Supported for the following document attribute value types : dateValue and longValue .
less_than (Union[IResolvable, DocumentAttributeProperty, Dict[str, Any], None]) –
Performs a less than operation on two document attributes or metadata fields. Supported for the following document attribute value types : dateValue and longValue .
less_than_or_equals (Union[IResolvable, DocumentAttributeProperty, Dict[str, Any], None]) – Performs a less than or equals operation on two document attributes or metadata fields.Supported for the following document attribute value type : dateValue and longValue .
not_filter (Union[IResolvable, AttributeFilterProperty, Dict[str, Any], None]) – Performs a logical NOT operation on all supplied filters.
or_all_filters (Union[IResolvable, Sequence[Union[IResolvable, AttributeFilterProperty, Dict[str, Any]]], None]) – Performs a logical OR operation on all supplied filters.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.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

attribute_filter_property = 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_]
)

Attributes

and_all_filters

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

contains_all

Returns true when a document contains all the specified document attributes or metadata fields.

Supported for the following document attribute value types : stringListValue .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html#cfn-qbusiness-dataaccessor-attributefilter-containsall

contains_any

Returns true when a document contains any of the specified document attributes or metadata fields.

Supported for the following document attribute value types : stringListValue .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html#cfn-qbusiness-dataaccessor-attributefilter-containsany

equals_to

Performs an equals operation on two document attributes or metadata fields.

Supported for the following document attribute value types : 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

greater_than

Performs a greater than operation on two document attributes or metadata fields.

Supported for the following document attribute value types : dateValue and longValue .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html#cfn-qbusiness-dataaccessor-attributefilter-greaterthan

greater_than_or_equals

Performs a greater or equals than operation on two document attributes or metadata fields.

Supported for the following document attribute value types : dateValue and longValue .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html#cfn-qbusiness-dataaccessor-attributefilter-greaterthanorequals

less_than

Performs a less than operation on two document attributes or metadata fields.

Supported for the following document attribute value types : dateValue and longValue .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html#cfn-qbusiness-dataaccessor-attributefilter-lessthan

less_than_or_equals

dateValue and longValue .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-attributefilter.html#cfn-qbusiness-dataaccessor-attributefilter-lessthanorequals
Type:: Performs a less than or equals operation on two document attributes or metadata fields.Supported for the following document attribute value type

not_filter

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

or_all_filters

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

DataAccessorAuthenticationConfigurationProperty

class CfnDataAccessorPropsMixin.DataAccessorAuthenticationConfigurationProperty(*, idc_trusted_token_issuer_configuration=None)

Bases: object

A union type that contains the specific authentication configuration based on the authentication type selected.

Parameters:: idc_trusted_token_issuer_configuration (Union[IResolvable, DataAccessorIdcTrustedTokenIssuerConfigurationProperty, Dict[str, Any], None]) – 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
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

data_accessor_authentication_configuration_property = qbusiness_mixins.CfnDataAccessorPropsMixin.DataAccessorAuthenticationConfigurationProperty(
    idc_trusted_token_issuer_configuration=qbusiness_mixins.CfnDataAccessorPropsMixin.DataAccessorIdcTrustedTokenIssuerConfigurationProperty(
        idc_trusted_token_issuer_arn="idcTrustedTokenIssuerArn"
    )
)

Attributes

idc_trusted_token_issuer_configuration

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

DataAccessorAuthenticationDetailProperty

class CfnDataAccessorPropsMixin.DataAccessorAuthenticationDetailProperty(*, authentication_configuration=None, authentication_type=None, external_ids=None)

Bases: object

Contains the authentication configuration details for a data accessor.

This structure defines how the ISV authenticates when accessing data through the data accessor.

Parameters:

authentication_configuration (Union[IResolvable, DataAccessorAuthenticationConfigurationProperty, Dict[str, Any], None]) – The specific authentication configuration based on the authentication type.
authentication_type (Optional[str]) – 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.
external_ids (Optional[Sequence[str]]) – 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

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

data_accessor_authentication_detail_property = 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"]
)

Attributes

authentication_configuration

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

authentication_type

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

external_ids

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

DataAccessorIdcTrustedTokenIssuerConfigurationProperty

class CfnDataAccessorPropsMixin.DataAccessorIdcTrustedTokenIssuerConfigurationProperty(*, idc_trusted_token_issuer_arn=None)

Bases: object

Configuration details for IAM Identity Center Trusted Token Issuer (TTI) authentication.

Parameters:: idc_trusted_token_issuer_arn (Optional[str]) – 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
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

data_accessor_idc_trusted_token_issuer_configuration_property = qbusiness_mixins.CfnDataAccessorPropsMixin.DataAccessorIdcTrustedTokenIssuerConfigurationProperty(
    idc_trusted_token_issuer_arn="idcTrustedTokenIssuerArn"
)

Attributes

idc_trusted_token_issuer_arn

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

DocumentAttributeProperty

class CfnDataAccessorPropsMixin.DocumentAttributeProperty(*, name=None, value=None)

Bases: object

A document attribute or metadata field.

Parameters:

name (Optional[str]) – The identifier for the attribute.
value (Union[IResolvable, DocumentAttributeValueProperty, Dict[str, Any], None]) – The value of the attribute.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-documentattribute.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

document_attribute_property = qbusiness_mixins.CfnDataAccessorPropsMixin.DocumentAttributeProperty(
    name="name",
    value=qbusiness_mixins.CfnDataAccessorPropsMixin.DocumentAttributeValueProperty(
        date_value="dateValue",
        long_value=123,
        string_list_value=["stringListValue"],
        string_value="stringValue"
    )
)

Attributes

name

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

value

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

DocumentAttributeValueProperty

class CfnDataAccessorPropsMixin.DocumentAttributeValueProperty(*, date_value=None, long_value=None, string_list_value=None, string_value=None)

Bases: object

The value of a document attribute.

You can only provide one value for a document attribute.

Parameters:

date_value (Optional[str]) – 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.
long_value (Union[int, float, None]) – A long integer value.
string_list_value (Optional[Sequence[str]]) – A list of strings.
string_value (Optional[str]) – A string.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-documentattributevalue.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

document_attribute_value_property = qbusiness_mixins.CfnDataAccessorPropsMixin.DocumentAttributeValueProperty(
    date_value="dateValue",
    long_value=123,
    string_list_value=["stringListValue"],
    string_value="stringValue"
)

Attributes

date_value

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

long_value

A long integer value.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-documentattributevalue.html#cfn-qbusiness-dataaccessor-documentattributevalue-longvalue

string_list_value

A list of strings.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-documentattributevalue.html#cfn-qbusiness-dataaccessor-documentattributevalue-stringlistvalue

string_value

A string.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-dataaccessor-documentattributevalue.html#cfn-qbusiness-dataaccessor-documentattributevalue-stringvalue