Package software.amazon.awscdk.cfnpropertymixins.services.ses

Interface CfnMailManagerRuleSetPropsMixin.DeliverToQBusinessActionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnMailManagerRuleSetPropsMixin.DeliverToQBusinessActionProperty.Jsii$Proxy

Enclosing class:

CfnMailManagerRuleSetPropsMixin

@Stability(Stable)
public static interface CfnMailManagerRuleSetPropsMixin.DeliverToQBusinessActionProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.cfnpropertymixins.services.ses.*;
 DeliverToQBusinessActionProperty deliverToQBusinessActionProperty = DeliverToQBusinessActionProperty.builder()
         .actionFailurePolicy("actionFailurePolicy")
         .applicationId("applicationId")
         .indexId("indexId")
         .roleArn("roleArn")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnMailManagerRuleSetPropsMixin.DeliverToQBusinessActionProperty.Builder	A builder for CfnMailManagerRuleSetPropsMixin.DeliverToQBusinessActionProperty
static final class	CfnMailManagerRuleSetPropsMixin.DeliverToQBusinessActionProperty.Jsii$Proxy	An implementation for CfnMailManagerRuleSetPropsMixin.DeliverToQBusinessActionProperty

Method Summary

Modifier and Type	Method	Description
static CfnMailManagerRuleSetPropsMixin.DeliverToQBusinessActionProperty.Builder	builder()
default String	getActionFailurePolicy()	A policy that states what to do in the case of failure.
default String	getApplicationId()	The unique identifier of the Amazon Q Business application instance where the email content will be delivered.
default String	getIndexId()	The identifier of the knowledge base index within the Amazon Q Business application where the email content will be stored and indexed.
default String	getRoleArn()	The Amazon Resource Name (ARN) of the IAM Role to use while delivering to Amazon Q Business.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getActionFailurePolicy

@Stability(Stable)
@Nullable
default String getActionFailurePolicy()

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.

See Also:

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

getApplicationId

@Stability(Stable)
@Nullable
default String getApplicationId()

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

See Also:

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

getIndexId

@Stability(Stable)
@Nullable
default String getIndexId()

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

See Also:

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

getRoleArn

@Stability(Stable)
@Nullable
default String getRoleArn()

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.

See Also:

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

builder

@Stability(Stable)
static CfnMailManagerRuleSetPropsMixin.DeliverToQBusinessActionProperty.Builder builder()

Returns:

a CfnMailManagerRuleSetPropsMixin.DeliverToQBusinessActionProperty.Builder of CfnMailManagerRuleSetPropsMixin.DeliverToQBusinessActionProperty