1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. qbusiness
  5. DataAccessor

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.23.0 published on Friday, Jan 10, 2025 by Pulumi

aws-native.qbusiness.DataAccessor

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.23.0 published on Friday, Jan 10, 2025 by Pulumi

    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.AwsNative.QBusiness.Inputs.DataAccessorActionConfiguration>
    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.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    The tags to associate with the data accessor.
    ActionConfigurations []DataAccessorActionConfigurationArgs
    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.
    Tags TagArgs
    The tags to associate with the data accessor.
    actionConfigurations List<DataAccessorActionConfiguration>
    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.
    tags List<Tag>
    The tags to associate with the data accessor.
    actionConfigurations DataAccessorActionConfiguration[]
    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.
    tags Tag[]
    The tags to associate with the data accessor.
    action_configurations Sequence[DataAccessorActionConfigurationArgs]
    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.
    tags 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.
    tags 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.
    DataAccessorArn string
    The Amazon Resource Name (ARN) of the data accessor.
    DataAccessorId string
    The unique identifier of the data accessor.
    Id string
    The provider-assigned unique ID for this managed resource.
    IdcApplicationArn string
    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.
    DataAccessorArn string
    The Amazon Resource Name (ARN) of the data accessor.
    DataAccessorId string
    The unique identifier of the data accessor.
    Id string
    The provider-assigned unique ID for this managed resource.
    IdcApplicationArn string
    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.
    dataAccessorArn String
    The Amazon Resource Name (ARN) of the data accessor.
    dataAccessorId String
    The unique identifier of the data accessor.
    id String
    The provider-assigned unique ID for this managed resource.
    idcApplicationArn String
    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.
    dataAccessorArn string
    The Amazon Resource Name (ARN) of the data accessor.
    dataAccessorId string
    The unique identifier of the data accessor.
    id string
    The provider-assigned unique ID for this managed resource.
    idcApplicationArn string
    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_arn str
    The Amazon Resource Name (ARN) of the data accessor.
    data_accessor_id str
    The unique identifier of the data accessor.
    id str
    The provider-assigned unique ID for this managed resource.
    idc_application_arn str
    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.
    dataAccessorArn String
    The Amazon Resource Name (ARN) of the data accessor.
    dataAccessorId String
    The unique identifier of the data accessor.
    id String
    The provider-assigned unique ID for this managed resource.
    idcApplicationArn String
    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.AwsNative.QBusiness.Inputs.DataAccessorActionFilterConfiguration
    The filter configuration for the action, if any.
    Action string
    The Amazon Q Business action that is allowed.
    FilterConfiguration DataAccessorActionFilterConfiguration
    The filter configuration for the action, if any.
    action String
    The Amazon Q Business action that is allowed.
    filterConfiguration DataAccessorActionFilterConfiguration
    The filter configuration for the action, if any.
    action string
    The Amazon Q Business action that is allowed.
    filterConfiguration DataAccessorActionFilterConfiguration
    The filter configuration for the action, if any.
    action str
    The Amazon Q Business action that is allowed.
    filter_configuration DataAccessorActionFilterConfiguration
    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

    DocumentAttributeFilter Pulumi.AwsNative.QBusiness.Inputs.DataAccessorAttributeFilter
    Enables filtering of responses based on document attributes or metadata fields.
    DocumentAttributeFilter DataAccessorAttributeFilter
    Enables filtering of responses based on document attributes or metadata fields.
    documentAttributeFilter DataAccessorAttributeFilter
    Enables filtering of responses based on document attributes or metadata fields.
    documentAttributeFilter DataAccessorAttributeFilter
    Enables filtering of responses based on document attributes or metadata fields.
    document_attribute_filter DataAccessorAttributeFilter
    Enables filtering of responses based on document attributes or metadata fields.
    documentAttributeFilter Property Map
    Enables filtering of responses based on document attributes or metadata fields.

    DataAccessorAttributeFilter, DataAccessorAttributeFilterArgs

    AndAllFilters List<Pulumi.AwsNative.QBusiness.Inputs.DataAccessorAttributeFilter>
    Performs a logical AND operation on all supplied filters.
    ContainsAll Pulumi.AwsNative.QBusiness.Inputs.DataAccessorDocumentAttribute
    Returns true when a document contains all the specified document attributes or metadata fields. Supported for the following document attribute value types : stringListValue .
    ContainsAny Pulumi.AwsNative.QBusiness.Inputs.DataAccessorDocumentAttribute
    Returns true when a document contains any of the specified document attributes or metadata fields. Supported for the following document attribute value types : stringListValue .
    EqualsTo Pulumi.AwsNative.QBusiness.Inputs.DataAccessorDocumentAttribute
    Performs an equals operation on two document attributes or metadata fields. Supported for the following document attribute value types : dateValue , longValue , stringListValue and stringValue .
    GreaterThan Pulumi.AwsNative.QBusiness.Inputs.DataAccessorDocumentAttribute
    Performs a greater than operation on two document attributes or metadata fields. Supported for the following document attribute value types : dateValue and longValue .
    GreaterThanOrEquals Pulumi.AwsNative.QBusiness.Inputs.DataAccessorDocumentAttribute
    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 .
    LessThan Pulumi.AwsNative.QBusiness.Inputs.DataAccessorDocumentAttribute
    Performs a less than operation on two document attributes or metadata fields. Supported for the following document attribute value types : dateValue and longValue .
    LessThanOrEquals Pulumi.AwsNative.QBusiness.Inputs.DataAccessorDocumentAttribute
    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 .
    NotFilter Pulumi.AwsNative.QBusiness.Inputs.DataAccessorAttributeFilter
    Performs a logical NOT operation on all supplied filters.
    OrAllFilters List<Pulumi.AwsNative.QBusiness.Inputs.DataAccessorAttributeFilter>
    Performs a logical OR operation on all supplied filters.
    AndAllFilters []DataAccessorAttributeFilter
    Performs a logical AND operation on all supplied filters.
    ContainsAll DataAccessorDocumentAttribute
    Returns true when a document contains all the specified document attributes or metadata fields. Supported for the following document attribute value types : stringListValue .
    ContainsAny DataAccessorDocumentAttribute
    Returns true when a document contains any of the specified document attributes or metadata fields. Supported for the following document attribute value types : stringListValue .
    EqualsTo DataAccessorDocumentAttribute
    Performs an equals operation on two document attributes or metadata fields. Supported for the following document attribute value types : dateValue , longValue , stringListValue and stringValue .
    GreaterThan DataAccessorDocumentAttribute
    Performs a greater than operation on two document attributes or metadata fields. Supported for the following document attribute value types : dateValue and longValue .
    GreaterThanOrEquals DataAccessorDocumentAttribute
    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 .
    LessThan DataAccessorDocumentAttribute
    Performs a less than operation on two document attributes or metadata fields. Supported for the following document attribute value types : dateValue and longValue .
    LessThanOrEquals DataAccessorDocumentAttribute
    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 .
    NotFilter DataAccessorAttributeFilter
    Performs a logical NOT operation on all supplied filters.
    OrAllFilters []DataAccessorAttributeFilter
    Performs a logical OR operation on all supplied filters.
    andAllFilters List<DataAccessorAttributeFilter>
    Performs a logical AND operation on all supplied filters.
    containsAll DataAccessorDocumentAttribute
    Returns true when a document contains all the specified document attributes or metadata fields. Supported for the following document attribute value types : stringListValue .
    containsAny DataAccessorDocumentAttribute
    Returns true when a document contains any of the specified document attributes or metadata fields. Supported for the following document attribute value types : stringListValue .
    equalsTo DataAccessorDocumentAttribute
    Performs an equals operation on two document attributes or metadata fields. Supported for the following document attribute value types : dateValue , longValue , stringListValue and stringValue .
    greaterThan DataAccessorDocumentAttribute
    Performs a greater than operation on two document attributes or metadata fields. Supported for the following document attribute value types : dateValue and longValue .
    greaterThanOrEquals DataAccessorDocumentAttribute
    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 .
    lessThan DataAccessorDocumentAttribute
    Performs a less than operation on two document attributes or metadata fields. Supported for the following document attribute value types : dateValue and longValue .
    lessThanOrEquals DataAccessorDocumentAttribute
    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 .
    notFilter DataAccessorAttributeFilter
    Performs a logical NOT operation on all supplied filters.
    orAllFilters List<DataAccessorAttributeFilter>
    Performs a logical OR operation on all supplied filters.
    andAllFilters DataAccessorAttributeFilter[]
    Performs a logical AND operation on all supplied filters.
    containsAll DataAccessorDocumentAttribute
    Returns true when a document contains all the specified document attributes or metadata fields. Supported for the following document attribute value types : stringListValue .
    containsAny DataAccessorDocumentAttribute
    Returns true when a document contains any of the specified document attributes or metadata fields. Supported for the following document attribute value types : stringListValue .
    equalsTo DataAccessorDocumentAttribute
    Performs an equals operation on two document attributes or metadata fields. Supported for the following document attribute value types : dateValue , longValue , stringListValue and stringValue .
    greaterThan DataAccessorDocumentAttribute
    Performs a greater than operation on two document attributes or metadata fields. Supported for the following document attribute value types : dateValue and longValue .
    greaterThanOrEquals DataAccessorDocumentAttribute
    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 .
    lessThan DataAccessorDocumentAttribute
    Performs a less than operation on two document attributes or metadata fields. Supported for the following document attribute value types : dateValue and longValue .
    lessThanOrEquals DataAccessorDocumentAttribute
    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 .
    notFilter DataAccessorAttributeFilter
    Performs a logical NOT operation on all supplied filters.
    orAllFilters DataAccessorAttributeFilter[]
    Performs a logical OR operation on all supplied filters.
    and_all_filters Sequence[DataAccessorAttributeFilter]
    Performs a logical AND operation on all supplied filters.
    contains_all DataAccessorDocumentAttribute
    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 DataAccessorDocumentAttribute
    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 DataAccessorDocumentAttribute
    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 DataAccessorDocumentAttribute
    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 DataAccessorDocumentAttribute
    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 DataAccessorDocumentAttribute
    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 DataAccessorDocumentAttribute
    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 DataAccessorAttributeFilter
    Performs a logical NOT operation on all supplied filters.
    or_all_filters Sequence[DataAccessorAttributeFilter]
    Performs a logical OR operation on all supplied filters.
    andAllFilters List<Property Map>
    Performs a logical AND operation on all supplied filters.
    containsAll 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 .
    containsAny 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 .
    equalsTo Property Map
    Performs an equals operation on two document attributes or metadata fields. Supported for the following document attribute value types : dateValue , longValue , stringListValue and stringValue .
    greaterThan Property Map
    Performs a greater than operation on two document attributes or metadata fields. Supported for the following document attribute value types : dateValue and longValue .
    greaterThanOrEquals Property Map
    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 .
    lessThan Property Map
    Performs a less than operation on two document attributes or metadata fields. Supported for the following document attribute value types : dateValue and longValue .
    lessThanOrEquals Property Map
    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 .
    notFilter Property Map
    Performs a logical NOT operation on all supplied filters.
    orAllFilters List<Property Map>
    Performs a logical OR operation on all supplied filters.

    DataAccessorDocumentAttribute, DataAccessorDocumentAttributeArgs

    name String
    The identifier for the attribute.
    value Property Map | Property Map | Property Map | Property Map
    The value of the attribute.

    DataAccessorDocumentAttributeValue0Properties, DataAccessorDocumentAttributeValue0PropertiesArgs

    DataAccessorDocumentAttributeValue1Properties, DataAccessorDocumentAttributeValue1PropertiesArgs

    StringListValue List<string>
    stringListValue List<String>
    string_list_value Sequence[str]
    stringListValue List<String>

    DataAccessorDocumentAttributeValue2Properties, DataAccessorDocumentAttributeValue2PropertiesArgs

    LongValue double
    LongValue float64
    longValue Double
    longValue number
    longValue Number

    DataAccessorDocumentAttributeValue3Properties, DataAccessorDocumentAttributeValue3PropertiesArgs

    DateValue string
    DateValue string
    dateValue String
    dateValue string
    dateValue String

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.23.0 published on Friday, Jan 10, 2025 by Pulumi