Package software.amazon.awscdk.services.ses

Interface CfnMailManagerRuleSet.RuleProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnMailManagerRuleSet.RuleProperty.Jsii$Proxy

Enclosing class:

CfnMailManagerRuleSet

@Stability(Stable)
public static interface CfnMailManagerRuleSet.RuleProperty
extends software.amazon.jsii.JsiiSerializable

A rule contains conditions, "unless conditions" and actions.

For each envelope recipient of an email, if all conditions match and none of the "unless conditions" match, then all of the actions are executed sequentially. If no conditions are provided, the rule always applies and the actions are implicitly executed. If only "unless conditions" are provided, the rule applies if the email does not match the evaluation of the "unless conditions".

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ses.*;
 Object drop;
 RuleProperty ruleProperty = RuleProperty.builder()
         .actions(List.of(RuleActionProperty.builder()
                 .addHeader(AddHeaderActionProperty.builder()
                         .headerName("headerName")
                         .headerValue("headerValue")
                         .build())
                 .archive(ArchiveActionProperty.builder()
                         .targetArchive("targetArchive")
                         // the properties below are optional
                         .actionFailurePolicy("actionFailurePolicy")
                         .build())
                 .deliverToMailbox(DeliverToMailboxActionProperty.builder()
                         .mailboxArn("mailboxArn")
                         .roleArn("roleArn")
                         // the properties below are optional
                         .actionFailurePolicy("actionFailurePolicy")
                         .build())
                 .deliverToQBusiness(DeliverToQBusinessActionProperty.builder()
                         .applicationId("applicationId")
                         .indexId("indexId")
                         .roleArn("roleArn")
                         // the properties below are optional
                         .actionFailurePolicy("actionFailurePolicy")
                         .build())
                 .drop(drop)
                 .publishToSns(SnsActionProperty.builder()
                         .roleArn("roleArn")
                         .topicArn("topicArn")
                         // the properties below are optional
                         .actionFailurePolicy("actionFailurePolicy")
                         .encoding("encoding")
                         .payloadType("payloadType")
                         .build())
                 .relay(RelayActionProperty.builder()
                         .relay("relay")
                         // the properties below are optional
                         .actionFailurePolicy("actionFailurePolicy")
                         .mailFrom("mailFrom")
                         .build())
                 .replaceRecipient(ReplaceRecipientActionProperty.builder()
                         .replaceWith(List.of("replaceWith"))
                         .build())
                 .send(SendActionProperty.builder()
                         .roleArn("roleArn")
                         // the properties below are optional
                         .actionFailurePolicy("actionFailurePolicy")
                         .build())
                 .writeToS3(S3ActionProperty.builder()
                         .roleArn("roleArn")
                         .s3Bucket("s3Bucket")
                         // the properties below are optional
                         .actionFailurePolicy("actionFailurePolicy")
                         .s3Prefix("s3Prefix")
                         .s3SseKmsKeyId("s3SseKmsKeyId")
                         .build())
                 .build()))
         // the properties below are optional
         .conditions(List.of(RuleConditionProperty.builder()
                 .booleanExpression(RuleBooleanExpressionProperty.builder()
                         .evaluate(RuleBooleanToEvaluateProperty.builder()
                                 .analysis(AnalysisProperty.builder()
                                         .analyzer("analyzer")
                                         .resultField("resultField")
                                         .build())
                                 .attribute("attribute")
                                 .isInAddressList(RuleIsInAddressListProperty.builder()
                                         .addressLists(List.of("addressLists"))
                                         .attribute("attribute")
                                         .build())
                                 .build())
                         .operator("operator")
                         .build())
                 .dmarcExpression(RuleDmarcExpressionProperty.builder()
                         .operator("operator")
                         .values(List.of("values"))
                         .build())
                 .ipExpression(RuleIpExpressionProperty.builder()
                         .evaluate(RuleIpToEvaluateProperty.builder()
                                 .attribute("attribute")
                                 .build())
                         .operator("operator")
                         .values(List.of("values"))
                         .build())
                 .numberExpression(RuleNumberExpressionProperty.builder()
                         .evaluate(RuleNumberToEvaluateProperty.builder()
                                 .attribute("attribute")
                                 .build())
                         .operator("operator")
                         .value(123)
                         .build())
                 .stringExpression(RuleStringExpressionProperty.builder()
                         .evaluate(RuleStringToEvaluateProperty.builder()
                                 .analysis(AnalysisProperty.builder()
                                         .analyzer("analyzer")
                                         .resultField("resultField")
                                         .build())
                                 .attribute("attribute")
                                 .mimeHeaderAttribute("mimeHeaderAttribute")
                                 .build())
                         .operator("operator")
                         .values(List.of("values"))
                         .build())
                 .verdictExpression(RuleVerdictExpressionProperty.builder()
                         .evaluate(RuleVerdictToEvaluateProperty.builder()
                                 .analysis(AnalysisProperty.builder()
                                         .analyzer("analyzer")
                                         .resultField("resultField")
                                         .build())
                                 .attribute("attribute")
                                 .build())
                         .operator("operator")
                         .values(List.of("values"))
                         .build())
                 .build()))
         .name("name")
         .unless(List.of(RuleConditionProperty.builder()
                 .booleanExpression(RuleBooleanExpressionProperty.builder()
                         .evaluate(RuleBooleanToEvaluateProperty.builder()
                                 .analysis(AnalysisProperty.builder()
                                         .analyzer("analyzer")
                                         .resultField("resultField")
                                         .build())
                                 .attribute("attribute")
                                 .isInAddressList(RuleIsInAddressListProperty.builder()
                                         .addressLists(List.of("addressLists"))
                                         .attribute("attribute")
                                         .build())
                                 .build())
                         .operator("operator")
                         .build())
                 .dmarcExpression(RuleDmarcExpressionProperty.builder()
                         .operator("operator")
                         .values(List.of("values"))
                         .build())
                 .ipExpression(RuleIpExpressionProperty.builder()
                         .evaluate(RuleIpToEvaluateProperty.builder()
                                 .attribute("attribute")
                                 .build())
                         .operator("operator")
                         .values(List.of("values"))
                         .build())
                 .numberExpression(RuleNumberExpressionProperty.builder()
                         .evaluate(RuleNumberToEvaluateProperty.builder()
                                 .attribute("attribute")
                                 .build())
                         .operator("operator")
                         .value(123)
                         .build())
                 .stringExpression(RuleStringExpressionProperty.builder()
                         .evaluate(RuleStringToEvaluateProperty.builder()
                                 .analysis(AnalysisProperty.builder()
                                         .analyzer("analyzer")
                                         .resultField("resultField")
                                         .build())
                                 .attribute("attribute")
                                 .mimeHeaderAttribute("mimeHeaderAttribute")
                                 .build())
                         .operator("operator")
                         .values(List.of("values"))
                         .build())
                 .verdictExpression(RuleVerdictExpressionProperty.builder()
                         .evaluate(RuleVerdictToEvaluateProperty.builder()
                                 .analysis(AnalysisProperty.builder()
                                         .analyzer("analyzer")
                                         .resultField("resultField")
                                         .build())
                                 .attribute("attribute")
                                 .build())
                         .operator("operator")
                         .values(List.of("values"))
                         .build())
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnMailManagerRuleSet.RuleProperty.Builder	builder()
Object	getActions()	The list of actions to execute when the conditions match the incoming email, and none of the "unless conditions" match.
default Object	getConditions()	The conditions of this rule.
default String	getName()	The user-friendly name of the rule.
default Object	getUnless()	The "unless conditions" of this rule.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getActions

@Stability(Stable)
@NotNull
Object getActions()

The list of actions to execute when the conditions match the incoming email, and none of the "unless conditions" match.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnMailManagerRuleSet.RuleActionProperty>

See Also:

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

getConditions

@Stability(Stable)
@Nullable
default Object getConditions()

The conditions of this rule.

All conditions must match the email for the actions to be executed. An empty list of conditions means that all emails match, but are still subject to any "unless conditions"

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnMailManagerRuleSet.RuleConditionProperty>

See Also:

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

getName

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

The user-friendly name of the rule.

See Also:

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

getUnless

@Stability(Stable)
@Nullable
default Object getUnless()

The "unless conditions" of this rule.

None of the conditions can match the email for the actions to be executed. If any of these conditions do match the email, then the actions are not executed.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnMailManagerRuleSet.RuleConditionProperty>

See Also:

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

builder

@Stability(Stable)
static CfnMailManagerRuleSet.RuleProperty.Builder builder()

Returns:

a CfnMailManagerRuleSet.RuleProperty.Builder of CfnMailManagerRuleSet.RuleProperty