Interface CfnMailManagerRuleSet.IDeliverToQBusinessActionProperty

The action to deliver incoming emails to an Amazon Q Business application for indexing.

Namespace: Amazon.CDK.AWS.SES

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface CfnMailManagerRuleSet.IDeliverToQBusinessActionProperty

Syntax (vb)

Public Interface CfnMailManagerRuleSet.IDeliverToQBusinessActionProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-delivertoqbusinessaction.html

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.SES;

             var deliverToQBusinessActionProperty = new DeliverToQBusinessActionProperty {
                 ApplicationId = "applicationId",
                 IndexId = "indexId",
                 RoleArn = "roleArn",

                 // the properties below are optional
                 ActionFailurePolicy = "actionFailurePolicy"
             };

Synopsis

Properties

ActionFailurePolicy	A policy that states what to do in the case of failure.
ApplicationId	The unique identifier of the Amazon Q Business application instance where the email content will be delivered.
IndexId	The identifier of the knowledge base index within the Amazon Q Business application where the email content will be stored and indexed.
RoleArn	The Amazon Resource Name (ARN) of the IAM Role to use while delivering to Amazon Q Business.

Properties

ActionFailurePolicy

A policy that states what to do in the case of failure.

string? ActionFailurePolicy { get; }

Property Value

string

Remarks

The action will fail if there are configuration errors. For example, the specified application has been deleted or the role lacks necessary permissions to call the qbusiness:BatchPutDocument API.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-delivertoqbusinessaction.html#cfn-ses-mailmanagerruleset-delivertoqbusinessaction-actionfailurepolicy

ApplicationId

The unique identifier of the Amazon Q Business application instance where the email content will be delivered.

string ApplicationId { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-delivertoqbusinessaction.html#cfn-ses-mailmanagerruleset-delivertoqbusinessaction-applicationid

IndexId

The identifier of the knowledge base index within the Amazon Q Business application where the email content will be stored and indexed.

string IndexId { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-delivertoqbusinessaction.html#cfn-ses-mailmanagerruleset-delivertoqbusinessaction-indexid

RoleArn

The Amazon Resource Name (ARN) of the IAM Role to use while delivering to Amazon Q Business.

string RoleArn { get; }

Property Value

string

Remarks

This role must have access to the qbusiness:BatchPutDocument API for the given application and index.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-mailmanagerruleset-delivertoqbusinessaction.html#cfn-ses-mailmanagerruleset-delivertoqbusinessaction-rolearn