Skip to content
This repository was archived by the owner on May 5, 2025. It is now read-only.

Commit 84a6cd8

Browse files
committed
Document Amazon S3 source
1 parent 5d46980 commit 84a6cd8

15 files changed

+251
-45
lines changed
37.9 KB
Loading
14.8 KB
Loading
8.66 KB
Loading
33.7 KB
Loading
56.8 KB
Loading
30 KB
Loading
31 KB
Loading

docs/sources/awscodecommit.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,10 @@ arn:aws:codecommit:{awsRegion}:{awsAccountId}:{repositoryName}
4646

4747
### API Credentials
4848

49-
The TriggerMesh AWS CodeCommit event source authenticates calls to the AWS CodeCommit API using an [Access
50-
Key][accesskey]. The page at this link contains instructions to create an access key when signed either as the root user
51-
or as an IAM user. Take note of the **Access Key ID** and **Secret Access Key**, they will be used to create an instance
52-
of the event source.
49+
The TriggerMesh event source for Amazon CodeCommit authenticates calls to the AWS API using AWS Access Keys. The page
50+
[Understanding and getting your AWS credentials][accesskey] contains instructions to create access keys when signed-in
51+
either as the root user or as an IAM user. Take note of the **Access Key ID** and **Secret Access Key**, they will be
52+
used to create an instance of the event source.
5353

5454
It is considered a [good practice][iam-bestpractices] to create dedicated users with restricted privileges in order to
5555
programmatically access AWS services. Permissions can be added or revoked granularly for a given IAM user by attaching

docs/sources/awscognitouserpool.md

Lines changed: 24 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,30 @@
1-
# Event source for AWS Cognito User Pool
1+
# Event source for AWS Cognito User Pools
22

3-
This event source captures messages from an [AWS Cognito User Pool ][cup-docs] whenever a specific action, such as the creation of a new user, happens in the user identity pool.
3+
This event source captures messages from an [AWS Cognito User Pool][cup-docs] whenever a specific action, such as the
4+
creation of a new user, happens in the user identity pool.
45

56
## Prerequisites
67

78
### AWS Cognito User Pool
89

9-
If you don't already have an AWS Cognito User Pool, create one by following the instructions in the [Getting started with User Pools][cup-getting-started] guide.
10+
If you don't already have an AWS Cognito User Pool, create one by following the instructions in the [Getting started
11+
with User Pools][cup-getting-started] guide.
1012

1113
### Amazon Resource Name (ARN)
1214

1315
A fully qualified ARN is required to uniquely identify the AWS Cognito User Pool.
1416

1517
![User Pool ARN](../images/awscognitouserpool-source/userpool-arn.png)
1618

17-
As shown in the above screenshot, you can obtain the ARN of a User Pool from the AWS console. It typically has the following format:
19+
As shown in the above screenshot, you can obtain the ARN of a User Pool from the AWS console. It typically has the
20+
following format:
1821

1922
```
2023
arn:aws:cognito-idp:{awsRegion}:{awsAccountId}:userpool/{poolId}
2124
```
2225

23-
Alternatively you can also use the [AWS CLI][aws-cli]. The following command retrieves the ARN of a User Pool in the `us-west-2` region which has the pool id `us-west-2_fak3p001B`.
26+
Alternatively you can also use the [AWS CLI][aws-cli]. The following command retrieves the ARN of a User Pool in the
27+
`us-west-2` region which has the pool id `us-west-2_fak3p001B`.
2428

