You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::SES::Types::ReceiptFilter

Inherits:

Struct

Object
Struct
Aws::SES::Types::ReceiptFilter

show all

Defined in:: gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb

Overview

Note:

When making an API call, you may pass ReceiptFilter data as a hash:

{
  name: "ReceiptFilterName", # required
  ip_filter: { # required
    policy: "Block", # required, accepts Block, Allow
    cidr: "Cidr", # required
  },
}

A receipt IP address filter enables you to specify whether to accept or reject mail originating from an IP address or range of IP addresses.

For information about setting up IP address filters, see the Amazon SES Developer Guide.

Instance Attribute Summary collapse

#ip_filter ⇒ Types::ReceiptIpFilter
A structure that provides the IP addresses to block or allow, and whether to block or allow incoming mail from them.
#name ⇒ String
The name of the IP address filter.

Instance Attribute Details

#ip_filter ⇒ `Types::ReceiptIpFilter`

A structure that provides the IP addresses to block or allow, and whether to block or allow incoming mail from them.

Returns:

(Types::ReceiptIpFilter)

# File 'gems/aws-sdk-ses/lib/aws-sdk-ses/types.rb', line 3148

class ReceiptFilter < Struct.new(
  :name,
  :ip_filter)
  include Aws::Structure
end

#name ⇒ `String`

The name of the IP address filter. The name must:

This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).
Start and end with a letter or number.
Contain less than 64 characters.