Skip to content
v2.275.0

RelayActionProperty Struct ​

The action relays the email via SMTP to another specific SMTP server.

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';
const relayActionProperty: ses.CfnMailManagerRuleSet.RelayActionProperty = {
  relay: 'relay',

  // the properties below are optional
  actionFailurePolicy: 'actionFailurePolicy',
  mailFrom: 'mailFrom',
};

Properties ​

actionFailurePolicyoptionalstringaction_failure_policyoptionalstractionFailurePolicyoptionalStringActionFailurePolicyoptionalstringActionFailurePolicyoptional*string#
A policy that states what to do in the case of failure.

The action will fail if there are configuration errors. For example, the specified relay has been deleted.

mailFromoptionalstringmail_fromoptionalstrmailFromoptionalStringMailFromoptionalstringMailFromoptional*string#
This action specifies whether to preserve or replace original mail from address while relaying received emails to a destination server.
relaystringrelaystrrelayStringRelaystringRelay*stringrequired#
The identifier of the relay resource to be used when relaying an email.