Class: AWSCDK::SES::CfnMailManagerRuleSet::DeliverToQBusinessActionProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
ses/cfn_mail_manager_rule_set.rb

Overview

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

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(application_id:, index_id:, role_arn:, action_failure_policy: nil) ⇒ DeliverToQBusinessActionProperty

Returns a new instance of DeliverToQBusinessActionProperty.

Parameters:

  • application_id (String) —

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

  • index_id (String) —

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

  • role_arn (String) —

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

  • action_failure_policy (String, nil) (defaults to: nil) —

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



851
852
853
854
855
856
857
858
859
860
 
# File 'ses/cfn_mail_manager_rule_set.rb', line 851

def initialize(application_id:, index_id:, role_arn:, action_failure_policy: nil)
  @application_id = application_id
  Jsii::Type.check_type(@application_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "applicationId")
  @index_id = index_id
  Jsii::Type.check_type(@index_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "indexId")
  @role_arn = role_arn
  Jsii::Type.check_type(@role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn")
  @action_failure_policy = action_failure_policy
  Jsii::Type.check_type(@action_failure_policy, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "actionFailurePolicy") unless @action_failure_policy.nil?
end

Instance Attribute Details

#action_failure_policy ⇒ String? (readonly)

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.

Returns:

  • (String, nil)

See Also:



885
886
887
 
# File 'ses/cfn_mail_manager_rule_set.rb', line 885

def action_failure_policy
  @action_failure_policy
end

#application_id ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



866
867
868
 
# File 'ses/cfn_mail_manager_rule_set.rb', line 866

def application_id
  @application_id
end

#index_id ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



871
872
873
 
# File 'ses/cfn_mail_manager_rule_set.rb', line 871

def index_id
  @index_id
end

#role_arn ⇒ String (readonly)

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.

Returns:

  • (String)

See Also:



878
879
880
 
# File 'ses/cfn_mail_manager_rule_set.rb', line 878

def role_arn
  @role_arn
end

Class Method Details

.jsii_properties ⇒ Object 



887
888
889
890
891
892
893
894
 
# File 'ses/cfn_mail_manager_rule_set.rb', line 887

def self.jsii_properties
  {
    :application_id => "applicationId",
    :index_id => "indexId",
    :role_arn => "roleArn",
    :action_failure_policy => "actionFailurePolicy",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



896
897
898
899
900
901
902
903
904
905
 
# File 'ses/cfn_mail_manager_rule_set.rb', line 896

def to_jsii
  result = {}
  result.merge!({
    "applicationId" => @application_id,
    "indexId" => @index_id,
    "roleArn" => @role_arn,
    "actionFailurePolicy" => @action_failure_policy,
  })
  result.compact
end