Package software.amazon.awscdk.services.ses

Class CfnReceiptFilter

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.CfnReceiptFilter
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IReceiptFilterRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.126.0 (build 206d44b)", date="2026-02-09T14:39:19.493Z") @Stability(Stable) public class CfnReceiptFilter extends CfnResource implements IInspectable, IReceiptFilterRef
Specify a new IP address filter.

You use IP address filters when you receive email with Amazon SES.

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.*;
 CfnReceiptFilter cfnReceiptFilter = CfnReceiptFilter.Builder.create(this, "MyCfnReceiptFilter")
         .filter(FilterProperty.builder()
                 .ipFilter(IpFilterProperty.builder()
                         .cidr("cidr")
                         .policy("policy")
                         .build())
                 // the properties below are optional
                 .name("name")
                 .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

    • CfnReceiptFilter

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

    • CfnReceiptFilter

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

    • CfnReceiptFilter

      @Stability(Stable) public CfnReceiptFilter(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnReceiptFilterProps props)
      Create a new AWS::SES::ReceiptFilter.

      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

    • isCfnReceiptFilter

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

      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.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getReceiptFilterRef

      @Stability(Stable) @NotNull public ReceiptFilterReference getReceiptFilterRef()
      A reference to a ReceiptFilter resource.
      Specified by:
      getReceiptFilterRef in interface IReceiptFilterRef

    • getFilter

      @Stability(Stable) @NotNull public Object getFilter()
      A data structure that describes the IP address filter to create, which consists of a name, an IP address range, and whether to allow or block mail from it.

      Returns union: either IResolvable or CfnReceiptFilter.FilterProperty

    • setFilter

      @Stability(Stable) public void setFilter(@NotNull IResolvable value)
      A data structure that describes the IP address filter to create, which consists of a name, an IP address range, and whether to allow or block mail from it.

    • setFilter

      @Stability(Stable) public void setFilter(@NotNull CfnReceiptFilter.FilterProperty value)
      A data structure that describes the IP address filter to create, which consists of a name, an IP address range, and whether to allow or block mail from it.