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
This property is required. string - The unique name of the resource.
- args
This property is required. DataAccessorArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. 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
This property is required. string - The unique name of the resource.
- args
This property is required. DataAccessorArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. DataAccessorArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. 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:
- Action
Configurations This property is required. List<Pulumi.Aws Native. QBusiness. Inputs. Data Accessor Action Configuration> - A list of action configurations specifying the allowed actions and any associated filters.
- Application
Id This property is required. string - The unique identifier of the Amazon Q Business application.
- Display
Name This property is required. string - The friendly name of the data accessor.
- Principal
This property is required. 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.
- Action
Configurations This property is required. []DataAccessor Action Configuration Args - A list of action configurations specifying the allowed actions and any associated filters.
- Application
Id This property is required. string - The unique identifier of the Amazon Q Business application.
- Display
Name This property is required. string - The friendly name of the data accessor.
- Principal
This property is required. string - The Amazon Resource Name (ARN) of the IAM role for the ISV associated with this data accessor.
- Tag
Args - The tags to associate with the data accessor.
- action
Configurations This property is required. List<DataAccessor Action Configuration> - A list of action configurations specifying the allowed actions and any associated filters.
- application
Id This property is required. String - The unique identifier of the Amazon Q Business application.
- display
Name This property is required. String - The friendly name of the data accessor.
- principal
This property is required. 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.
- action
Configurations This property is required. DataAccessor Action Configuration[] - A list of action configurations specifying the allowed actions and any associated filters.
- application
Id This property is required. string - The unique identifier of the Amazon Q Business application.
- display
Name This property is required. string - The friendly name of the data accessor.
- principal
This property is required. 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 This property is required. Sequence[DataAccessor Action Configuration Args] - A list of action configurations specifying the allowed actions and any associated filters.
- application_
id This property is required. str - The unique identifier of the Amazon Q Business application.
- display_
name This property is required. str - The friendly name of the data accessor.
- principal
This property is required. str - The Amazon Resource Name (ARN) of the IAM role for the ISV associated with this data accessor.
- Sequence[Tag
Args] - The tags to associate with the data accessor.
- action
Configurations This property is required. List<Property Map> - A list of action configurations specifying the allowed actions and any associated filters.
- application
Id This property is required. String - The unique identifier of the Amazon Q Business application.
- display
Name This property is required. String - The friendly name of the data accessor.
- principal
This property is required. 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:
- Created
At string - The timestamp when the data accessor was created.
- Data
Accessor stringArn - The Amazon Resource Name (ARN) of the data accessor.
- Data
Accessor stringId - The unique identifier of the data accessor.
- Id string
- The provider-assigned unique ID for this managed resource.
- Idc
Application stringArn - The Amazon Resource Name (ARN) of the associated IAM Identity Center application.
- Updated
At string - The timestamp when the data accessor was last updated.
- Created
At string - The timestamp when the data accessor was created.
- Data
Accessor stringArn - The Amazon Resource Name (ARN) of the data accessor.
- Data
Accessor stringId - The unique identifier of the data accessor.
- Id string
- The provider-assigned unique ID for this managed resource.
- Idc
Application stringArn - The Amazon Resource Name (ARN) of the associated IAM Identity Center application.
- Updated
At string - The timestamp when the data accessor was last updated.
- created
At String - The timestamp when the data accessor was created.
- data
Accessor StringArn - The Amazon Resource Name (ARN) of the data accessor.
- data
Accessor StringId - The unique identifier of the data accessor.
- id String
- The provider-assigned unique ID for this managed resource.
- idc
Application StringArn - The Amazon Resource Name (ARN) of the associated IAM Identity Center application.
- updated
At String - The timestamp when the data accessor was last updated.
- created
At string - The timestamp when the data accessor was created.
- data
Accessor stringArn - The Amazon Resource Name (ARN) of the data accessor.
- data
Accessor stringId - The unique identifier of the data accessor.
- id string
- The provider-assigned unique ID for this managed resource.
- idc
Application stringArn - The Amazon Resource Name (ARN) of the associated IAM Identity Center application.
- updated
At 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.
- created
At String - The timestamp when the data accessor was created.
- data
Accessor StringArn - The Amazon Resource Name (ARN) of the data accessor.
- data
Accessor StringId - The unique identifier of the data accessor.
- id String
- The provider-assigned unique ID for this managed resource.
- idc
Application StringArn - The Amazon Resource Name (ARN) of the associated IAM Identity Center application.
- updated
At String - The timestamp when the data accessor was last updated.
Supporting Types
DataAccessorActionConfiguration, DataAccessorActionConfigurationArgs
- Action
This property is required. string - The Amazon Q Business action that is allowed.
- Filter
Configuration Pulumi.Aws Native. QBusiness. Inputs. Data Accessor Action Filter Configuration - The filter configuration for the action, if any.
- Action
This property is required. string - The Amazon Q Business action that is allowed.
- Filter
Configuration DataAccessor Action Filter Configuration - The filter configuration for the action, if any.
- action
This property is required. String - The Amazon Q Business action that is allowed.
- filter
Configuration DataAccessor Action Filter Configuration - The filter configuration for the action, if any.
- action
This property is required. string - The Amazon Q Business action that is allowed.
- filter
Configuration DataAccessor Action Filter Configuration - The filter configuration for the action, if any.
- action
This property is required. str - The Amazon Q Business action that is allowed.
- filter_
configuration DataAccessor Action Filter Configuration - The filter configuration for the action, if any.
- action
This property is required. String - The Amazon Q Business action that is allowed.
- filter
Configuration Property Map - The filter configuration for the action, if any.
DataAccessorActionFilterConfiguration, DataAccessorActionFilterConfigurationArgs
- Document
Attribute Filter This property is required. Pulumi.Aws Native. QBusiness. Inputs. Data Accessor Attribute Filter - Enables filtering of responses based on document attributes or metadata fields.
- Document
Attribute Filter This property is required. DataAccessor Attribute Filter - Enables filtering of responses based on document attributes or metadata fields.
- document
Attribute Filter This property is required. DataAccessor Attribute Filter - Enables filtering of responses based on document attributes or metadata fields.
- document
Attribute Filter This property is required. DataAccessor Attribute Filter - Enables filtering of responses based on document attributes or metadata fields.
- document_
attribute_ filter This property is required. DataAccessor Attribute Filter - Enables filtering of responses based on document attributes or metadata fields.
- document
Attribute Filter This property is required. Property Map - Enables filtering of responses based on document attributes or metadata fields.
DataAccessorAttributeFilter, DataAccessorAttributeFilterArgs
- And
All List<Pulumi.Filters Aws Native. QBusiness. Inputs. Data Accessor Attribute Filter> - Performs a logical
AND
operation on all supplied filters. - Contains
All Pulumi.Aws Native. QBusiness. Inputs. Data Accessor Document Attribute - 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 Pulumi.Aws Native. QBusiness. Inputs. Data Accessor Document Attribute - 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 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
,stringListValue
andstringValue
. - Greater
Than 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 :
dateValue
andlongValue
. - Greater
Than 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 :
dateValue
andlongValue
. - Less
Than 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 :
dateValue
andlongValue
. - Less
Than 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 :
dateValue
andlongValue
. - Not
Filter Pulumi.Aws Native. QBusiness. Inputs. Data Accessor Attribute Filter - Performs a logical
NOT
operation on all supplied filters. - Or
All List<Pulumi.Filters Aws Native. QBusiness. Inputs. Data Accessor Attribute Filter> - Performs a logical
OR
operation on all supplied filters.
- And
All []DataFilters Accessor Attribute Filter - Performs a logical
AND
operation on all supplied filters. - Contains
All DataAccessor Document Attribute - 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 DataAccessor Document Attribute - 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 DataAccessor Document Attribute - Performs an equals operation on two document attributes or metadata fields. Supported for the following document attribute value types :
dateValue
,longValue
,stringListValue
andstringValue
. - 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 :
dateValue
andlongValue
. - 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 :
dateValue
andlongValue
. - 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 :
dateValue
andlongValue
. - 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 :
dateValue
andlongValue
. - Not
Filter DataAccessor Attribute Filter - Performs a logical
NOT
operation on all supplied filters. - Or
All []DataFilters Accessor Attribute Filter - Performs a logical
OR
operation on all supplied filters.
- and
All List<DataFilters Accessor Attribute Filter> - Performs a logical
AND
operation on all supplied filters. - contains
All DataAccessor Document Attribute - 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 DataAccessor Document Attribute - 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 DataAccessor Document Attribute - Performs an equals operation on two document attributes or metadata fields. Supported for the following document attribute value types :
dateValue
,longValue
,stringListValue
andstringValue
. - 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 :
dateValue
andlongValue
. - 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 :
dateValue
andlongValue
. - 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 :
dateValue
andlongValue
. - 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 :
dateValue
andlongValue
. - not
Filter DataAccessor Attribute Filter - Performs a logical
NOT
operation on all supplied filters. - or
All List<DataFilters Accessor Attribute Filter> - Performs a logical
OR
operation on all supplied filters.
- and
All DataFilters Accessor Attribute Filter[] - Performs a logical
AND
operation on all supplied filters. - contains
All DataAccessor Document Attribute - 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 DataAccessor Document Attribute - 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 DataAccessor Document Attribute - Performs an equals operation on two document attributes or metadata fields. Supported for the following document attribute value types :
dateValue
,longValue
,stringListValue
andstringValue
. - 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 :
dateValue
andlongValue
. - 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 :
dateValue
andlongValue
. - 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 :
dateValue
andlongValue
. - 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 :
dateValue
andlongValue
. - not
Filter DataAccessor Attribute Filter - Performs a logical
NOT
operation on all supplied filters. - or
All DataFilters Accessor Attribute Filter[] - Performs a logical
OR
operation on all supplied filters.
- and_
all_ Sequence[Datafilters Accessor Attribute Filter] - Performs a logical
AND
operation on all supplied filters. - contains_
all DataAccessor Document Attribute - 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 DataAccessor Document Attribute - 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 DataAccessor Document Attribute - Performs an equals operation on two document attributes or metadata fields. Supported for the following document attribute value types :
dateValue
,longValue
,stringListValue
andstringValue
. - 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 :
dateValue
andlongValue
. - 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 :
dateValue
andlongValue
. - 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 :
dateValue
andlongValue
. - 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 :
dateValue
andlongValue
. - not_
filter DataAccessor Attribute Filter - Performs a logical
NOT
operation on all supplied filters. - or_
all_ Sequence[Datafilters Accessor Attribute Filter] - Performs a logical
OR
operation on all supplied filters.
- and
All List<Property Map>Filters - Performs a logical
AND
operation on all supplied filters. - contains
All Property Map - 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 Property Map - 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 Property Map - Performs an equals operation on two document attributes or metadata fields. Supported for the following document attribute value types :
dateValue
,longValue
,stringListValue
andstringValue
. - greater
Than Property Map - Performs a greater than operation on two document attributes or metadata fields. Supported for the following document attribute value types :
dateValue
andlongValue
. - greater
Than 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 :
dateValue
andlongValue
. - less
Than Property Map - Performs a less than operation on two document attributes or metadata fields. Supported for the following document attribute value types :
dateValue
andlongValue
. - less
Than 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 :
dateValue
andlongValue
. - not
Filter Property Map - Performs a logical
NOT
operation on all supplied filters. - or
All List<Property Map>Filters - Performs a logical
OR
operation on all supplied filters.
DataAccessorDocumentAttribute, DataAccessorDocumentAttributeArgs
- Name
This property is required. string - The identifier for the attribute.
- Value
This property is required. 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
This property is required. string - The identifier for the attribute.
- Value
This property is required. DataAccessor | DataDocument Attribute Value0Properties Accessor | DataDocument Attribute Value1Properties Accessor | DataDocument Attribute Value2Properties Accessor Document Attribute Value3Properties - The value of the attribute.
- name
This property is required. String - The identifier for the attribute.
- value
This property is required. DataAccessor | DataDocument Attribute Value0Properties Accessor | DataDocument Attribute Value1Properties Accessor | DataDocument Attribute Value2Properties Accessor Document Attribute Value3Properties - The value of the attribute.
- name
This property is required. string - The identifier for the attribute.
- value
This property is required. DataAccessor | DataDocument Attribute Value0Properties Accessor | DataDocument Attribute Value1Properties Accessor | DataDocument Attribute Value2Properties Accessor Document Attribute Value3Properties - The value of the attribute.
- name
This property is required. str - The identifier for the attribute.
- value
This property is required. DataAccessor | DataDocument Attribute Value0Properties Accessor | DataDocument Attribute Value1Properties Accessor | DataDocument Attribute Value2Properties Accessor Document Attribute Value3Properties - The value of the attribute.
- name
This property is required. String - The identifier for the attribute.
- value
This property is required. Property Map | Property Map | Property Map | Property Map - The value of the attribute.
DataAccessorDocumentAttributeValue0Properties, DataAccessorDocumentAttributeValue0PropertiesArgs
- String
Value This property is required. string
- String
Value This property is required. string
- string
Value This property is required. String
- string
Value This property is required. string
- string_
value This property is required. str
- string
Value This property is required. String
DataAccessorDocumentAttributeValue1Properties, DataAccessorDocumentAttributeValue1PropertiesArgs
- String
List Value This property is required. List<string>
- String
List Value This property is required. []string
- string
List Value This property is required. List<String>
- string
List Value This property is required. string[]
- string_
list_ value This property is required. Sequence[str]
- string
List Value This property is required. List<String>
DataAccessorDocumentAttributeValue2Properties, DataAccessorDocumentAttributeValue2PropertiesArgs
- Long
Value This property is required. double
- Long
Value This property is required. float64
- long
Value This property is required. Double
- long
Value This property is required. number
- long_
value This property is required. float
- long
Value This property is required. Number
DataAccessorDocumentAttributeValue3Properties, DataAccessorDocumentAttributeValue3PropertiesArgs
- Date
Value This property is required. string
- Date
Value This property is required. string
- date
Value This property is required. String
- date
Value This property is required. string
- date_
value This property is required. str
- date
Value This property is required. 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.