Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Native
  3. API Docs
  4. qbusiness
  5. Retriever

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

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.qbusiness.Retriever

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

    Definition of AWS::QBusiness::Retriever Resource Type

    Create Retriever Resource

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

    Constructor syntax

    new Retriever(name: string, args: RetrieverArgs, opts?: CustomResourceOptions);
    @overload
def Retriever(resource_name: str,
              args: RetrieverArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def Retriever(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              application_id: Optional[str] = None,
              configuration: Optional[Union[RetrieverConfiguration0PropertiesArgs, RetrieverConfiguration1PropertiesArgs]] = None,
              display_name: Optional[str] = None,
              type: Optional[RetrieverType] = None,
              role_arn: Optional[str] = None,
              tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewRetriever(ctx *Context, name string, args RetrieverArgs, opts ...ResourceOption) (*Retriever, error)
    public Retriever(string name, RetrieverArgs args, CustomResourceOptions? opts = null)
    public Retriever(String name, RetrieverArgs args)
public Retriever(String name, RetrieverArgs args, CustomResourceOptions options)

    type: aws-native:qbusiness:Retriever
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 RetrieverArgs
    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 RetrieverArgs
    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 RetrieverArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RetrieverArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RetrieverArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Retriever 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 Retriever resource accepts the following input properties:

    ApplicationId string
    The identifier of the Amazon Q Business application using the retriever.
    Configuration Pulumi.AwsNative.QBusiness.Inputs.RetrieverConfiguration0Properties | Pulumi.AwsNative.QBusiness.Inputs.RetrieverConfiguration1Properties
    Provides information on how the retriever used for your Amazon Q Business application is configured.
    DisplayName string
    The name of your retriever.
    Type Pulumi.AwsNative.QBusiness.RetrieverType
    The type of your retriever.
    RoleArn string
    The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    A list of key-value pairs that identify or categorize the retriever. You can also use tags to help control access to the retriever. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
    ApplicationId string
    The identifier of the Amazon Q Business application using the retriever.
    Configuration RetrieverConfiguration0PropertiesArgs | RetrieverConfiguration1PropertiesArgs
    Provides information on how the retriever used for your Amazon Q Business application is configured.
    DisplayName string
    The name of your retriever.
    Type RetrieverType
    The type of your retriever.
    RoleArn string
    The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.
    Tags TagArgs
    A list of key-value pairs that identify or categorize the retriever. You can also use tags to help control access to the retriever. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
    applicationId String
    The identifier of the Amazon Q Business application using the retriever.
    configuration RetrieverConfiguration0Properties | RetrieverConfiguration1Properties
    Provides information on how the retriever used for your Amazon Q Business application is configured.
    displayName String
    The name of your retriever.
    type RetrieverType
    The type of your retriever.
    roleArn String
    The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.
    tags List<Tag>
    A list of key-value pairs that identify or categorize the retriever. You can also use tags to help control access to the retriever. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
    applicationId string
    The identifier of the Amazon Q Business application using the retriever.
    configuration RetrieverConfiguration0Properties | RetrieverConfiguration1Properties
    Provides information on how the retriever used for your Amazon Q Business application is configured.
    displayName string
    The name of your retriever.
    type RetrieverType
    The type of your retriever.
    roleArn string
    The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.
    tags Tag[]
    A list of key-value pairs that identify or categorize the retriever. You can also use tags to help control access to the retriever. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
    application_id str
    The identifier of the Amazon Q Business application using the retriever.
    configuration RetrieverConfiguration0PropertiesArgs | RetrieverConfiguration1PropertiesArgs
    Provides information on how the retriever used for your Amazon Q Business application is configured.
    display_name str
    The name of your retriever.
    type RetrieverType
    The type of your retriever.
    role_arn str
    The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.
    tags Sequence[TagArgs]
    A list of key-value pairs that identify or categorize the retriever. You can also use tags to help control access to the retriever. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.
    applicationId String
    The identifier of the Amazon Q Business application using the retriever.
    configuration Property Map | Property Map
    Provides information on how the retriever used for your Amazon Q Business application is configured.
    displayName String
    The name of your retriever.
    type "NATIVE_INDEX" | "KENDRA_INDEX"
    The type of your retriever.
    roleArn String
    The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.
    tags List<Property Map>
    A list of key-value pairs that identify or categorize the retriever. You can also use tags to help control access to the retriever. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

    Outputs

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

    CreatedAt string
    The Unix timestamp when the retriever was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    RetrieverArn string
    The Amazon Resource Name (ARN) of the IAM role associated with the retriever.
    RetrieverId string
    The identifier of the retriever used by your Amazon Q Business application.
    Status Pulumi.AwsNative.QBusiness.RetrieverStatus
    The status of your retriever.
    UpdatedAt string
    The Unix timestamp when the retriever was last updated.
    CreatedAt string
    The Unix timestamp when the retriever was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    RetrieverArn string
    The Amazon Resource Name (ARN) of the IAM role associated with the retriever.
    RetrieverId string
    The identifier of the retriever used by your Amazon Q Business application.
    Status RetrieverStatus
    The status of your retriever.
    UpdatedAt string
    The Unix timestamp when the retriever was last updated.
    createdAt String
    The Unix timestamp when the retriever was created.
    id String
    The provider-assigned unique ID for this managed resource.
    retrieverArn String
    The Amazon Resource Name (ARN) of the IAM role associated with the retriever.
    retrieverId String
    The identifier of the retriever used by your Amazon Q Business application.
    status RetrieverStatus
    The status of your retriever.
    updatedAt String
    The Unix timestamp when the retriever was last updated.
    createdAt string
    The Unix timestamp when the retriever was created.
    id string
    The provider-assigned unique ID for this managed resource.
    retrieverArn string
    The Amazon Resource Name (ARN) of the IAM role associated with the retriever.
    retrieverId string
    The identifier of the retriever used by your Amazon Q Business application.
    status RetrieverStatus
    The status of your retriever.
    updatedAt string
    The Unix timestamp when the retriever was last updated.
    created_at str
    The Unix timestamp when the retriever was created.
    id str
    The provider-assigned unique ID for this managed resource.
    retriever_arn str
    The Amazon Resource Name (ARN) of the IAM role associated with the retriever.
    retriever_id str
    The identifier of the retriever used by your Amazon Q Business application.
    status RetrieverStatus
    The status of your retriever.
    updated_at str
    The Unix timestamp when the retriever was last updated.
    createdAt String
    The Unix timestamp when the retriever was created.
    id String
    The provider-assigned unique ID for this managed resource.
    retrieverArn String
    The Amazon Resource Name (ARN) of the IAM role associated with the retriever.
    retrieverId String
    The identifier of the retriever used by your Amazon Q Business application.
    status "CREATING" | "ACTIVE" | "FAILED"
    The status of your retriever.
    updatedAt String
    The Unix timestamp when the retriever was last updated.

    Supporting Types

    RetrieverConfiguration0Properties, RetrieverConfiguration0PropertiesArgs

    RetrieverConfiguration1Properties, RetrieverConfiguration1PropertiesArgs

    RetrieverKendraIndexConfiguration, RetrieverKendraIndexConfigurationArgs

    IndexId string
    IndexId string
    indexId String
    indexId string
    indexId String

    RetrieverNativeIndexConfiguration, RetrieverNativeIndexConfigurationArgs

    IndexId string
    IndexId string
    indexId String
    indexId string
    indexId String

    RetrieverStatus, RetrieverStatusArgs

    Creating
    CREATING
    Active
    ACTIVE
    Failed
    FAILED
    RetrieverStatusCreating
    CREATING
    RetrieverStatusActive
    ACTIVE
    RetrieverStatusFailed
    FAILED
    Creating
    CREATING
    Active
    ACTIVE
    Failed
    FAILED
    Creating
    CREATING
    Active
    ACTIVE
    Failed
    FAILED
    CREATING
    CREATING
    ACTIVE
    ACTIVE
    FAILED
    FAILED
    "CREATING"
    CREATING
    "ACTIVE"
    ACTIVE
    "FAILED"
    FAILED

    RetrieverType, RetrieverTypeArgs

    NativeIndex
    NATIVE_INDEX
    KendraIndex
    KENDRA_INDEX
    RetrieverTypeNativeIndex
    NATIVE_INDEX
    RetrieverTypeKendraIndex
    KENDRA_INDEX
    NativeIndex
    NATIVE_INDEX
    KendraIndex
    KENDRA_INDEX
    NativeIndex
    NATIVE_INDEX
    KendraIndex
    KENDRA_INDEX
    NATIVE_INDEX
    NATIVE_INDEX
    KENDRA_INDEX
    KENDRA_INDEX
    "NATIVE_INDEX"
    NATIVE_INDEX
    "KENDRA_INDEX"
    KENDRA_INDEX

    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 Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
    pulumi/pulumi-aws-native