CfnDataAccessorProps
- class aws_cdk.aws_qbusiness.CfnDataAccessorProps(*, action_configurations, application_id, display_name, principal, authentication_detail=None, tags=None)
Bases:
object
Properties for defining a
CfnDataAccessor
.- Parameters:
action_configurations (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,ActionConfigurationProperty
,Dict
[str
,Any
]]]]) – A list of action configurations specifying the allowed actions and any associated filters.application_id (
str
) – The unique identifier of the Amazon Q Business application.display_name (
str
) – The friendly name of the data accessor.principal (
str
) – The Amazon Resource Name (ARN) of the IAM role for the ISV associated with this data accessor.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.tags (
Optional
[Sequence
[Union
[CfnTag
,Dict
[str
,Any
]]]]) – The tags to associate with the data accessor.
- See:
- 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 import aws_qbusiness as qbusiness # attribute_filter_property_: qbusiness.CfnDataAccessor.AttributeFilterProperty cfn_data_accessor_props = qbusiness.CfnDataAccessorProps( action_configurations=[qbusiness.CfnDataAccessor.ActionConfigurationProperty( action="action", # the properties below are optional filter_configuration=qbusiness.CfnDataAccessor.ActionFilterConfigurationProperty( document_attribute_filter=qbusiness.CfnDataAccessor.AttributeFilterProperty( and_all_filters=[attribute_filter_property_], contains_all=qbusiness.CfnDataAccessor.DocumentAttributeProperty( name="name", value=qbusiness.CfnDataAccessor.DocumentAttributeValueProperty( date_value="dateValue", long_value=123, string_list_value=["stringListValue"], string_value="stringValue" ) ), contains_any=qbusiness.CfnDataAccessor.DocumentAttributeProperty( name="name", value=qbusiness.CfnDataAccessor.DocumentAttributeValueProperty( date_value="dateValue", long_value=123, string_list_value=["stringListValue"], string_value="stringValue" ) ), equals_to=qbusiness.CfnDataAccessor.DocumentAttributeProperty( name="name", value=qbusiness.CfnDataAccessor.DocumentAttributeValueProperty( date_value="dateValue", long_value=123, string_list_value=["stringListValue"], string_value="stringValue" ) ), greater_than=qbusiness.CfnDataAccessor.DocumentAttributeProperty( name="name", value=qbusiness.CfnDataAccessor.DocumentAttributeValueProperty( date_value="dateValue", long_value=123, string_list_value=["stringListValue"], string_value="stringValue" ) ), greater_than_or_equals=qbusiness.CfnDataAccessor.DocumentAttributeProperty( name="name", value=qbusiness.CfnDataAccessor.DocumentAttributeValueProperty( date_value="dateValue", long_value=123, string_list_value=["stringListValue"], string_value="stringValue" ) ), less_than=qbusiness.CfnDataAccessor.DocumentAttributeProperty( name="name", value=qbusiness.CfnDataAccessor.DocumentAttributeValueProperty( date_value="dateValue", long_value=123, string_list_value=["stringListValue"], string_value="stringValue" ) ), less_than_or_equals=qbusiness.CfnDataAccessor.DocumentAttributeProperty( name="name", value=qbusiness.CfnDataAccessor.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", display_name="displayName", principal="principal", # the properties below are optional authentication_detail=qbusiness.CfnDataAccessor.DataAccessorAuthenticationDetailProperty( authentication_type="authenticationType", # the properties below are optional authentication_configuration=qbusiness.CfnDataAccessor.DataAccessorAuthenticationConfigurationProperty( idc_trusted_token_issuer_configuration=qbusiness.CfnDataAccessor.DataAccessorIdcTrustedTokenIssuerConfigurationProperty( idc_trusted_token_issuer_arn="idcTrustedTokenIssuerArn" ) ), external_ids=["externalIds"] ), tags=[CfnTag( key="key", value="value" )] )
Attributes
- action_configurations
A list of action configurations specifying the allowed actions and any associated filters.
- application_id
The unique identifier of the Amazon Q Business application.
- authentication_detail
The authentication configuration details for the data accessor.
This specifies how the ISV authenticates when accessing data through this data accessor.
- display_name
The friendly name of the data accessor.
- principal
The Amazon Resource Name (ARN) of the IAM role for the ISV associated with this data accessor.
- tags
The tags to associate with the data accessor.