Package software.amazon.awscdk.services.ses

Class CfnMailManagerRuleSet

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.ses.CfnMailManagerRuleSet

All Implemented Interfaces:

IInspectable, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-21T06:34:16.306Z")
@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:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnMailManagerRuleSet.AddHeaderActionProperty	The action to add a header to a message.
static interface	CfnMailManagerRuleSet.AnalysisProperty	The result of an analysis can be used in conditions to trigger actions.
static interface	CfnMailManagerRuleSet.ArchiveActionProperty	The action to archive the email by delivering the email to an Amazon SES archive.
static final class	CfnMailManagerRuleSet.Builder	A fluent builder for CfnMailManagerRuleSet.
static interface	CfnMailManagerRuleSet.DeliverToMailboxActionProperty	This action to delivers an email to a mailbox.
static interface	CfnMailManagerRuleSet.RelayActionProperty	The action relays the email via SMTP to another specific SMTP server.
static interface	CfnMailManagerRuleSet.ReplaceRecipientActionProperty	This action replaces the email envelope recipients with the given list of recipients.
static interface	CfnMailManagerRuleSet.RuleActionProperty	The action for a rule to take.
static interface	CfnMailManagerRuleSet.RuleBooleanExpressionProperty	A boolean expression to be used in a rule condition.
static interface	CfnMailManagerRuleSet.RuleBooleanToEvaluateProperty	The union type representing the allowed types of operands for a boolean condition.
static interface	CfnMailManagerRuleSet.RuleConditionProperty	The conditional expression used to evaluate an email for determining if a rule action should be taken.
static interface	CfnMailManagerRuleSet.RuleDmarcExpressionProperty	A DMARC policy expression.
static interface	CfnMailManagerRuleSet.RuleIpExpressionProperty	An IP address expression matching certain IP addresses within a given range of IP addresses.
static interface	CfnMailManagerRuleSet.RuleIpToEvaluateProperty	The IP address to evaluate for this condition.
static interface	CfnMailManagerRuleSet.RuleNumberExpressionProperty	A number expression to match numeric conditions with integers from the incoming email.
static interface	CfnMailManagerRuleSet.RuleNumberToEvaluateProperty	The number to evaluate in a numeric condition expression.
static interface	CfnMailManagerRuleSet.RuleProperty	A rule contains conditions, "unless conditions" and actions.
static interface	CfnMailManagerRuleSet.RuleStringExpressionProperty	A string expression is evaluated against strings or substrings of the email.
static interface	CfnMailManagerRuleSet.RuleStringToEvaluateProperty	The string to evaluate in a string condition expression.
static interface	CfnMailManagerRuleSet.RuleVerdictExpressionProperty	A verdict expression is evaluated against verdicts of the email.
static interface	CfnMailManagerRuleSet.RuleVerdictToEvaluateProperty	The verdict to evaluate in a verdict condition expression.
static interface	CfnMailManagerRuleSet.S3ActionProperty	Writes the MIME content of the email to an S3 bucket.
static interface	CfnMailManagerRuleSet.SendActionProperty	Sends the email to the internet using the ses:SendRawEmail API.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2

ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnMailManagerRuleSet(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnMailManagerRuleSet(software.amazon.jsii.JsiiObjectRef objRef)
	CfnMailManagerRuleSet(software.constructs.Construct scope, String id, CfnMailManagerRuleSetProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrRuleSetArn()	The Amazon Resource Name (ARN) of the rule set resource.
String	getAttrRuleSetId()	The identifier of the rule set.
TagManager	getCdkTagManager()	Tag Manager which manages the tags for this resource.
protected Map<String,Object>	getCfnProperties()
Object	getRules()	Conditional rules that are evaluated for determining actions on email.
String	getRuleSetName()	A user-friendly name for the rule set.
List<CfnTag>	getTags()	The tags used to organize, track, or control access for the resource.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setRules(List<Object> value)	Conditional rules that are evaluated for determining actions on email.
void	setRules(IResolvable value)	Conditional rules that are evaluated for determining actions on email.
void	setRuleSetName(String value)	A user-friendly name for the rule set.
void	setTags(List<CfnTag> value)	The tags used to organize, track, or control access for the resource.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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.