Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

W-15302956 | DOCS - Amazon S3 Connector 6.4.0 #2579

Open
wants to merge 7 commits into
base: latest
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
= Amazon S3 Connector 6.3 Additional Configuration - Mule 4
:page-aliases: connectors::amazon/amazon-s3-connector-config-topics.adoc


[[prereq]]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
= Amazon S3 Connector 6.3 Examples - Mule 4
:page-aliases: connectors::amazon/amazon-s3-connector-examples.adoc

The following example shows how to store an image from a URL in Amazon S3, and retrieve and display the image.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
= Amazon S3 Connector 6.3 Reference - Mule 4
:page-aliases: connectors::amazon/amazon-s3-connector-reference.adoc

Anypoint Connector for Amazon S3 (Amazon S3 Connector) provides connectivity to the Amazon S3 API, enabling you to interface with Amazon S3 to store objects, download and use data with other AWS services, and build applications that require internet storage.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
= Using Anypoint Studio to Configure Amazon S3 Connector 6.3 - Mule 4
:page-aliases: connectors::amazon/amazon-s3-connector-studio.adoc

Anypoint Studio (Studio) editors help you design and update your Mule applications, properties, and configuration files.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
= Upgrading and Migrating Amazon S3 Connector to Version 6.x - Mule 4
:page-aliases: connectors::amazon/amazon-s3-connector-upgrade-migrate.adoc

Upgrade Anypoint Connector for Amazon S3 (Amazon S3 Connector) to version 6.x.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
= Amazon S3 Connector 6.3 XML and Maven Support - Mule 4
:page-aliases: connectors::amazon/amazon-s3-connector-xml-maven.adoc

Although you can manually code a Mule app in XML, it is more efficient to use Anypoint Studio:

Expand Down
1 change: 0 additions & 1 deletion amazon-s3/6.3/modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
= Amazon S3 Connector 6.3 - Mule 4
:page-aliases: connectors::amazon/amazon-s3-connector.adoc


Anypoint Connector for Amazon S3 (Amazon S3 Connector) provides connectivity to the Amazon S3 API, enabling you to interface with Amazon S3 to store objects, download and use data with other AWS services, and build applications that require internet storage.
Expand Down
19 changes: 19 additions & 0 deletions amazon-s3/6.4/antora.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: amazon-s3-connector
version: '6.4'
display_version: 6.4 (Mule 4)
title: Amazon S3 Connector
nav:
- modules/ROOT/nav.adoc
asciidoc:
attributes:
page-component-desc: Provides connectivity to the Amazon S3 API, enabling you to interface with Amazon S3 to store objects, download and use data with other AWS services, and build applications that require internet storage.
page-connector-type: Connector
page-connector-level: Select
page-exchange-group-id: com.mulesoft.connectors
page-exchange-asset-id: mule-amazon-s3-connector
page-runtime-version: 4.3.0
page-release-notes-page: release-notes::connector/amazon-s3-connector-release-notes-mule-4.adoc
page-vendor-name: amazon
page-vendor-title: Amazon
page-service-name: Amazon S3
page-connector-name: s3
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added amazon-s3/6.4/modules/ROOT/images/flow.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added amazon-s3/6.4/modules/ROOT/images/request.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 9 additions & 0 deletions amazon-s3/6.4/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
.xref:index.adoc[Amazon S3 Connector]
* xref:index.adoc[Amazon S3 Connector Overview]
* xref:amazon-s3-connector-upgrade-migrate.adoc[Upgrading and Migrating Amazon S3 Connector]
* xref:amazon-s3-connector-studio.adoc[Using Anypoint Studio to Configure Amazon S3 Connector]
* xref:amazon-s3-connector-config-topics.adoc[Amazon S3 Connector Additional Configuration Information]
* xref:amazon-s3-connector-xml-maven.adoc[Amazon S3 Connector XML and Maven Support]
* xref:amazon-s3-connector-examples.adoc[Amazon S3 Connector Examples]
* xref:amazon-s3-connector-troubleshooting.adoc[Troubleshooting Amazon S3 Connector]
* xref:amazon-s3-connector-reference.adoc[Amazon S3 Connector Reference]
Original file line number Diff line number Diff line change
@@ -0,0 +1,176 @@
= Amazon S3 Connector 6.4 Additional Configuration - Mule 4
:page-aliases: connectors::amazon/amazon-s3-connector-config-topics.adoc


[[prereq]]
== Before You Begin for Source Operations

Amazon S3 source operations use Amazon SQS for notifying when a new object is created or deleted in an S3 bucket.

