Class CfnMailManagerRuleSet

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
All Implemented Interfaces:
IInspectable, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)", date="2024-10-05T03:43:51.535Z") @Stability(Stable) public class CfnMailManagerRuleSet extends CfnResource implements IInspectable, ITaggableV2
Resource to create a rule set for a Mail Manager ingress endpoint which contains a list of rules that are evaluated sequentially for each email.

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;
 CfnMailManagerRuleSet cfnMailManagerRuleSet = CfnMailManagerRuleSet.Builder.create(this, "MyCfnMailManagerRuleSet")
         .rules(List.of(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())
                         .drop(drop)
                         .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()
                                         .attribute("attribute")
                                         .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()
                                         .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()
                                         .attribute("attribute")
                                         .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()
                                         .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()))
         // the properties below are optional
         .ruleSetName("ruleSetName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:
  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.
  • Constructor Details

    • CfnMailManagerRuleSet

      protected CfnMailManagerRuleSet(software.amazon.jsii.JsiiObjectRef objRef)
    • CfnMailManagerRuleSet

      protected CfnMailManagerRuleSet(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
    • CfnMailManagerRuleSet

      @Stability(Stable) public CfnMailManagerRuleSet(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnMailManagerRuleSetProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.
  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.
    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.
    • getAttrRuleSetArn

      @Stability(Stable) @NotNull public String getAttrRuleSetArn()
      The Amazon Resource Name (ARN) of the rule set resource.
    • getAttrRuleSetId

      @Stability(Stable) @NotNull public String getAttrRuleSetId()
      The identifier of the rule set.
    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2
    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource
    • getRules

      @Stability(Stable) @NotNull public Object getRules()
      Conditional rules that are evaluated for determining actions on email.
    • setRules

      @Stability(Stable) public void setRules(@NotNull IResolvable value)
      Conditional rules that are evaluated for determining actions on email.
    • setRules

      @Stability(Stable) public void setRules(@NotNull List<Object> value)
      Conditional rules that are evaluated for determining actions on email.
    • getRuleSetName

      @Stability(Stable) @Nullable public String getRuleSetName()
      A user-friendly name for the rule set.
    • setRuleSetName

      @Stability(Stable) public void setRuleSetName(@Nullable String value)
      A user-friendly name for the rule set.
    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      The tags used to organize, track, or control access for the resource.
    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      The tags used to organize, track, or control access for the resource.