@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)", date="2023-01-31T18:36:55.074Z") public class CfnReceiptRule extends CfnResource implements IInspectable
Specifies a receipt rule.
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.*; CfnReceiptRule cfnReceiptRule = CfnReceiptRule.Builder.create(this, "MyCfnReceiptRule") .rule(RuleProperty.builder() .actions(List.of(ActionProperty.builder() .addHeaderAction(AddHeaderActionProperty.builder() .headerName("headerName") .headerValue("headerValue") .build()) .bounceAction(BounceActionProperty.builder() .message("message") .sender("sender") .smtpReplyCode("smtpReplyCode") // the properties below are optional .statusCode("statusCode") .topicArn("topicArn") .build()) .lambdaAction(LambdaActionProperty.builder() .functionArn("functionArn") // the properties below are optional .invocationType("invocationType") .topicArn("topicArn") .build()) .s3Action(S3ActionProperty.builder() .bucketName("bucketName") // the properties below are optional .kmsKeyArn("kmsKeyArn") .objectKeyPrefix("objectKeyPrefix") .topicArn("topicArn") .build()) .snsAction(SNSActionProperty.builder() .encoding("encoding") .topicArn("topicArn") .build()) .stopAction(StopActionProperty.builder() .scope("scope") // the properties below are optional .topicArn("topicArn") .build()) .workmailAction(WorkmailActionProperty.builder() .organizationArn("organizationArn") // the properties below are optional .topicArn("topicArn") .build()) .build())) .enabled(false) .name("name") .recipients(List.of("recipients")) .scanEnabled(false) .tlsPolicy("tlsPolicy") .build()) .ruleSetName("ruleSetName") // the properties below are optional .after("after") .build();
Modifier and Type | Class and Description |
---|---|
static interface |
CfnReceiptRule.ActionProperty
An action that Amazon SES can take when it receives an email on behalf of one or more email addresses or domains that you own.
|
static interface |
CfnReceiptRule.AddHeaderActionProperty
When included in a receipt rule, this action adds a header to the received email.
|
static interface |
CfnReceiptRule.BounceActionProperty
When included in a receipt rule, this action rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
|
static class |
CfnReceiptRule.Builder
A fluent builder for
CfnReceiptRule . |
static interface |
CfnReceiptRule.LambdaActionProperty
When included in a receipt rule, this action calls an AWS Lambda function and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
|
static interface |
CfnReceiptRule.RuleProperty
Receipt rules enable you to specify which actions Amazon SES should take when it receives mail on behalf of one or more email addresses or domains that you own.
|
static interface |
CfnReceiptRule.S3ActionProperty
When included in a receipt rule, this action saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
|
static interface |
CfnReceiptRule.SNSActionProperty
When included in a receipt rule, this action publishes a notification to Amazon Simple Notification Service (Amazon SNS).
|
static interface |
CfnReceiptRule.StopActionProperty
When included in a receipt rule, this action terminates the evaluation of the receipt rule set and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
|
static interface |
CfnReceiptRule.WorkmailActionProperty
When included in a receipt rule, this action calls Amazon WorkMail and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnReceiptRule(Construct scope,
java.lang.String id,
CfnReceiptRuleProps props)
Create a new `AWS::SES::ReceiptRule`.
|
protected |
CfnReceiptRule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnReceiptRule(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAfter()
The name of an existing rule after which the new rule is placed.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.Object |
getRule()
A data structure that contains the specified rule's name, actions, recipients, domains, enabled status, scan status, and TLS policy.
|
java.lang.String |
getRuleSetName()
The name of the rule set where the receipt rule is added.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setAfter(java.lang.String value)
The name of an existing rule after which the new rule is placed.
|
void |
setRule(CfnReceiptRule.RuleProperty value)
A data structure that contains the specified rule's name, actions, recipients, domains, enabled status, scan status, and TLS policy.
|
void |
setRule(IResolvable value)
A data structure that contains the specified rule's name, actions, recipients, domains, enabled status, scan status, and TLS policy.
|
void |
setRuleSetName(java.lang.String value)
The name of the rule set where the receipt rule is added.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnReceiptRule(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnReceiptRule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnReceiptRule(Construct scope, java.lang.String id, CfnReceiptRuleProps props)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.props
- - resource properties. This parameter is required.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.Object getRule()
public void setRule(IResolvable value)
public void setRule(CfnReceiptRule.RuleProperty value)
public java.lang.String getRuleSetName()
public void setRuleSetName(java.lang.String value)
public java.lang.String getAfter()
If this parameter is null, the new rule is inserted at the beginning of the rule list.
public void setAfter(java.lang.String value)
If this parameter is null, the new rule is inserted at the beginning of the rule list.