Package software.amazon.awscdk.services.ses

Class CfnMailManagerRelay

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.CfnMailManagerRelay
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IMailManagerRelayRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-12-01T16:02:29.963Z") @Stability(Stable) public class CfnMailManagerRelay extends CfnResource implements IInspectable, IMailManagerRelayRef, ITaggableV2
Resource to create an SMTP relay, which can be used within a Mail Manager rule set to forward incoming emails to defined relay destinations.

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 noAuthentication;
 CfnMailManagerRelay cfnMailManagerRelay = CfnMailManagerRelay.Builder.create(this, "MyCfnMailManagerRelay")
         .authentication(RelayAuthenticationProperty.builder()
                 .noAuthentication(noAuthentication)
                 .secretArn("secretArn")
                 .build())
         .serverName("serverName")
         .serverPort(123)
         // the properties below are optional
         .relayName("relayName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • 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

    • CfnMailManagerRelay

      protected CfnMailManagerRelay(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnMailManagerRelay

      protected CfnMailManagerRelay(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnMailManagerRelay

      @Stability(Stable) public CfnMailManagerRelay(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnMailManagerRelayProps props)
      Create a new AWS::SES::MailManagerRelay.

      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

    • arnForMailManagerRelay

      @Stability(Stable) @NotNull public static String arnForMailManagerRelay(@NotNull IMailManagerRelayRef resource)
      Parameters:
      resource - This parameter is required.

    • fromMailManagerRelayArn

      @Stability(Stable) @NotNull public static IMailManagerRelayRef fromMailManagerRelayArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new IMailManagerRelayRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromRelayId

      @Stability(Stable) @NotNull public static IMailManagerRelayRef fromRelayId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String relayId)
      Creates a new IMailManagerRelayRef from a relayId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      relayId - This parameter is required.

    • isCfnMailManagerRelay

      @Stability(Stable) @NotNull public static Boolean isCfnMailManagerRelay(@NotNull Object x)
      Checks whether the given object is a CfnMailManagerRelay.

      Parameters:
      x - This parameter is required.

    • 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.

    • getAttrRelayArn

      @Stability(Stable) @NotNull public String getAttrRelayArn()
      The Amazon Resource Name (ARN) of the relay.

    • getAttrRelayId

      @Stability(Stable) @NotNull public String getAttrRelayId()
      The unique relay identifier.

    • 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

    • getMailManagerRelayRef

      @Stability(Stable) @NotNull public MailManagerRelayReference getMailManagerRelayRef()
      A reference to a MailManagerRelay resource.
      Specified by:
      getMailManagerRelayRef in interface IMailManagerRelayRef

    • getAuthentication

      @Stability(Stable) @NotNull public Object getAuthentication()
      Authentication for the relay destination server—specify the secretARN where the SMTP credentials are stored.

      Returns union: either IResolvable or CfnMailManagerRelay.RelayAuthenticationProperty

    • setAuthentication

      @Stability(Stable) public void setAuthentication(@NotNull IResolvable value)
      Authentication for the relay destination server—specify the secretARN where the SMTP credentials are stored.

    • setAuthentication

      @Stability(Stable) public void setAuthentication(@NotNull CfnMailManagerRelay.RelayAuthenticationProperty value)
      Authentication for the relay destination server—specify the secretARN where the SMTP credentials are stored.

    • getServerName

      @Stability(Stable) @NotNull public String getServerName()
      The destination relay server address.

    • setServerName

      @Stability(Stable) public void setServerName(@NotNull String value)
      The destination relay server address.

    • getServerPort

      @Stability(Stable) @NotNull public Number getServerPort()
      The destination relay server port.

    • setServerPort

      @Stability(Stable) public void setServerPort(@NotNull Number value)
      The destination relay server port.

    • getRelayName

      @Stability(Stable) @Nullable public String getRelayName()
      The unique relay name.

    • setRelayName

      @Stability(Stable) public void setRelayName(@Nullable String value)
      The unique relay name.

    • 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.