There are multiple scenarios for the *On New Object* and *On Deleted Object* Amazon S3 sources:

. The <<queue-is-created,queue is already created>> and specified
. The <<queue-created-by-source,queue is created>> by the source
. The <<configuration-is-created, event notification configuration is created>> by the source

[[queue-is-created]]
== Queue Is Already Created

To correctly use a source for a queue that already exists, the user must have these actions enabled for the Amazon SQS queue:

[source,json,linenums]
----
{
"Version": "2012-10-17",
"Statement": [
{
"Sid": "VisualEditor0",
"Effect": "Allow",
"Action": [
"sqs:DeleteMessage",
"sqs:GetQueueUrl",
"sqs:ReceiveMessage",
"sqs:GetQueueAttributes"
],
"Resource": "arn:aws:sqs:REGION:ACCOUNT_ID:QUEUE_NAME"
}
]
}
----

Additionally, to enable the queue to receive messages when a new object is created or deleted in an S3 bucket, create a policy for the queue in this format:

[source,json,linenums]
----
{
"Version": "2012-10-17",
"Id": "arn:aws:sqs:REGION:ACCOUNT_ID:QUEUE_NAME/SQSDefaultPolicy",
"Statement": [
{
"Sid": "Sid1593770403887",
"Effect": "Allow",
"Principal": "*",
"Action": "SQS:SendMessage",
"Resource": "arn:aws:sqs:REGION:ACCOUNT_ID:QUEUE_NAME",
"Condition": {
"ArnLike": {
"aws:SourceArn": "arn:aws:s3:::BUCKET_NAME"
}
}
}
]
}
----

[[queue-created-by-source]]
== Queue Is Created by Source

If the queue is created by the source, the queue name has the prefix `MULE-S3-TRIGGER`.

When the queue is created by the source, the user must have permission to both create a queue and set the queue attributes:

[source,json,linenums]
----
{
"Version": "2012-10-17",
"Statement": [
{
"Sid": "VisualEditor0",
"Effect": "Allow",
"Action": [
"sqs:DeleteMessage",
"sqs:ReceiveMessage",
"sqs:GetQueueAttributes",
"sqs:CreateQueue",
"sqs:SetQueueAttributes",
"sqs:GetQueueUrl"
],
"Resource": "arn:aws:sqs:REGION:ACCOUNT_ID:MULE-S3-TRIGGER-*"
}
]
}
----

When the queue is created by the source, an SQS policy is added to the queue in the following format when the S3 object is created or deleted in the bucket :


[source,json,linenums]
----
{
"Version": "2012-10-17",
"Id": "example-ID",
"Statement": [
{
"Sid": "example-statement-ID",
"Effect": "Allow",
"Principal": {
"AWS": "*"
},
"Action": "SQS:SendMessage",
"Resource":QUEUE_ARN,
"Condition": {
"ArnLike": {
"aws:SourceArn": "BUCKET_ARN"
}
}
}
]
}
----

[[configuration-is-created]]
== Notification Configuration for S3 Bucket Events is Already Created

To correctly use a source for a notification configuration that already exists, you must specify the notification configuration name in the ADVANCED tab of the source:

[source,xml,linenums]
----
<s3:new-object-trigger doc:name="On New Object" config-ref="${config}" bucketName="example-bucket-name"
notificationConfigurationName="on-new-object-configuration">
<scheduling-strategy>
<fixed-frequency/>
</scheduling-strategy>
</s3:new-object-trigger>
----

== S3 Policy Bucket

For the S3 policy, use this format for all cases:

[source,json,linenums]
----
{
"Version": "2012-10-17",
"Id": "Policy1593761427184",
"Statement": [
{
"Sid": "Stmt1593760119344",
"Effect": "Allow",
"Principal": {
"AWS": "arn:aws:iam::ACCOUNT_ID:user/test"
},
"Action": "SPECIFIC_ACTION",
"Resource": "arn:aws:s3:::BUCKET_NAME/*"
},
{
"Sid": "Stmt1593760259223",
"Effect": "Allow",
"Principal": {
"AWS": "arn:aws:iam::ACCOUNT_ID:user/test"
},
"Action": ["s3:PutBucketNotification", "s3:GetBucketNotification"],
"Resource": "arn:aws:s3:::BUCKET_NAME"
}
]
}
----

In this example, the *SPECIFIC_ACTION* is `s3:PutObject` or `s3:DeleteObject`, depending on the specified source operation.

== Next Step

After you complete configuring the connector, you can try the xref:amazon-s3-connector-examples.adoc[Example].

== See Also

* https://help.mulesoft.com[MuleSoft Help Center]
Loading