interface DeliverToQBusinessActionProperty

Language	Type name
.NET	`Amazon.CDK.AWS.SES.CfnMailManagerRuleSet.DeliverToQBusinessActionProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsses#CfnMailManagerRuleSet_DeliverToQBusinessActionProperty`
Java	`software.amazon.awscdk.services.ses.CfnMailManagerRuleSet.DeliverToQBusinessActionProperty`
Python	`aws_cdk.aws_ses.CfnMailManagerRuleSet.DeliverToQBusinessActionProperty`
TypeScript	`aws-cdk-lib` » `aws_ses` » `CfnMailManagerRuleSet` » `DeliverToQBusinessActionProperty`

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ses as ses } from 'aws-cdk-lib';
const deliverToQBusinessActionProperty: ses.CfnMailManagerRuleSet.DeliverToQBusinessActionProperty = {
  applicationId: 'applicationId',
  indexId: 'indexId',
  roleArn: 'roleArn',

  // the properties below are optional
  actionFailurePolicy: 'actionFailurePolicy',
};

Properties

Name	Type	Description
applicationId	`string`	The unique identifier of the Amazon Q Business application instance where the email content will be delivered.
indexId	`string`	The identifier of the knowledge base index within the Amazon Q Business application where the email content will be stored and indexed.
roleArn	`string`	The Amazon Resource Name (ARN) of the IAM Role to use while delivering to Amazon Q Business.
actionFailurePolicy?	`string`	A policy that states what to do in the case of failure.

applicationId

Type: string

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

indexId

Type: string

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

roleArn

Type: string

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

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

actionFailurePolicy?

Type: string (optional)

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

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.