We recommend new projects start with resources from the AWS provider.
aws-native.qbusiness.DataAccessor
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
Definition of AWS::QBusiness::DataAccessor Resource Type
Create DataAccessor Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new DataAccessor(name: string, args: DataAccessorArgs, opts?: CustomResourceOptions);@overload
def DataAccessor(resource_name: str,
                 args: DataAccessorArgs,
                 opts: Optional[ResourceOptions] = None)
@overload
def DataAccessor(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 action_configurations: Optional[Sequence[DataAccessorActionConfigurationArgs]] = None,
                 application_id: Optional[str] = None,
                 display_name: Optional[str] = None,
                 principal: Optional[str] = None,
                 tags: Optional[Sequence[_root_inputs.TagArgs]] = None)func NewDataAccessor(ctx *Context, name string, args DataAccessorArgs, opts ...ResourceOption) (*DataAccessor, error)public DataAccessor(string name, DataAccessorArgs args, CustomResourceOptions? opts = null)
public DataAccessor(String name, DataAccessorArgs args)
public DataAccessor(String name, DataAccessorArgs args, CustomResourceOptions options)
type: aws-native:qbusiness:DataAccessor
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args DataAccessorArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args DataAccessorArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args DataAccessorArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DataAccessorArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DataAccessorArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
DataAccessor Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The DataAccessor resource accepts the following input properties:
- ActionConfigurations List<Pulumi.Aws Native. QBusiness. Inputs. Data Accessor Action Configuration> 
- A list of action configurations specifying the allowed actions and any associated filters.
- ApplicationId string
- The unique identifier of the Amazon Q Business application.
- 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.
- 
List<Pulumi.Aws Native. Inputs. Tag> 
- The tags to associate with the data accessor.
- ActionConfigurations []DataAccessor Action Configuration Args 
- A list of action configurations specifying the allowed actions and any associated filters.
- ApplicationId string
- The unique identifier of the Amazon Q Business application.
- 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.
- 
TagArgs 
- The tags to associate with the data accessor.
- actionConfigurations List<DataAccessor Action Configuration> 
- A list of action configurations specifying the allowed actions and any associated filters.
- applicationId String
- The unique identifier of the Amazon Q Business application.
- 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.
- List<Tag>
- The tags to associate with the data accessor.
- actionConfigurations DataAccessor Action Configuration[] 
- A list of action configurations specifying the allowed actions and any associated filters.
- applicationId string
- The unique identifier of the Amazon Q Business application.
- 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.
- Tag[]
- The tags to associate with the data accessor.
- action_configurations Sequence[DataAccessor Action Configuration Args] 
- 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.
- 
Sequence[TagArgs] 
- The tags to associate with the data accessor.
- actionConfigurations List<Property Map>
- A list of action configurations specifying the allowed actions and any associated filters.
- applicationId String
- The unique identifier of the Amazon Q Business application.
- 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.
- List<Property Map>
- The tags to associate with the data accessor.
Outputs
All input properties are implicitly available as output properties. Additionally, the DataAccessor resource produces the following output properties:
- CreatedAt string
- The timestamp when the data accessor was created.
- DataAccessor stringArn 
- The Amazon Resource Name (ARN) of the data accessor.
- DataAccessor stringId 
- The unique identifier of the data accessor.
- Id string
- The provider-assigned unique ID for this managed resource.
- IdcApplication stringArn 
- The Amazon Resource Name (ARN) of the associated IAM Identity Center application.
- UpdatedAt string
- The timestamp when the data accessor was last updated.
- CreatedAt string
- The timestamp when the data accessor was created.
- DataAccessor stringArn 
- The Amazon Resource Name (ARN) of the data accessor.
- DataAccessor stringId 
- The unique identifier of the data accessor.
- Id string
- The provider-assigned unique ID for this managed resource.
- IdcApplication stringArn 
- The Amazon Resource Name (ARN) of the associated IAM Identity Center application.
- UpdatedAt string
- The timestamp when the data accessor was last updated.
- createdAt String
- The timestamp when the data accessor was created.
- dataAccessor StringArn 
- The Amazon Resource Name (ARN) of the data accessor.
- dataAccessor StringId 
- The unique identifier of the data accessor.
- id String
- The provider-assigned unique ID for this managed resource.
- idcApplication StringArn 
- The Amazon Resource Name (ARN) of the associated IAM Identity Center application.
- updatedAt String
- The timestamp when the data accessor was last updated.
- createdAt string
- The timestamp when the data accessor was created.
- dataAccessor stringArn 
- The Amazon Resource Name (ARN) of the data accessor.
- dataAccessor stringId 
- The unique identifier of the data accessor.
- id string
- The provider-assigned unique ID for this managed resource.
- idcApplication stringArn 
- The Amazon Resource Name (ARN) of the associated IAM Identity Center application.
- updatedAt string
- The timestamp when the data accessor was last updated.
- created_at str
- The timestamp when the data accessor was created.
- data_accessor_ strarn 
- The Amazon Resource Name (ARN) of the data accessor.
- data_accessor_ strid 
- The unique identifier of the data accessor.
- id str
- The provider-assigned unique ID for this managed resource.
- idc_application_ strarn 
- The Amazon Resource Name (ARN) of the associated IAM Identity Center application.
- updated_at str
- The timestamp when the data accessor was last updated.
- createdAt String
- The timestamp when the data accessor was created.
- dataAccessor StringArn 
- The Amazon Resource Name (ARN) of the data accessor.
- dataAccessor StringId 
- The unique identifier of the data accessor.
- id String
- The provider-assigned unique ID for this managed resource.
- idcApplication StringArn 
- The Amazon Resource Name (ARN) of the associated IAM Identity Center application.
- updatedAt String
- The timestamp when the data accessor was last updated.
Supporting Types
DataAccessorActionConfiguration, DataAccessorActionConfigurationArgs        
- Action string
- The Amazon Q Business action that is allowed.
- FilterConfiguration Pulumi.Aws Native. QBusiness. Inputs. Data Accessor Action Filter Configuration 
- The filter configuration for the action, if any.
- Action string
- The Amazon Q Business action that is allowed.
- FilterConfiguration DataAccessor Action Filter Configuration 
- The filter configuration for the action, if any.
- action String
- The Amazon Q Business action that is allowed.
- filterConfiguration DataAccessor Action Filter Configuration 
- The filter configuration for the action, if any.
- action string
- The Amazon Q Business action that is allowed.
- filterConfiguration DataAccessor Action Filter Configuration 
- The filter configuration for the action, if any.
- action str
- The Amazon Q Business action that is allowed.
- filter_configuration DataAccessor Action Filter Configuration 
- The filter configuration for the action, if any.
- action String
- The Amazon Q Business action that is allowed.
- filterConfiguration Property Map
- The filter configuration for the action, if any.
DataAccessorActionFilterConfiguration, DataAccessorActionFilterConfigurationArgs          
- DocumentAttribute Pulumi.Filter Aws Native. QBusiness. Inputs. Data Accessor Attribute Filter 
- Enables filtering of responses based on document attributes or metadata fields.
- DocumentAttribute DataFilter Accessor Attribute Filter 
- Enables filtering of responses based on document attributes or metadata fields.
- documentAttribute DataFilter Accessor Attribute Filter 
- Enables filtering of responses based on document attributes or metadata fields.
- documentAttribute DataFilter Accessor Attribute Filter 
- Enables filtering of responses based on document attributes or metadata fields.
- document_attribute_ Datafilter Accessor Attribute Filter 
- Enables filtering of responses based on document attributes or metadata fields.
- documentAttribute Property MapFilter 
- Enables filtering of responses based on document attributes or metadata fields.
DataAccessorAttributeFilter, DataAccessorAttributeFilterArgs        
- AndAll List<Pulumi.Filters Aws Native. QBusiness. Inputs. Data Accessor Attribute Filter> 
- Performs a logical ANDoperation on all supplied filters.
- ContainsAll Pulumi.Aws Native. QBusiness. Inputs. Data Accessor Document Attribute 
- Returns truewhen a document contains all the specified document attributes or metadata fields. Supported for the following document attribute value types :stringListValue.
- ContainsAny Pulumi.Aws Native. QBusiness. Inputs. Data Accessor Document Attribute 
- Returns truewhen a document contains any of the specified document attributes or metadata fields. Supported for the following document attribute value types :stringListValue.
- EqualsTo Pulumi.Aws Native. QBusiness. Inputs. Data Accessor Document Attribute 
- Performs an equals operation on two document attributes or metadata fields. Supported for the following document attribute value types : dateValue,longValue,stringListValueandstringValue.
- GreaterThan Pulumi.Aws Native. QBusiness. Inputs. Data Accessor Document Attribute 
- Performs a greater than operation on two document attributes or metadata fields. Supported for the following document attribute value types : dateValueandlongValue.
- GreaterThan Pulumi.Or Equals Aws Native. QBusiness. Inputs. Data Accessor Document Attribute 
- Performs a greater or equals than operation on two document attributes or metadata fields. Supported for the following document attribute value types : dateValueandlongValue.
- LessThan Pulumi.Aws Native. QBusiness. Inputs. Data Accessor Document Attribute 
- Performs a less than operation on two document attributes or metadata fields. Supported for the following document attribute value types : dateValueandlongValue.
- LessThan Pulumi.Or Equals Aws Native. QBusiness. Inputs. Data Accessor Document Attribute 
- Performs a less than or equals operation on two document attributes or metadata fields.Supported for the following document attribute value type : dateValueandlongValue.
- NotFilter Pulumi.Aws Native. QBusiness. Inputs. Data Accessor Attribute Filter 
- Performs a logical NOToperation on all supplied filters.
- OrAll List<Pulumi.Filters Aws Native. QBusiness. Inputs. Data Accessor Attribute Filter> 
- Performs a logical ORoperation on all supplied filters.
- AndAll []DataFilters Accessor Attribute Filter 
- Performs a logical ANDoperation on all supplied filters.
- ContainsAll DataAccessor Document Attribute 
- Returns truewhen a document contains all the specified document attributes or metadata fields. Supported for the following document attribute value types :stringListValue.
- ContainsAny DataAccessor Document Attribute 
- Returns truewhen a document contains any of the specified document attributes or metadata fields. Supported for the following document attribute value types :stringListValue.
- EqualsTo DataAccessor Document Attribute 
- Performs an equals operation on two document attributes or metadata fields. Supported for the following document attribute value types : dateValue,longValue,stringListValueandstringValue.
- GreaterThan DataAccessor Document Attribute 
- Performs a greater than operation on two document attributes or metadata fields. Supported for the following document attribute value types : dateValueandlongValue.
- GreaterThan DataOr Equals Accessor Document Attribute 
- Performs a greater or equals than operation on two document attributes or metadata fields. Supported for the following document attribute value types : dateValueandlongValue.
- LessThan DataAccessor Document Attribute 
- Performs a less than operation on two document attributes or metadata fields. Supported for the following document attribute value types : dateValueandlongValue.
- LessThan DataOr Equals Accessor Document Attribute 
- Performs a less than or equals operation on two document attributes or metadata fields.Supported for the following document attribute value type : dateValueandlongValue.
- NotFilter DataAccessor Attribute Filter 
- Performs a logical NOToperation on all supplied filters.
- OrAll []DataFilters Accessor Attribute Filter 
- Performs a logical ORoperation on all supplied filters.
- andAll List<DataFilters Accessor Attribute Filter> 
- Performs a logical ANDoperation on all supplied filters.
- containsAll DataAccessor Document Attribute 
- Returns truewhen a document contains all the specified document attributes or metadata fields. Supported for the following document attribute value types :stringListValue.
- containsAny DataAccessor Document Attribute 
- Returns truewhen a document contains any of the specified document attributes or metadata fields. Supported for the following document attribute value types :stringListValue.
- equalsTo DataAccessor Document Attribute 
- Performs an equals operation on two document attributes or metadata fields. Supported for the following document attribute value types : dateValue,longValue,stringListValueandstringValue.
- greaterThan DataAccessor Document Attribute 
- Performs a greater than operation on two document attributes or metadata fields. Supported for the following document attribute value types : dateValueandlongValue.
- greaterThan DataOr Equals Accessor Document Attribute 
- Performs a greater or equals than operation on two document attributes or metadata fields. Supported for the following document attribute value types : dateValueandlongValue.
- lessThan DataAccessor Document Attribute 
- Performs a less than operation on two document attributes or metadata fields. Supported for the following document attribute value types : dateValueandlongValue.
- lessThan DataOr Equals Accessor Document Attribute 
- Performs a less than or equals operation on two document attributes or metadata fields.Supported for the following document attribute value type : dateValueandlongValue.
- notFilter DataAccessor Attribute Filter 
- Performs a logical NOToperation on all supplied filters.
- orAll List<DataFilters Accessor Attribute Filter> 
- Performs a logical ORoperation on all supplied filters.
- andAll DataFilters Accessor Attribute Filter[] 
- Performs a logical ANDoperation on all supplied filters.
- containsAll DataAccessor Document Attribute 
- Returns truewhen a document contains all the specified document attributes or metadata fields. Supported for the following document attribute value types :stringListValue.
- containsAny DataAccessor Document Attribute 
- Returns truewhen a document contains any of the specified document attributes or metadata fields. Supported for the following document attribute value types :stringListValue.
- equalsTo DataAccessor Document Attribute 
- Performs an equals operation on two document attributes or metadata fields. Supported for the following document attribute value types : dateValue,longValue,stringListValueandstringValue.
- greaterThan DataAccessor Document Attribute 
- Performs a greater than operation on two document attributes or metadata fields. Supported for the following document attribute value types : dateValueandlongValue.
- greaterThan DataOr Equals Accessor Document Attribute 
- Performs a greater or equals than operation on two document attributes or metadata fields. Supported for the following document attribute value types : dateValueandlongValue.
- lessThan DataAccessor Document Attribute 
- Performs a less than operation on two document attributes or metadata fields. Supported for the following document attribute value types : dateValueandlongValue.
- lessThan DataOr Equals Accessor Document Attribute 
- Performs a less than or equals operation on two document attributes or metadata fields.Supported for the following document attribute value type : dateValueandlongValue.
- notFilter DataAccessor Attribute Filter 
- Performs a logical NOToperation on all supplied filters.
- orAll DataFilters Accessor Attribute Filter[] 
- Performs a logical ORoperation on all supplied filters.
- and_all_ Sequence[Datafilters Accessor Attribute Filter] 
- Performs a logical ANDoperation on all supplied filters.
- contains_all DataAccessor Document Attribute 
- Returns truewhen a document contains all the specified document attributes or metadata fields. Supported for the following document attribute value types :stringListValue.
- contains_any DataAccessor Document Attribute 
- Returns truewhen a document contains any of the specified document attributes or metadata fields. Supported for the following document attribute value types :stringListValue.
- equals_to DataAccessor Document Attribute 
- Performs an equals operation on two document attributes or metadata fields. Supported for the following document attribute value types : dateValue,longValue,stringListValueandstringValue.
- greater_than DataAccessor Document Attribute 
- Performs a greater than operation on two document attributes or metadata fields. Supported for the following document attribute value types : dateValueandlongValue.
- greater_than_ Dataor_ equals Accessor Document Attribute 
- Performs a greater or equals than operation on two document attributes or metadata fields. Supported for the following document attribute value types : dateValueandlongValue.
- less_than DataAccessor Document Attribute 
- Performs a less than operation on two document attributes or metadata fields. Supported for the following document attribute value types : dateValueandlongValue.
- less_than_ Dataor_ equals Accessor Document Attribute 
- Performs a less than or equals operation on two document attributes or metadata fields.Supported for the following document attribute value type : dateValueandlongValue.
- not_filter DataAccessor Attribute Filter 
- Performs a logical NOToperation on all supplied filters.
- or_all_ Sequence[Datafilters Accessor Attribute Filter] 
- Performs a logical ORoperation on all supplied filters.
- andAll List<Property Map>Filters 
- Performs a logical ANDoperation on all supplied filters.
- containsAll Property Map
- Returns truewhen a document contains all the specified document attributes or metadata fields. Supported for the following document attribute value types :stringListValue.
- containsAny Property Map
- Returns truewhen a document contains any of the specified document attributes or metadata fields. Supported for the following document attribute value types :stringListValue.
- equalsTo Property Map
- Performs an equals operation on two document attributes or metadata fields. Supported for the following document attribute value types : dateValue,longValue,stringListValueandstringValue.
- greaterThan Property Map
- Performs a greater than operation on two document attributes or metadata fields. Supported for the following document attribute value types : dateValueandlongValue.
- greaterThan Property MapOr Equals 
- Performs a greater or equals than operation on two document attributes or metadata fields. Supported for the following document attribute value types : dateValueandlongValue.
- lessThan Property Map
- Performs a less than operation on two document attributes or metadata fields. Supported for the following document attribute value types : dateValueandlongValue.
- lessThan Property MapOr Equals 
- Performs a less than or equals operation on two document attributes or metadata fields.Supported for the following document attribute value type : dateValueandlongValue.
- notFilter Property Map
- Performs a logical NOToperation on all supplied filters.
- orAll List<Property Map>Filters 
- Performs a logical ORoperation on all supplied filters.
DataAccessorDocumentAttribute, DataAccessorDocumentAttributeArgs        
- Name string
- The identifier for the attribute.
- Value
Pulumi.Aws | Pulumi.Native. QBusiness. Inputs. Data Accessor Document Attribute Value0Properties Aws | Pulumi.Native. QBusiness. Inputs. Data Accessor Document Attribute Value1Properties Aws | Pulumi.Native. QBusiness. Inputs. Data Accessor Document Attribute Value2Properties Aws Native. QBusiness. Inputs. Data Accessor Document Attribute Value3Properties 
- The value of the attribute.
- Name string
- The identifier for the attribute.
- Value
DataAccessor | DataDocument Attribute Value0Properties Accessor | DataDocument Attribute Value1Properties Accessor | DataDocument Attribute Value2Properties Accessor Document Attribute Value3Properties 
- The value of the attribute.
- name String
- The identifier for the attribute.
- value
DataAccessor | DataDocument Attribute Value0Properties Accessor | DataDocument Attribute Value1Properties Accessor | DataDocument Attribute Value2Properties Accessor Document Attribute Value3Properties 
- The value of the attribute.
- name string
- The identifier for the attribute.
- value
DataAccessor | DataDocument Attribute Value0Properties Accessor | DataDocument Attribute Value1Properties Accessor | DataDocument Attribute Value2Properties Accessor Document Attribute Value3Properties 
- The value of the attribute.
- name str
- The identifier for the attribute.
- value
DataAccessor | DataDocument Attribute Value0Properties Accessor | DataDocument Attribute Value1Properties Accessor | DataDocument Attribute Value2Properties Accessor Document Attribute Value3Properties 
- The value of the attribute.
- name String
- The identifier for the attribute.
- value Property Map | Property Map | Property Map | Property Map
- The value of the attribute.
DataAccessorDocumentAttributeValue0Properties, DataAccessorDocumentAttributeValue0PropertiesArgs          
- StringValue string
- StringValue string
- stringValue String
- stringValue string
- string_value str
- stringValue String
DataAccessorDocumentAttributeValue1Properties, DataAccessorDocumentAttributeValue1PropertiesArgs          
- StringList List<string>Value 
- StringList []stringValue 
- stringList List<String>Value 
- stringList string[]Value 
- string_list_ Sequence[str]value 
- stringList List<String>Value 
DataAccessorDocumentAttributeValue2Properties, DataAccessorDocumentAttributeValue2PropertiesArgs          
- LongValue double
- LongValue float64
- longValue Double
- longValue number
- long_value float
- longValue Number
DataAccessorDocumentAttributeValue3Properties, DataAccessorDocumentAttributeValue3PropertiesArgs          
- DateValue string
- DateValue string
- dateValue String
- dateValue string
- date_value str
- dateValue String
Tag, TagArgs  
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.