Package software.amazon.awscdk.services.ses

Class CfnMailManagerIngressPoint

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.CfnMailManagerIngressPoint
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IMailManagerIngressPointRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-12T17:54:22.893Z") @Stability(Stable) public class CfnMailManagerIngressPoint extends CfnResource implements IInspectable, IMailManagerIngressPointRef, ITaggableV2
Resource to provision an ingress endpoint for receiving email.

An ingress endpoint serves as the entry point for incoming emails, allowing you to define how emails are received and processed within your AWS environment.

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.*;
 CfnMailManagerIngressPoint cfnMailManagerIngressPoint = CfnMailManagerIngressPoint.Builder.create(this, "MyCfnMailManagerIngressPoint")
         .ruleSetId("ruleSetId")
         .trafficPolicyId("trafficPolicyId")
         .type("type")
         // the properties below are optional
         .ingressPointConfiguration(IngressPointConfigurationProperty.builder()
                 .secretArn("secretArn")
                 .smtpPassword("smtpPassword")
                 .build())
         .ingressPointName("ingressPointName")
         .networkConfiguration(NetworkConfigurationProperty.builder()
                 .privateNetworkConfiguration(PrivateNetworkConfigurationProperty.builder()
                         .vpcEndpointId("vpcEndpointId")
                         .build())
                 .publicNetworkConfiguration(PublicNetworkConfigurationProperty.builder()
                         .ipType("ipType")
                         .build())
                 .build())
         .statusToUpdate("statusToUpdate")
         .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

    • CfnMailManagerIngressPoint

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

    • CfnMailManagerIngressPoint

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

    • CfnMailManagerIngressPoint

      @Stability(Stable) public CfnMailManagerIngressPoint(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnMailManagerIngressPointProps props)
      Create a new AWS::SES::MailManagerIngressPoint.

      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

    • arnForMailManagerIngressPoint

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

    • fromIngressPointId

      @Stability(Stable) @NotNull public static IMailManagerIngressPointRef fromIngressPointId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String ingressPointId)
      Creates a new IMailManagerIngressPointRef from a ingressPointId.

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

    • fromMailManagerIngressPointArn

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

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

    • isCfnMailManagerIngressPoint

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

      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.

    • getAttrARecord

      @Stability(Stable) @NotNull public String getAttrARecord()
      The DNS A Record that identifies your ingress endpoint.

      Configure your DNS Mail Exchange (MX) record with this value to route emails to Mail Manager.

    • getAttrIngressPointArn

      @Stability(Stable) @NotNull public String getAttrIngressPointArn()
      The Amazon Resource Name (ARN) of the ingress endpoint resource.

    • getAttrIngressPointId

      @Stability(Stable) @NotNull public String getAttrIngressPointId()
      The identifier of the ingress endpoint resource.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The status of the ingress endpoint resource.

    • 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

    • getMailManagerIngressPointRef

      @Stability(Stable) @NotNull public MailManagerIngressPointReference getMailManagerIngressPointRef()
      A reference to a MailManagerIngressPoint resource.
      Specified by:
      getMailManagerIngressPointRef in interface IMailManagerIngressPointRef

    • getRuleSetId

      @Stability(Stable) @NotNull public String getRuleSetId()
      The identifier of an existing rule set that you attach to an ingress endpoint resource.

    • setRuleSetId

      @Stability(Stable) public void setRuleSetId(@NotNull String value)
      The identifier of an existing rule set that you attach to an ingress endpoint resource.

    • getTrafficPolicyId

      @Stability(Stable) @NotNull public String getTrafficPolicyId()
      The identifier of an existing traffic policy that you attach to an ingress endpoint resource.

    • setTrafficPolicyId

      @Stability(Stable) public void setTrafficPolicyId(@NotNull String value)
      The identifier of an existing traffic policy that you attach to an ingress endpoint resource.

    • getType

      @Stability(Stable) @NotNull public String getType()
      The type of the ingress endpoint to create.

    • setType

      @Stability(Stable) public void setType(@NotNull String value)
      The type of the ingress endpoint to create.

    • getIngressPointConfiguration

      @Stability(Stable) @Nullable public Object getIngressPointConfiguration()
      The configuration of the ingress endpoint resource.

      Returns union: either IResolvable or CfnMailManagerIngressPoint.IngressPointConfigurationProperty

    • setIngressPointConfiguration

      @Stability(Stable) public void setIngressPointConfiguration(@Nullable IResolvable value)
      The configuration of the ingress endpoint resource.

    • setIngressPointConfiguration

      @Stability(Stable) public void setIngressPointConfiguration(@Nullable CfnMailManagerIngressPoint.IngressPointConfigurationProperty value)
      The configuration of the ingress endpoint resource.

    • getIngressPointName

      @Stability(Stable) @Nullable public String getIngressPointName()
      A user friendly name for an ingress endpoint resource.

    • setIngressPointName

      @Stability(Stable) public void setIngressPointName(@Nullable String value)
      A user friendly name for an ingress endpoint resource.

    • getNetworkConfiguration

      @Stability(Stable) @Nullable public Object getNetworkConfiguration()
      The network type (IPv4-only, Dual-Stack, PrivateLink) of the ingress endpoint resource.

      Returns union: either IResolvable or CfnMailManagerIngressPoint.NetworkConfigurationProperty

    • setNetworkConfiguration

      @Stability(Stable) public void setNetworkConfiguration(@Nullable IResolvable value)
      The network type (IPv4-only, Dual-Stack, PrivateLink) of the ingress endpoint resource.

    • setNetworkConfiguration

      @Stability(Stable) public void setNetworkConfiguration(@Nullable CfnMailManagerIngressPoint.NetworkConfigurationProperty value)
      The network type (IPv4-only, Dual-Stack, PrivateLink) of the ingress endpoint resource.

    • getStatusToUpdate

      @Stability(Stable) @Nullable public String getStatusToUpdate()
      The update status of an ingress endpoint.

    • setStatusToUpdate

      @Stability(Stable) public void setStatusToUpdate(@Nullable String value)
      The update status of an ingress endpoint.

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