Skip to content

Commit

Permalink
fix: update API.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@seeebiii
seeebiii committed Jun 1, 2022
1 parent 9cd56c0 commit f20f07b
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions API.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ It creates two rule actions:

The Lambda function is using the NPM package `aws-lambda-ses-forwarder` to forward the mails.

__Implements__: [IConstruct](#constructs-iconstruct), [IConstruct](#aws-cdk-core-iconstruct), [IConstruct](#constructs-iconstruct), [IDependable](#aws-cdk-core-idependable)
__Extends__: [Construct](#aws-cdk-core-construct)
__Implements__: [IConstruct](#constructs-iconstruct), [IDependable](#constructs-idependable)
__Extends__: [Construct](#constructs-construct)

### Initializer

Expand All @@ -41,15 +41,15 @@ __Extends__: [Construct](#aws-cdk-core-construct)
new EmailForwardingRule(parent: Construct, name: string, props: EmailForwardingRuleProps)
```

* **parent** (<code>[Construct](#aws-cdk-core-construct)</code>) *No description*
* **parent** (<code>[Construct](#constructs-construct)</code>) *No description*
* **name** (<code>string</code>) *No description*
* **props** (<code>[EmailForwardingRuleProps](#seeebiii-ses-email-forwarding-emailforwardingruleprops)</code>) *No description*
* **domainName** (<code>string</code>) The domain name of the email addresses, e.g. 'example.org'. It is used to connect the `fromPrefix` and `receivePrefix` properties with a proper domain.
* **emailMapping** (<code>Array<[EmailMapping](#seeebiii-ses-email-forwarding-emailmapping)></code>) An email mapping similar to what the NPM library `aws-lambda-ses-forwarder` expects.
* **fromPrefix** (<code>string</code>) A prefix that is used as the sender address of the forwarded mail, e.g. `noreply`.
* **id** (<code>string</code>) An id for the rule.
* **ruleSet** (<code>[IReceiptRuleSet](#aws-cdk-aws-ses-ireceiptruleset)</code>) The rule set this rule belongs to.
* **bucket** (<code>[Bucket](#aws-cdk-aws-s3-bucket)</code>) A bucket to store the email files to. __*Default*__: A new bucket will be created.
* **ruleSet** (<code>[aws_ses.IReceiptRuleSet](#aws-cdk-lib-aws-ses-ireceiptruleset)</code>) The rule set this rule belongs to.
* **bucket** (<code>[aws_s3.Bucket](#aws-cdk-lib-aws-s3-bucket)</code>) A bucket to store the email files to. __*Default*__: A new bucket will be created.
* **bucketPrefix** (<code>string</code>) A prefix for the email files that are saved to the bucket. __*Default*__: inbox/
* **enableLambdaLogging** (<code>boolean</code>) Enable log messages in Lambda function which forwards emails. __*Default*__: true

Expand All @@ -71,8 +71,8 @@ This construct can...
- verify a given domain in SES (automatically if domain is managed by Route53, otherwise it'll just initiate the verification),
- initiate verification for all target email addresses that are provided for receiving the forwarded emails.

__Implements__: [IConstruct](#constructs-iconstruct), [IConstruct](#aws-cdk-core-iconstruct), [IConstruct](#constructs-iconstruct), [IDependable](#aws-cdk-core-idependable)
__Extends__: [Construct](#aws-cdk-core-construct)
__Implements__: [IConstruct](#constructs-iconstruct), [IDependable](#constructs-idependable)
__Extends__: [Construct](#constructs-construct)

### Initializer

Expand All @@ -83,12 +83,12 @@ __Extends__: [Construct](#aws-cdk-core-construct)
new EmailForwardingRuleSet(parent: Construct, name: string, props: EmailForwardingRuleSetProps)
```

* **parent** (<code>[Construct](#aws-cdk-core-construct)</code>) *No description*
* **parent** (<code>[Construct](#constructs-construct)</code>) *No description*
* **name** (<code>string</code>) *No description*
* **props** (<code>[EmailForwardingRuleSetProps](#seeebiii-ses-email-forwarding-emailforwardingrulesetprops)</code>) *No description*
* **emailForwardingProps** (<code>Array<[EmailForwardingProps](#seeebiii-ses-email-forwarding-emailforwardingprops)></code>) A list of mapping options to define how emails should be forwarded.
* **enableRuleSet** (<code>boolean</code>) Optional: whether to enable the rule set or not. __*Default*__: true
* **ruleSet** (<code>[IReceiptRuleSet](#aws-cdk-aws-ses-ireceiptruleset)</code>) Optional: an existing SES receipt rule set. __*Optional*__
* **ruleSet** (<code>[aws_ses.IReceiptRuleSet](#aws-cdk-lib-aws-ses-ireceiptruleset)</code>) Optional: an existing SES receipt rule set. __*Optional*__
* **ruleSetName** (<code>string</code>) Optional: provide a name for the receipt rule set that this construct creates if you don't provide one. __*Default*__: custom-rule-set


Expand All @@ -99,7 +99,7 @@ new EmailForwardingRuleSet(parent: Construct, name: string, props: EmailForwardi
Name | Type | Description
-----|------|-------------
**emailForwardingMappings** | <code>Array<any></code> | <span></span>
**ruleSet** | <code>[IReceiptRuleSet](#aws-cdk-aws-ses-ireceiptruleset)</code> | <span></span>
**ruleSet** | <code>[aws_ses.IReceiptRuleSet](#aws-cdk-lib-aws-ses-ireceiptruleset)</code> | <span></span>



Expand All @@ -115,9 +115,9 @@ Name | Type | Description
**domainName** | <code>string</code> | The domain name for which you want to receive emails using SES, e.g. `example.org`.
**emailMappings** | <code>Array<[EmailMapping](#seeebiii-ses-email-forwarding-emailmapping)></code> | A list of email mappings to define the receive email address and target email addresses to which the emails are forwarded to.
**fromPrefix** | <code>string</code> | A prefix that is used as the sender address of the forwarded mail, e.g. `noreply`.
**bucket**? | <code>[Bucket](#aws-cdk-aws-s3-bucket)</code> | Optional: an S3 bucket to store the received emails.<br/>__*Default*__: A new bucket.
**bucket**? | <code>[aws_s3.Bucket](#aws-cdk-lib-aws-s3-bucket)</code> | Optional: an S3 bucket to store the received emails.<br/>__*Default*__: A new bucket.
**bucketPrefix**? | <code>string</code> | Optional: a prefix for the email files that are stored on the S3 bucket.<br/>__*Default*__: inbox/
**notificationTopic**? | <code>[Topic](#aws-cdk-aws-sns-topic)</code> | Optional: an SNS topic to receive notifications about sending events like bounces or complaints.<br/>__*Default*__: A new SNS topic.
**notificationTopic**? | <code>[aws_sns.Topic](#aws-cdk-lib-aws-sns-topic)</code> | Optional: an SNS topic to receive notifications about sending events like bounces or complaints.<br/>__*Default*__: A new SNS topic.
**notificationTypes**? | <code>Array<string></code> | Optional: a list of {@link NotificationType}s to define which sending events should be subscribed.<br/>__*Default*__: ['Bounce', 'Complaint']
**verifyDomain**? | <code>boolean</code> | Optional: true if you want to verify the domain identity in SES, false otherwise.<br/>__*Default*__: false
**verifyTargetEmailAddresses**? | <code>boolean</code> | Optional: true if you want to initiate the verification of your target email addresses, false otherwise.<br/>__*Default*__: false
Expand All @@ -137,8 +137,8 @@ Name | Type | Description
**emailMapping** | <code>Array<[EmailMapping](#seeebiii-ses-email-forwarding-emailmapping)></code> | An email mapping similar to what the NPM library `aws-lambda-ses-forwarder` expects.
**fromPrefix** | <code>string</code> | A prefix that is used as the sender address of the forwarded mail, e.g. `noreply`.
**id** | <code>string</code> | An id for the rule.
**ruleSet** | <code>[IReceiptRuleSet](#aws-cdk-aws-ses-ireceiptruleset)</code> | The rule set this rule belongs to.
**bucket**? | <code>[Bucket](#aws-cdk-aws-s3-bucket)</code> | A bucket to store the email files to.<br/>__*Default*__: A new bucket will be created.
**ruleSet** | <code>[aws_ses.IReceiptRuleSet](#aws-cdk-lib-aws-ses-ireceiptruleset)</code> | The rule set this rule belongs to.
**bucket**? | <code>[aws_s3.Bucket](#aws-cdk-lib-aws-s3-bucket)</code> | A bucket to store the email files to.<br/>__*Default*__: A new bucket will be created.
**bucketPrefix**? | <code>string</code> | A prefix for the email files that are saved to the bucket.<br/>__*Default*__: inbox/
**enableLambdaLogging**? | <code>boolean</code> | Enable log messages in Lambda function which forwards emails.<br/>__*Default*__: true

Expand All @@ -155,7 +155,7 @@ Name | Type | Description
-----|------|-------------
**emailForwardingProps** | <code>Array<[EmailForwardingProps](#seeebiii-ses-email-forwarding-emailforwardingprops)></code> | A list of mapping options to define how emails should be forwarded.
**enableRuleSet**? | <code>boolean</code> | Optional: whether to enable the rule set or not.<br/>__*Default*__: true
**ruleSet**? | <code>[IReceiptRuleSet](#aws-cdk-aws-ses-ireceiptruleset)</code> | Optional: an existing SES receipt rule set.<br/>__*Optional*__
**ruleSet**? | <code>[aws_ses.IReceiptRuleSet](#aws-cdk-lib-aws-ses-ireceiptruleset)</code> | Optional: an existing SES receipt rule set.<br/>__*Optional*__
**ruleSetName**? | <code>string</code> | Optional: provide a name for the receipt rule set that this construct creates if you don't provide one.<br/>__*Default*__: custom-rule-set


Expand Down

0 comments on commit f20f07b

Please sign in to comment.