Package software.amazon.awscdk.services.ses

Interface CfnMailManagerRuleSet.RuleActionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnMailManagerRuleSet.RuleActionProperty.Jsii$Proxy

Enclosing class:

CfnMailManagerRuleSet

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

The action for a rule to take. Only one of the contained actions can be set.

This data type is a UNION, so only one of the following members can be specified when used or returned.

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;
 RuleActionProperty ruleActionProperty = RuleActionProperty.builder()
         .addHeader(AddHeaderActionProperty.builder()
                 .headerName("headerName")
                 .headerValue("headerValue")
                 .build())
         .archive(ArchiveActionProperty.builder()
                 .targetArchive("targetArchive")
                 // the properties below are optional
                 .actionFailurePolicy("actionFailurePolicy")
                 .build())
         .bounce(BounceActionProperty.builder()
                 .diagnosticMessage("diagnosticMessage")
                 .roleArn("roleArn")
                 .sender("sender")
                 .smtpReplyCode("smtpReplyCode")
                 .statusCode("statusCode")
                 // the properties below are optional
                 .actionFailurePolicy("actionFailurePolicy")
                 .message("message")
                 .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)
         .invokeLambda(InvokeLambdaActionProperty.builder()
                 .functionArn("functionArn")
                 .invocationType("invocationType")
                 .roleArn("roleArn")
                 // the properties below are optional
                 .actionFailurePolicy("actionFailurePolicy")
                 .retryTimeMinutes(123)
                 .build())
         .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();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnMailManagerRuleSet.RuleActionProperty.Builder	builder()
default Object	getAddHeader()	This action adds a header.
default Object	getArchive()	This action archives the email.
default Object	getBounce()	Returns union: either IResolvable or CfnMailManagerRuleSet.BounceActionProperty
default Object	getDeliverToMailbox()	This action delivers an email to a WorkMail mailbox.
default Object	getDeliverToQBusiness()	This action delivers an email to an Amazon Q Business application for ingestion into its knowledge base.
default Object	getDrop()	This action terminates the evaluation of rules in the rule set.
default Object	getInvokeLambda()	Returns union: either IResolvable or CfnMailManagerRuleSet.InvokeLambdaActionProperty
default Object	getPublishToSns()	This action publishes the email content to an Amazon SNS topic.
default Object	getRelay()	This action relays the email to another SMTP server.
default Object	getReplaceRecipient()	The action replaces certain or all recipients with a different set of recipients.
default Object	getSend()	This action sends the email to the internet.
default Object	getWriteToS3()	This action writes the MIME content of the email to an S3 bucket.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAddHeader

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

This action adds a header.

This can be used to add arbitrary email headers.

Returns union: either IResolvable or CfnMailManagerRuleSet.AddHeaderActionProperty

See Also:

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

getArchive

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

This action archives the email.

This can be used to deliver an email to an archive.

Returns union: either IResolvable or CfnMailManagerRuleSet.ArchiveActionProperty

See Also:

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

getBounce

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

Returns union: either IResolvable or CfnMailManagerRuleSet.BounceActionProperty

See Also:

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

getDeliverToMailbox

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

This action delivers an email to a WorkMail mailbox.

Returns union: either IResolvable or CfnMailManagerRuleSet.DeliverToMailboxActionProperty

See Also:

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

getDeliverToQBusiness

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

This action delivers an email to an Amazon Q Business application for ingestion into its knowledge base.

Returns union: either IResolvable or CfnMailManagerRuleSet.DeliverToQBusinessActionProperty

See Also:

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

getDrop

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

This action terminates the evaluation of rules in the rule set.

See Also:

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

getInvokeLambda

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

Returns union: either IResolvable or CfnMailManagerRuleSet.InvokeLambdaActionProperty

See Also:

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

getPublishToSns

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

This action publishes the email content to an Amazon SNS topic.

Returns union: either IResolvable or CfnMailManagerRuleSet.SnsActionProperty

See Also:

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

getRelay

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

This action relays the email to another SMTP server.

Returns union: either IResolvable or CfnMailManagerRuleSet.RelayActionProperty

See Also:

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

getReplaceRecipient

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

The action replaces certain or all recipients with a different set of recipients.

Returns union: either IResolvable or CfnMailManagerRuleSet.ReplaceRecipientActionProperty

See Also:

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

getSend

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

This action sends the email to the internet.

Returns union: either IResolvable or CfnMailManagerRuleSet.SendActionProperty

See Also:

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

getWriteToS3

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

This action writes the MIME content of the email to an S3 bucket.

Returns union: either IResolvable or CfnMailManagerRuleSet.S3ActionProperty

See Also:

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

builder

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

Returns:

a CfnMailManagerRuleSet.RuleActionProperty.Builder of CfnMailManagerRuleSet.RuleActionProperty