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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-09-11T18:01:23.870Z")
@Stability(Stable)
public class CfnReceiptFilter
extends CfnResource
implements IInspectable

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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-receiptfilter.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnReceiptFilter.Builder	A fluent builder for CfnReceiptFilter.
static interface	CfnReceiptFilter.FilterProperty	Specifies an IP address filter.
static interface	CfnReceiptFilter.IpFilterProperty	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.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnReceiptFilter(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnReceiptFilter(software.amazon.jsii.JsiiObjectRef objRef)
	CfnReceiptFilter(software.constructs.Construct scope, String id, CfnReceiptFilterProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrId()
protected Map<String,Object>	getCfnProperties()
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.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setFilter(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.
void	setFilter(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.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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)

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

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

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.

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.