Class CfnRetriever

Adds a retriever to your Amazon Q Business application.

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnRetriever
Implements
IConstruct
IDependable
Inherited Members
Namespace: Amazon.CDK.AwsQbusiness
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnRetriever : CfnResource, IInspectable, IRetrieverRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2
Syntax (vb)
Public Class CfnRetriever Inherits CfnResource Implements IInspectable, IRetrieverRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-retriever.html

CloudformationResource: AWS::QBusiness::Retriever

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Aws_qbusiness;

             var cfnRetriever = new CfnRetriever(this, "MyCfnRetriever", new CfnRetrieverProps {
                 ApplicationId = "applicationId",
                 Configuration = new RetrieverConfigurationProperty {
                     KendraIndexConfiguration = new KendraIndexConfigurationProperty {
                         IndexId = "indexId"
                     },
                     NativeIndexConfiguration = new NativeIndexConfigurationProperty {
                         IndexId = "indexId"
                     }
                 },
                 DisplayName = "displayName",
                 Type = "type",

                 // the properties below are optional
                 RoleArn = "roleArn",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnRetriever(Construct, string, ICfnRetrieverProps)

Adds a retriever to your Amazon Q Business application.

Properties

ApplicationId

The identifier of the Amazon Q Business application using the retriever.
AttrCreatedAt

The Unix timestamp when the retriever was created.
AttrRetrieverArn

The Amazon Resource Name (ARN) of the IAM role associated with the retriever.
AttrRetrieverId

The identifier of the retriever used by your Amazon Q Business application.
AttrStatus

The status of your retriever.
AttrUpdatedAt

The Unix timestamp when the retriever was last updated.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CdkTagManager

Tag Manager which manages the tags for this resource.
CfnProperties

Adds a retriever to your Amazon Q Business application.
Configuration

Provides information on how the retriever used for your Amazon Q Business application is configured.
DisplayName

The name of your retriever.
RetrieverRef

A reference to a Retriever resource.
RoleArn

The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.
Tags

A list of key-value pairs that identify or categorize the retriever.
Type

The type of your retriever.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<string, object>)

Adds a retriever to your Amazon Q Business application.

Constructors

CfnRetriever(Construct, string, ICfnRetrieverProps)

Adds a retriever to your Amazon Q Business application.

public CfnRetriever(Construct scope, string id, ICfnRetrieverProps props)
Parameters
scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnRetrieverProps

Resource properties.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-retriever.html

CloudformationResource: AWS::QBusiness::Retriever

ExampleMetadata: fixture=_generated

Properties

ApplicationId

The identifier of the Amazon Q Business application using the retriever.

public virtual string ApplicationId { get; set; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-retriever.html

CloudformationResource: AWS::QBusiness::Retriever

ExampleMetadata: fixture=_generated

AttrCreatedAt

The Unix timestamp when the retriever was created.

public virtual string AttrCreatedAt { get; }
Property Value

string

Remarks

CloudformationAttribute: CreatedAt

AttrRetrieverArn

The Amazon Resource Name (ARN) of the IAM role associated with the retriever.

public virtual string AttrRetrieverArn { get; }
Property Value

string

Remarks

CloudformationAttribute: RetrieverArn

AttrRetrieverId

The identifier of the retriever used by your Amazon Q Business application.

public virtual string AttrRetrieverId { get; }
Property Value

string

Remarks

CloudformationAttribute: RetrieverId

AttrStatus

The status of your retriever.

public virtual string AttrStatus { get; }
Property Value

string

Remarks

CloudformationAttribute: Status

AttrUpdatedAt

The Unix timestamp when the retriever was last updated.

public virtual string AttrUpdatedAt { get; }
Property Value

string

Remarks

CloudformationAttribute: UpdatedAt

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-retriever.html

CloudformationResource: AWS::QBusiness::Retriever

ExampleMetadata: fixture=_generated

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }
Property Value

TagManager

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-retriever.html

CloudformationResource: AWS::QBusiness::Retriever

ExampleMetadata: fixture=_generated

CfnProperties

Adds a retriever to your Amazon Q Business application.

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

IDictionary<string, object>

Overrides
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-retriever.html

CloudformationResource: AWS::QBusiness::Retriever

ExampleMetadata: fixture=_generated

Configuration

Provides information on how the retriever used for your Amazon Q Business application is configured.

public virtual object Configuration { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or CfnRetriever.IRetrieverConfigurationProperty

DisplayName

The name of your retriever.

public virtual string DisplayName { get; set; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-retriever.html

CloudformationResource: AWS::QBusiness::Retriever

ExampleMetadata: fixture=_generated

RetrieverRef

A reference to a Retriever resource.

public virtual IRetrieverReference RetrieverRef { get; }
Property Value

IRetrieverReference

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-retriever.html

CloudformationResource: AWS::QBusiness::Retriever

ExampleMetadata: fixture=_generated

RoleArn

The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.

public virtual string? RoleArn { get; set; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-retriever.html

CloudformationResource: AWS::QBusiness::Retriever

ExampleMetadata: fixture=_generated

Tags

A list of key-value pairs that identify or categorize the retriever.

public virtual ICfnTag[]? Tags { get; set; }
Property Value

ICfnTag[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-retriever.html

CloudformationResource: AWS::QBusiness::Retriever

ExampleMetadata: fixture=_generated

Type

The type of your retriever.

public virtual string Type { get; set; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-retriever.html

CloudformationResource: AWS::QBusiness::Retriever

ExampleMetadata: fixture=_generated

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-retriever.html

CloudformationResource: AWS::QBusiness::Retriever

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Adds a retriever to your Amazon Q Business application.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props IDictionary<string, object>
Returns

IDictionary<string, object>

Overrides
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qbusiness-retriever.html

CloudformationResource: AWS::QBusiness::Retriever

ExampleMetadata: fixture=_generated

Implements

Constructs.IConstruct
Constructs.IDependable