2529
```console
2630
$ aws --region us-west-2 cognito-idp describe-user-pool --user-pool-id us-west-2_fak3p001B
@@ -36,11 +40,17 @@ $ aws --region us-west-2 cognito-idp describe-user-pool --user-pool-id us-west-2
3640

3741
### API credentials
3842

39-
The TriggerMesh AWS Cognito UserPool event source authenticates calls to the AWS Cognito API using an [Access Key][accesskey]. The page at this link contains instructions to create an access key when signed either as the root user or as an IAM user. Take note of the **Access Key ID** and **Secret Access Key**, they will be used to create an instance of the event source.
43+
The TriggerMesh event source for Amazon Cognito User Pools authenticates calls to the AWS API using AWS Access Keys. The
44+
page [Understanding and getting your AWS credentials][accesskey] contains instructions to create access keys when
45+
signed-in either as the root user or as an IAM user. Take note of the **Access Key ID** and **Secret Access Key**, they
46+
will be used to create an instance of the event source.
4047

41-
It is considered a [good practice][iam-bestpractices] to create dedicated users with restricted privileges in order to programmatically access AWS services. Permissions can be added or revoked granularly for a given IAM user by attaching [IAM Policies][iam-policies] to it.
48+
It is considered a [good practice][iam-bestpractices] to create dedicated users with restricted privileges in order to
49+
programmatically access AWS services. Permissions can be added or revoked granularly for a given IAM user by attaching
50+
[IAM Policies][iam-policies] to it.
4251

43-
As an example, the following policy contains the permissions required by the TriggerMesh AWS Cognito User Pool event source to list users in any user pool associated with the AWS account:
52+
As an example, the following policy contains the permissions required by the TriggerMesh AWS Cognito User Pool event
53+
source to list users in any user pool associated with the AWS account:
4454

4555
```json
4656
{
@@ -67,16 +77,19 @@ Open the Bridge creation screen and add a source of type `AWS Cognito User Pool`
6777

6878
In the Source creation form, give a name to the event source and add the following information:
6979

70-
* [**Secret**][accesskey]: Reference to a [TriggerMesh secret][tm-secret] containing an Access Key ID and a Secret Access Key to communicate with the AWS SQS API, as described in the previous sections.
80+
* [**Secret**][accesskey]: Reference to a [TriggerMesh secret][tm-secret] containing an Access Key ID and a Secret
81+
Access Key to communicate with the AWS SQS API, as described in the previous sections.
7182
* [**AWS ARN**][arn]: ARN of the User Pool, as described in the previous sections.
7283

7384
![Source form](../images/awscognitouserpool-source/source-cognito-userpool-form.png)
7485

75-
After clicking the `Save` button, you will be taken back to the Bridge editor. Proceed to adding the remaining components to the Bridge, then submit it.
86+
After clicking the `Save` button, you will be taken back to the Bridge editor. Proceed to adding the remaining
87+
components to the Bridge, then submit it.
7688

7789
![Bridge overview](../images/awscognitouserpool-source/bridge-form-target.png)
7890

79-
A ready status on the main _Bridges_ page indicates that the event source is ready to receive notifications from the AWS Cognito User Pool.
91+
A ready status on the main _Bridges_ page indicates that the event source is ready to receive notifications from the AWS
92+
Cognito User Pool.
8093

8194
![Bridge status](../images/awscognitouserpool-source/bridge-status.png)
8295

docs/sources/awsdynamodb.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,10 +45,10 @@ $ aws dynamodb describe-table --table-name triggermeshtest --region us-west-2
4545

4646
### API Credentials
4747

48-
The TriggerMesh AWS DynamoDB event source authenticates calls to the AWS DynamoDB API using an [Access Key][accesskey].
49-
The page at this link contains instructions to create an access key when signed either as the root user or as an IAM
50-
user. Take note of the **Access Key ID** and **Secret Access Key**, they will be used to create an instance of the event
51-
source.
48+
The TriggerMesh event source for Amazon DynamoDB authenticates calls to the AWS API using AWS Access Keys. The page
49+
[Understanding and getting your AWS credentials][accesskey] contains instructions to create access keys when signed-in
50+
either as the root user or as an IAM user. Take note of the **Access Key ID** and **Secret Access Key**, they will be
51+
used to create an instance of the event source.
5252

5353
It is considered a [good practice][iam-bestpractices] to create dedicated users with restricted privileges in order to
5454
programmatically access AWS services. Permissions can be added or revoked granularly for a given IAM user by attaching

0 commit comments

Comments
 (0)