Package software.amazon.awscdk.services.ses

Class CfnReceiptRule

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.CfnReceiptRule
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-24T10:56:40.276Z") @Stability(Stable) 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
                                 .iamRoleArn("iamRoleArn")
                                 .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();

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

    • CfnReceiptRule

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

    • CfnReceiptRule

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

    • CfnReceiptRule

      @Stability(Stable) public CfnReceiptRule(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnReceiptRuleProps 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

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

    • setAfter

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