1. Packages
  2. AWS Native
  3. API Docs
  4. qbusiness
  5. DataSource

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi

aws-native.qbusiness.DataSource

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi

    Definition of AWS::QBusiness::DataSource Resource Type

    Create DataSource Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new DataSource(name: string, args: DataSourceArgs, opts?: CustomResourceOptions);
    @overload
    def DataSource(resource_name: str,
                   args: DataSourceArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def DataSource(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   application_id: Optional[str] = None,
                   configuration: Optional[Any] = None,
                   display_name: Optional[str] = None,
                   index_id: Optional[str] = None,
                   description: Optional[str] = None,
                   document_enrichment_configuration: Optional[DataSourceDocumentEnrichmentConfigurationArgs] = None,
                   role_arn: Optional[str] = None,
                   sync_schedule: Optional[str] = None,
                   tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
                   vpc_configuration: Optional[DataSourceVpcConfigurationArgs] = None)
    func NewDataSource(ctx *Context, name string, args DataSourceArgs, opts ...ResourceOption) (*DataSource, error)
    public DataSource(string name, DataSourceArgs args, CustomResourceOptions? opts = null)
    public DataSource(String name, DataSourceArgs args)
    public DataSource(String name, DataSourceArgs args, CustomResourceOptions options)
    
    type: aws-native:qbusiness:DataSource
    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 DataSourceArgs
    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 DataSourceArgs
    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 DataSourceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DataSourceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DataSourceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const exampledataSourceResourceResourceFromQbusiness = new aws_native.qbusiness.DataSource("exampledataSourceResourceResourceFromQbusiness", {
        applicationId: "string",
        configuration: "any",
        displayName: "string",
        indexId: "string",
        description: "string",
        documentEnrichmentConfiguration: {
            inlineConfigurations: [{
                condition: {
                    key: "string",
                    operator: aws_native.qbusiness.DataSourceDocumentEnrichmentConditionOperator.GreaterThan,
                    value: {
                        stringValue: "string",
                    },
                },
                documentContentOperator: aws_native.qbusiness.DataSourceDocumentContentOperator.Delete,
                target: {
                    key: "string",
                    attributeValueOperator: aws_native.qbusiness.DataSourceAttributeValueOperator.Delete,
                    value: {
                        stringValue: "string",
                    },
                },
            }],
            postExtractionHookConfiguration: {
                invocationCondition: {
                    key: "string",
                    operator: aws_native.qbusiness.DataSourceDocumentEnrichmentConditionOperator.GreaterThan,
                    value: {
                        stringValue: "string",
                    },
                },
                lambdaArn: "string",
                roleArn: "string",
                s3BucketName: "string",
            },
            preExtractionHookConfiguration: {
                invocationCondition: {
                    key: "string",
                    operator: aws_native.qbusiness.DataSourceDocumentEnrichmentConditionOperator.GreaterThan,
                    value: {
                        stringValue: "string",
                    },
                },
                lambdaArn: "string",
                roleArn: "string",
                s3BucketName: "string",
            },
        },
        roleArn: "string",
        syncSchedule: "string",
        tags: [{
            key: "string",
            value: "string",
        }],
        vpcConfiguration: {
            securityGroupIds: ["string"],
            subnetIds: ["string"],
        },
    });
    
    Coming soon!
    

    DataSource Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The DataSource resource accepts the following input properties:

    ApplicationId string
    Configuration interface{}
    Search the CloudFormation User Guide for AWS::QBusiness::DataSource for more information about the expected schema for this property.
    DisplayName string
    IndexId string
    Description string
    DocumentEnrichmentConfiguration DataSourceDocumentEnrichmentConfigurationArgs
    RoleArn string
    SyncSchedule string
    Tags TagArgs
    VpcConfiguration DataSourceVpcConfigurationArgs
    applicationId String
    configuration Object
    Search the CloudFormation User Guide for AWS::QBusiness::DataSource for more information about the expected schema for this property.
    displayName String
    indexId String
    description String
    documentEnrichmentConfiguration DataSourceDocumentEnrichmentConfiguration
    roleArn String
    syncSchedule String
    tags List<Tag>
    vpcConfiguration DataSourceVpcConfiguration
    applicationId string
    configuration any
    Search the CloudFormation User Guide for AWS::QBusiness::DataSource for more information about the expected schema for this property.
    displayName string
    indexId string
    description string
    documentEnrichmentConfiguration DataSourceDocumentEnrichmentConfiguration
    roleArn string
    syncSchedule string
    tags Tag[]
    vpcConfiguration DataSourceVpcConfiguration
    applicationId String
    configuration Any
    Search the CloudFormation User Guide for AWS::QBusiness::DataSource for more information about the expected schema for this property.
    displayName String
    indexId String
    description String
    documentEnrichmentConfiguration Property Map
    roleArn String
    syncSchedule String
    tags List<Property Map>
    vpcConfiguration Property Map

    Outputs

    All input properties are implicitly available as output properties. Additionally, the DataSource resource produces the following output properties:

    CreatedAt string
    DataSourceArn string
    DataSourceId string
    Id string
    The provider-assigned unique ID for this managed resource.
    Status Pulumi.AwsNative.QBusiness.DataSourceStatus
    Type string
    UpdatedAt string
    CreatedAt string
    DataSourceArn string
    DataSourceId string
    Id string
    The provider-assigned unique ID for this managed resource.
    Status DataSourceStatus
    Type string
    UpdatedAt string
    createdAt String
    dataSourceArn String
    dataSourceId String
    id String
    The provider-assigned unique ID for this managed resource.
    status DataSourceStatus
    type String
    updatedAt String
    createdAt string
    dataSourceArn string
    dataSourceId string
    id string
    The provider-assigned unique ID for this managed resource.
    status DataSourceStatus
    type string
    updatedAt string
    created_at str
    data_source_arn str
    data_source_id str
    id str
    The provider-assigned unique ID for this managed resource.
    status DataSourceStatus
    type str
    updated_at str
    createdAt String
    dataSourceArn String
    dataSourceId String
    id String
    The provider-assigned unique ID for this managed resource.
    status "PENDING_CREATION" | "CREATING" | "ACTIVE" | "DELETING" | "FAILED" | "UPDATING"
    type String
    updatedAt String

    Supporting Types

    DataSourceAttributeValueOperator, DataSourceAttributeValueOperatorArgs

    Delete
    DELETE
    DataSourceAttributeValueOperatorDelete
    DELETE
    Delete
    DELETE
    Delete
    DELETE
    DELETE
    DELETE
    "DELETE"
    DELETE

    DataSourceDocumentAttributeCondition, DataSourceDocumentAttributeConditionArgs

    DataSourceDocumentAttributeTarget, DataSourceDocumentAttributeTargetArgs

    DataSourceDocumentAttributeValue0Properties, DataSourceDocumentAttributeValue0PropertiesArgs

    DataSourceDocumentAttributeValue1Properties, DataSourceDocumentAttributeValue1PropertiesArgs

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

    DataSourceDocumentAttributeValue2Properties, DataSourceDocumentAttributeValue2PropertiesArgs

    LongValue double
    LongValue float64
    longValue Double
    longValue number
    longValue Number

    DataSourceDocumentAttributeValue3Properties, DataSourceDocumentAttributeValue3PropertiesArgs

    DateValue string
    DateValue string
    dateValue String
    dateValue string
    dateValue String

    DataSourceDocumentContentOperator, DataSourceDocumentContentOperatorArgs

    Delete
    DELETE
    DataSourceDocumentContentOperatorDelete
    DELETE
    Delete
    DELETE
    Delete
    DELETE
    DELETE
    DELETE
    "DELETE"
    DELETE

    DataSourceDocumentEnrichmentConditionOperator, DataSourceDocumentEnrichmentConditionOperatorArgs

    GreaterThan
    GREATER_THAN
    GreaterThanOrEquals
    GREATER_THAN_OR_EQUALS
    LessThan
    LESS_THAN
    LessThanOrEquals
    LESS_THAN_OR_EQUALS
    EqualsValue
    EQUALS
    NotEquals
    NOT_EQUALS
    Contains
    CONTAINS
    NotContains
    NOT_CONTAINS
    Exists
    EXISTS
    NotExists
    NOT_EXISTS
    BeginsWith
    BEGINS_WITH
    DataSourceDocumentEnrichmentConditionOperatorGreaterThan
    GREATER_THAN
    DataSourceDocumentEnrichmentConditionOperatorGreaterThanOrEquals
    GREATER_THAN_OR_EQUALS
    DataSourceDocumentEnrichmentConditionOperatorLessThan
    LESS_THAN
    DataSourceDocumentEnrichmentConditionOperatorLessThanOrEquals
    LESS_THAN_OR_EQUALS
    DataSourceDocumentEnrichmentConditionOperatorEquals
    EQUALS
    DataSourceDocumentEnrichmentConditionOperatorNotEquals
    NOT_EQUALS
    DataSourceDocumentEnrichmentConditionOperatorContains
    CONTAINS
    DataSourceDocumentEnrichmentConditionOperatorNotContains
    NOT_CONTAINS
    DataSourceDocumentEnrichmentConditionOperatorExists
    EXISTS
    DataSourceDocumentEnrichmentConditionOperatorNotExists
    NOT_EXISTS
    DataSourceDocumentEnrichmentConditionOperatorBeginsWith
    BEGINS_WITH
    GreaterThan
    GREATER_THAN
    GreaterThanOrEquals
    GREATER_THAN_OR_EQUALS
    LessThan
    LESS_THAN
    LessThanOrEquals
    LESS_THAN_OR_EQUALS
    Equals
    EQUALS
    NotEquals
    NOT_EQUALS
    Contains
    CONTAINS
    NotContains
    NOT_CONTAINS
    Exists
    EXISTS
    NotExists
    NOT_EXISTS
    BeginsWith
    BEGINS_WITH
    GreaterThan
    GREATER_THAN
    GreaterThanOrEquals
    GREATER_THAN_OR_EQUALS
    LessThan
    LESS_THAN
    LessThanOrEquals
    LESS_THAN_OR_EQUALS
    Equals
    EQUALS
    NotEquals
    NOT_EQUALS
    Contains
    CONTAINS
    NotContains
    NOT_CONTAINS
    Exists
    EXISTS
    NotExists
    NOT_EXISTS
    BeginsWith
    BEGINS_WITH
    GREATER_THAN
    GREATER_THAN
    GREATER_THAN_OR_EQUALS
    GREATER_THAN_OR_EQUALS
    LESS_THAN
    LESS_THAN
    LESS_THAN_OR_EQUALS
    LESS_THAN_OR_EQUALS
    EQUALS
    EQUALS
    NOT_EQUALS
    NOT_EQUALS
    CONTAINS
    CONTAINS
    NOT_CONTAINS
    NOT_CONTAINS
    EXISTS
    EXISTS
    NOT_EXISTS
    NOT_EXISTS
    BEGINS_WITH
    BEGINS_WITH
    "GREATER_THAN"
    GREATER_THAN
    "GREATER_THAN_OR_EQUALS"
    GREATER_THAN_OR_EQUALS
    "LESS_THAN"
    LESS_THAN
    "LESS_THAN_OR_EQUALS"
    LESS_THAN_OR_EQUALS
    "EQUALS"
    EQUALS
    "NOT_EQUALS"
    NOT_EQUALS
    "CONTAINS"
    CONTAINS
    "NOT_CONTAINS"
    NOT_CONTAINS
    "EXISTS"
    EXISTS
    "NOT_EXISTS"
    NOT_EXISTS
    "BEGINS_WITH"
    BEGINS_WITH

    DataSourceDocumentEnrichmentConfiguration, DataSourceDocumentEnrichmentConfigurationArgs

    DataSourceHookConfiguration, DataSourceHookConfigurationArgs

    DataSourceInlineDocumentEnrichmentConfiguration, DataSourceInlineDocumentEnrichmentConfigurationArgs

    DataSourceStatus, DataSourceStatusArgs

    PendingCreation
    PENDING_CREATION
    Creating
    CREATING
    Active
    ACTIVE
    Deleting
    DELETING
    Failed
    FAILED
    Updating
    UPDATING
    DataSourceStatusPendingCreation
    PENDING_CREATION
    DataSourceStatusCreating
    CREATING
    DataSourceStatusActive
    ACTIVE
    DataSourceStatusDeleting
    DELETING
    DataSourceStatusFailed
    FAILED
    DataSourceStatusUpdating
    UPDATING
    PendingCreation
    PENDING_CREATION
    Creating
    CREATING
    Active
    ACTIVE
    Deleting
    DELETING
    Failed
    FAILED
    Updating
    UPDATING
    PendingCreation
    PENDING_CREATION
    Creating
    CREATING
    Active
    ACTIVE
    Deleting
    DELETING
    Failed
    FAILED
    Updating
    UPDATING
    PENDING_CREATION
    PENDING_CREATION
    CREATING
    CREATING
    ACTIVE
    ACTIVE
    DELETING
    DELETING
    FAILED
    FAILED
    UPDATING
    UPDATING
    "PENDING_CREATION"
    PENDING_CREATION
    "CREATING"
    CREATING
    "ACTIVE"
    ACTIVE
    "DELETING"
    DELETING
    "FAILED"
    FAILED
    "UPDATING"
    UPDATING

    DataSourceVpcConfiguration, DataSourceVpcConfigurationArgs

    SecurityGroupIds List<string>
    SubnetIds List<string>
    SecurityGroupIds []string
    SubnetIds []string
    securityGroupIds List<String>
    subnetIds List<String>
    securityGroupIds string[]
    subnetIds string[]
    security_group_ids Sequence[str]
    subnet_ids Sequence[str]
    securityGroupIds List<String>
    subnetIds List<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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi