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.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:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
The action to add a header to a message.static interface
The result of an analysis can be used in conditions to trigger actions.static interface
The action to archive the email by delivering the email to an Amazon SES archive.static final class
A fluent builder forCfnMailManagerRuleSet
.static interface
This action to delivers an email to a mailbox.static interface
The action relays the email via SMTP to another specific SMTP server.static interface
This action replaces the email envelope recipients with the given list of recipients.static interface
The action for a rule to take.static interface
A boolean expression to be used in a rule condition.static interface
The union type representing the allowed types of operands for a boolean condition.static interface
The conditional expression used to evaluate an email for determining if a rule action should be taken.static interface
A DMARC policy expression.static interface
An IP address expression matching certain IP addresses within a given range of IP addresses.static interface
The IP address to evaluate for this condition.static interface
A number expression to match numeric conditions with integers from the incoming email.static interface
The number to evaluate in a numeric condition expression.static interface
A rule contains conditions, "unless conditions" and actions.static interface
A string expression is evaluated against strings or substrings of the email.static interface
The string to evaluate in a string condition expression.static interface
A verdict expression is evaluated against verdicts of the email.static interface
The verdict to evaluate in a verdict condition expression.static interface
Writes the MIME content of the email to an S3 bucket.static interface
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
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
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 TypeMethodDescriptionThe Amazon Resource Name (ARN) of the rule set resource.The identifier of the rule set.Tag Manager which manages the tags for this resource.getRules()
Conditional rules that are evaluated for determining actions on email.A user-friendly name for the rule set.getTags()
The tags used to organize, track, or control access for the resource.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
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
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
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
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- 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 classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrRuleSetArn
The Amazon Resource Name (ARN) of the rule set resource. -
getAttrRuleSetId
The identifier of the rule set. -
getCdkTagManager
Tag Manager which manages the tags for this resource.- Specified by:
getCdkTagManager
in interfaceITaggableV2
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getRules
Conditional rules that are evaluated for determining actions on email. -
setRules
Conditional rules that are evaluated for determining actions on email. -
setRules
Conditional rules that are evaluated for determining actions on email. -
getRuleSetName
A user-friendly name for the rule set. -
setRuleSetName
A user-friendly name for the rule set. -
getTags
The tags used to organize, track, or control access for the resource. -
setTags
The tags used to organize, track, or control access for the resource.
-