Package software.amazon.awscdk.services.ses

Class CfnReceiptRule

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.ses.CfnReceiptRule
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:41.385Z") @Stability(Stable) public class CfnReceiptRule extends CfnResource implements IInspectable
A CloudFormation AWS::SES::ReceiptRule.

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();

  • 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

    • CfnReceiptRule

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

    • CfnReceiptRule

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

    • CfnReceiptRule

      @Stability(Stable) public CfnReceiptRule(@NotNull Construct scope, @NotNull String id, @NotNull CfnReceiptRuleProps props)
      Create a new AWS::SES::ReceiptRule.

      Parameters:
      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.

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

    • getCfnProperties

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

    • getRule

      @Stability(Stable) @NotNull public Object getRule()
      A data structure that contains the specified rule's name, actions, recipients, domains, enabled status, scan status, and TLS policy.

    • setRule

      @Stability(Stable) public void setRule(@NotNull IResolvable value)
      A data structure that contains the specified rule's name, actions, recipients, domains, enabled status, scan status, and TLS policy.

    • setRule

      @Stability(Stable) public void setRule(@NotNull CfnReceiptRule.RuleProperty value)
      A data structure that contains the specified rule's name, actions, recipients, domains, enabled status, scan status, and TLS policy.

    • getRuleSetName

      @Stability(Stable) @NotNull public String getRuleSetName()
      The name of the rule set where the receipt rule is added.

    • setRuleSetName

      @Stability(Stable) public void setRuleSetName(@NotNull String value)
      The name of the rule set where the receipt rule is added.

    • getAfter

      @Stability(Stable) @Nullable public String getAfter()
      The name of an existing rule after which the new rule is placed.

      If this parameter is null, the new rule is inserted at the beginning of the rule list.

    • setAfter

      @Stability(Stable) public void setAfter(@Nullable String value)
      The name of an existing rule after which the new rule is placed.

      If this parameter is null, the new rule is inserted at the beginning of the rule list.