RuleActionProperty Struct
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
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ses as ses } from 'aws-cdk-lib';
declare const drop: any;
const ruleActionProperty: ses.CfnMailManagerRuleSet.RuleActionProperty = {
addHeader: {
headerName: 'headerName',
headerValue: 'headerValue',
},
archive: {
targetArchive: 'targetArchive',
// the properties below are optional
actionFailurePolicy: 'actionFailurePolicy',
},
bounce: {
diagnosticMessage: 'diagnosticMessage',
roleArn: 'roleArn',
sender: 'sender',
smtpReplyCode: 'smtpReplyCode',
statusCode: 'statusCode',
// the properties below are optional
actionFailurePolicy: 'actionFailurePolicy',
message: 'message',
},
deliverToMailbox: {
mailboxArn: 'mailboxArn',
roleArn: 'roleArn',
// the properties below are optional
actionFailurePolicy: 'actionFailurePolicy',
},
deliverToQBusiness: {
applicationId: 'applicationId',
indexId: 'indexId',
roleArn: 'roleArn',
// the properties below are optional
actionFailurePolicy: 'actionFailurePolicy',
},
drop: drop,
invokeLambda: {
functionArn: 'functionArn',
invocationType: 'invocationType',
roleArn: 'roleArn',
// the properties below are optional
actionFailurePolicy: 'actionFailurePolicy',
retryTimeMinutes: 123,
},
publishToSns: {
roleArn: 'roleArn',
topicArn: 'topicArn',
// the properties below are optional
actionFailurePolicy: 'actionFailurePolicy',
encoding: 'encoding',
payloadType: 'payloadType',
},
relay: {
relay: 'relay',
// the properties below are optional
actionFailurePolicy: 'actionFailurePolicy',
mailFrom: 'mailFrom',
},
replaceRecipient: {
replaceWith: ['replaceWith'],
},
send: {
roleArn: 'roleArn',
// the properties below are optional
actionFailurePolicy: 'actionFailurePolicy',
},
writeToS3: {
roleArn: 'roleArn',
s3Bucket: 's3Bucket',
// the properties below are optional
actionFailurePolicy: 'actionFailurePolicy',
s3Prefix: 's3Prefix',
s3SseKmsKeyId: 's3SseKmsKeyId',
},
};
Properties
addHeaderoptionalIResolvable | CfnMailManagerRuleSet.AddHeaderActionPropertyadd_headeroptionaltyping.Union[IResolvable, AddHeaderActionProperty]addHeaderoptionalIResolvableAddHeaderoptionalIResolvableAddHeaderoptionalinterface{}#This action adds a header.
This can be used to add arbitrary email headers.
archiveoptionalIResolvable | CfnMailManagerRuleSet.ArchiveActionPropertyarchiveoptionaltyping.Union[IResolvable, ArchiveActionProperty]archiveoptionalIResolvableArchiveoptionalIResolvableArchiveoptionalinterface{}#This action archives the email.
This can be used to deliver an email to an archive.
bounceoptionalIResolvable | CfnMailManagerRuleSet.BounceActionPropertybounceoptionaltyping.Union[IResolvable, BounceActionProperty]bounceoptionalIResolvableBounceoptionalIResolvableBounceoptionalinterface{}#deliverToMailboxoptionalIResolvable | CfnMailManagerRuleSet.DeliverToMailboxActionPropertydeliver_to_mailboxoptionaltyping.Union[IResolvable, DeliverToMailboxActionProperty]deliverToMailboxoptionalIResolvableDeliverToMailboxoptionalIResolvableDeliverToMailboxoptionalinterface{}#This action delivers an email to a WorkMail mailbox.
deliverToQBusinessoptionalIResolvable | CfnMailManagerRuleSet.DeliverToQBusinessActionPropertydeliver_to_q_businessoptionaltyping.Union[IResolvable, DeliverToQBusinessActionProperty]deliverToQBusinessoptionalIResolvableDeliverToQBusinessoptionalIResolvableDeliverToQBusinessoptionalinterface{}#This action delivers an email to an Amazon Q Business application for ingestion into its knowledge base.
This action terminates the evaluation of rules in the rule set.
invokeLambdaoptionalIResolvable | CfnMailManagerRuleSet.InvokeLambdaActionPropertyinvoke_lambdaoptionaltyping.Union[IResolvable, InvokeLambdaActionProperty]invokeLambdaoptionalIResolvableInvokeLambdaoptionalIResolvableInvokeLambdaoptionalinterface{}#publishToSnsoptionalIResolvable | CfnMailManagerRuleSet.SnsActionPropertypublish_to_snsoptionaltyping.Union[IResolvable, SnsActionProperty]publishToSnsoptionalIResolvablePublishToSnsoptionalIResolvablePublishToSnsoptionalinterface{}#This action publishes the email content to an Amazon SNS topic.
relayoptionalIResolvable | CfnMailManagerRuleSet.RelayActionPropertyrelayoptionaltyping.Union[IResolvable, RelayActionProperty]relayoptionalIResolvableRelayoptionalIResolvableRelayoptionalinterface{}#This action relays the email to another SMTP server.
replaceRecipientoptionalIResolvable | CfnMailManagerRuleSet.ReplaceRecipientActionPropertyreplace_recipientoptionaltyping.Union[IResolvable, ReplaceRecipientActionProperty]replaceRecipientoptionalIResolvableReplaceRecipientoptionalIResolvableReplaceRecipientoptionalinterface{}#The action replaces certain or all recipients with a different set of recipients.
sendoptionalIResolvable | CfnMailManagerRuleSet.SendActionPropertysendoptionaltyping.Union[IResolvable, SendActionProperty]sendoptionalIResolvableSendoptionalIResolvableSendoptionalinterface{}#This action sends the email to the internet.
writeToS3optionalIResolvable | CfnMailManagerRuleSet.S3ActionPropertywrite_to_s3optionaltyping.Union[IResolvable, S3ActionProperty]writeToS3optionalIResolvableWriteToS3optionalIResolvableWriteToS3optionalinterface{}#This action writes the MIME content of the email to an S3 bucket.