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

Commit 390bfeb

Browse files
Use "-" in unordered lists to follow style guide (#141)
1 parent c5123ce commit 390bfeb

19 files changed

+223
-223
lines changed

docs/sources/awscodecommit.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ as a new commit or the creation of a pull request, happens in this repository.
55

66
## Prerequisite(s)
77

8-
* CodeCommit Repository and Branch
9-
* Amazon Resource Name (ARN)
10-
* API Credentials
8+
- CodeCommit Repository and Branch
9+
- Amazon Resource Name (ARN)
10+
- API Credentials
1111

1212
### CodeCommit Repository and Branch
1313

@@ -90,10 +90,10 @@ Open the Bridge creation screen and add a source of type `AWS CodeCommit`.
9090

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

93-
* [**AWS ARN**][arn]: ARN of the CodeCommit repository, as described in the previous sections.
94-
* [**Branch name**][cc-branches]: Name of the Git branch the source should be watching for commits.
95-
* **Event types**: List of event types the event source should subscribe to.
96-
* [**AWS Secret**][accesskey]: Reference to a [TriggerMesh secret][tm-secret] containing an Access Key ID and a Secret
93+
- [**AWS ARN**][arn]: ARN of the CodeCommit repository, as described in the previous sections.
94+
- [**Branch name**][cc-branches]: Name of the Git branch the source should be watching for commits.
95+
- **Event types**: List of event types the event source should subscribe to.
96+
- [**AWS Secret**][accesskey]: Reference to a [TriggerMesh secret][tm-secret] containing an Access Key ID and a Secret
9797
Access Key to communicate with the AWS CodeCommit API, as described in the previous sections.
9898

9999
![AWS CodeCommit source form](../images/awscodecommit-source/create-bridge-2.png)
@@ -112,8 +112,8 @@ CodeCommit repository.
112112

113113
The AWS CodeCommit event source emits events of the following types:
114114

115-
* `com.amazon.codecommit.push`
116-
* `com.amazon.codecommit.pull_request`
115+
- `com.amazon.codecommit.push`
116+
- `com.amazon.codecommit.pull_request`
117117

118118
[arn]: https://docs.aws.amazon.com/IAM/latest/UserGuide/list_awscodecommit.html#awscodecommit-resources-for-iam-policies
119119
[accesskey]: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys

docs/sources/awscognitouserpool.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ creation of a new user, happens in the user identity pool.
55

66
## Prerequisite(s)
77

8-
* AWS Cognito User Pool
9-
* Amazon Resource Name (ARN)
10-
* API Credentials
8+
- AWS Cognito User Pool
9+
- Amazon Resource Name (ARN)
10+
- API Credentials
1111

1212
### AWS Cognito User Pool
1313

@@ -81,9 +81,9 @@ Open the Bridge creation screen and add a source of type `AWS Cognito User Pool`
8181

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

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

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

@@ -101,7 +101,7 @@ Cognito User Pool.
101101

102102
The AWS Cognito UserPool event source emits events of the following type:
103103

104-
* `com.amazon.cognito-idp.sync_trigger`
104+
- `com.amazon.cognito-idp.sync_trigger`
105105

106106
[cup-docs]: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html
107107
[cup-getting-started]: https://docs.aws.amazon.com/cognito/latest/developerguide/getting-started-with-cognito-user-pools.html

docs/sources/awsdynamodb.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ sequence of item-level modifications from a [DynamoDB Stream][ddb-streams].
55

66
## Prerequisite(s)
77

8-
* DynamoDB Table and Stream
9-
* Amazon Resource Name (ARN)
10-
* API Credentials
8+
- DynamoDB Table and Stream
9+
- Amazon Resource Name (ARN)
10+
- API Credentials
1111

1212
### DynamoDB Table and Stream
1313

@@ -89,8 +89,8 @@ Open the Bridge creation screen and add a source of type `AWS DynamoDB`.
8989

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

92-
* [**AWS ARN**][arn]: ARN of the DynamoDB Table, as described in the previous sections.
93-
* [**AWS Secret**][accesskey]: Reference to a [TriggerMesh secret][tm-secret] containing an Access Key ID and a Secret
92+
- [**AWS ARN**][arn]: ARN of the DynamoDB Table, as described in the previous sections.
93+
- [**AWS Secret**][accesskey]: Reference to a [TriggerMesh secret][tm-secret] containing an Access Key ID and a Secret
9494
Access Key to communicate with the AWS DynamoDB API, as described in the previous sections.
9595

9696
![AWS DynamoDB source form](../images/awsdynamodb-source/create-bridge-2.png)
@@ -109,9 +109,9 @@ DynamoDB Stream.
109109

110110
The AWS DynamoDB event source emits events of the following types:
111111

112-
* `com.amazon.dynamodb.insert`
113-
* `com.amazon.dynamodb.modify`
114-
* `com.amazon.dynamodb.remove`
112+
- `com.amazon.dynamodb.insert`
113+
- `com.amazon.dynamodb.modify`
114+
- `com.amazon.dynamodb.remove`
115115

116116
[arn]: https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazondynamodb.html#amazondynamodb-resources-for-iam-policies
117117
[accesskey]: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys

docs/sources/awskinesis.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ after wrapping them in a [CloudEvent][ce] envelope.
55

66
## Prerequisite(s)
77

8-
* Kinesis Data Stream
9-
* Amazon Resource Name (ARN)
10-
* API Credentials
8+
- Kinesis Data Stream
9+
- Amazon Resource Name (ARN)
10+
- API Credentials
1111

1212
### Kinesis Data Stream
1313

@@ -82,8 +82,8 @@ Open the Bridge creation screen and add a source of type `AWS Kinesis`.
8282

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

85-
* [**AWS ARN**][arn]: ARN of the Kinesis Data Stream, as described in the previous sections.
86-
* [**AWS Secret**][accesskey]: Reference to a [TriggerMesh secret][tm-secret] containing an Access Key ID and a Secret
85+
- [**AWS ARN**][arn]: ARN of the Kinesis Data Stream, as described in the previous sections.
86+
- [**AWS Secret**][accesskey]: Reference to a [TriggerMesh secret][tm-secret] containing an Access Key ID and a Secret
8787
Access Key to communicate with the AWS Kinesis API, as described in the previous sections.
8888

8989
![AWS Kinesis source form](../images/awskinesis-source/create-bridge-2.png)
@@ -102,7 +102,7 @@ Kinesis Data Stream.
102102

103103
The AWS Kinesis event source emits events of the following types:
104104

105-
* `com.amazon.kinesis.stream_record`
105+
- `com.amazon.kinesis.stream_record`
106106

107107
[arn]: https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazonkinesis.html#amazonkinesis-resources-for-iam-policies
108108
[accesskey]: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys

docs/sources/awss3.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ an [Amazon SQS queue][sqs-docs] in order to be consumable by the event source.
55

66
## Prerequisite(s)
77

8-
* S3 Bucket
9-
* Amazon Resource Name (ARN)
10-
* API Credentials
11-
* SQS Queue _(optional)_
8+
- S3 Bucket
9+
- Amazon Resource Name (ARN)
10+
- API Credentials
11+
- SQS Queue _(optional)_
1212

1313
### S3 Bucket
1414

@@ -121,13 +121,13 @@ Open the Bridge creation screen and add a source of type `AWS S3`.
121121

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

124-
* [**Source secret**][accesskey]: Reference to a [TriggerMesh secret][tm-secret] containing an Access Key ID and a
124+
- [**Source secret**][accesskey]: Reference to a [TriggerMesh secret][tm-secret] containing an Access Key ID and a
125125
Secret Access Key to communicate with the AWS API, as described in the previous sections.
126-
* [**Bucket ARN**][arn]: ARN of the S3 bucket. This ARN needs to include the AWS region and account ID, as described in the
126+
- [**Bucket ARN**][arn]: ARN of the S3 bucket. This ARN needs to include the AWS region and account ID, as described in the
127127
previous sections.
128-
* [**Queue ARN**][arn]: _(optional)_ ARN of the SQS queue which acts as event destination, in case you prefer to manage
128+
- [**Queue ARN**][arn]: _(optional)_ ARN of the SQS queue which acts as event destination, in case you prefer to manage
129129
this queue yourself as described in the previous sections.
130-
* [**Event types**][s3-events]: List of event types to subscribe to.
130+
- [**Event types**][s3-events]: List of event types to subscribe to.
131131

132132
![AWS S3 source form](../images/awss3-source/create-bridge-2.png)
133133

@@ -150,12 +150,12 @@ contains a new Event Notification targeting the SQS queue.
150150

151151
The TriggerMesh event source for Amazon S3 emits events of the following types:
152152

153-
* `com.amazon.s3.objectcreated`
154-
* `com.amazon.s3.objectremoved`
155-
* `com.amazon.s3.objectrestore`
156-
* `com.amazon.s3.reducedredundancylostobject`
157-
* `com.amazon.s3.replication`
158-
* `com.amazon.s3.testevent`
153+
- `com.amazon.s3.objectcreated`
154+
- `com.amazon.s3.objectremoved`
155+
- `com.amazon.s3.objectrestore`
156+
- `com.amazon.s3.reducedredundancylostobject`
157+
- `com.amazon.s3.replication`
158+
- `com.amazon.s3.testevent`
159159

160160
[arn]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazons3.html#amazons3-resources-for-iam-policies
161161
[accesskey]: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys

docs/sources/awssns.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ sink.
55

66
## Prerequisite(s)
77

8-
* SNS Topic (standard)
9-
* Amazon Resource Name (ARN)
10-
* API Credentials
8+
- SNS Topic (standard)
9+
- Amazon Resource Name (ARN)
10+
- API Credentials
1111

1212
### SNS Topic (standard)
1313

@@ -91,10 +91,10 @@ Open the Bridge creation screen and add a source of type `AWS SNS`.
9191

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

94-
* [**Secret**][accesskey]: Reference to a [TriggerMesh secret][tm-secret] containing an Access Key ID and a Secret
94+
- [**Secret**][accesskey]: Reference to a [TriggerMesh secret][tm-secret] containing an Access Key ID and a Secret
9595
Access Key to communicate with the AWS SNS API, as described in the previous sections.
96-
* [**AWS ARN**][arn]: ARN of the SNS topic, as described in the previous sections.
97-
* [**DeliveryPolicy**][sns-delivery-policy]: Delivery policy to define how Amazon SNS retries the delivery of messages
96+
- [**AWS ARN**][arn]: ARN of the SNS topic, as described in the previous sections.
97+
- [**DeliveryPolicy**][sns-delivery-policy]: Delivery policy to define how Amazon SNS retries the delivery of messages
9898
to HTTP/S endpoints.
9999

100100
![AWS SNS source form](../images/awssns-source/bridge-form-sns-source-form.png)
@@ -113,7 +113,7 @@ topic.
113113

114114
The AWS SNS event source emits events of the following type:
115115

116-
* `com.amazon.sns.notification`
116+
- `com.amazon.sns.notification`
117117

118118
[sns-docs]: https://docs.aws.amazon.com/sns/latest/dg/welcome.html
119119
[sns-getting-started]: https://docs.aws.amazon.com/sns/latest/dg/sns-getting-started.html

docs/sources/awssqs.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ The event source captures messages sent to a [AWS SQS queue][sqs-docs] and sends
44

55
## Prerequisite(s)
66

7-
* SQS Queue
8-
* Amazon Resource Name (ARN)
9-
* API Credentials
7+
- SQS Queue
8+
- Amazon Resource Name (ARN)
9+
- API Credentials
1010

1111
### SQS Queue
1212

@@ -83,9 +83,9 @@ Open the Bridge creation screen and add a source of type `AWS SQS`.
8383

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

86-
* [**Secret**][accesskey]: Reference to a [TriggerMesh secret][tm-secret] containing an Access Key ID and a Secret
86+
- [**Secret**][accesskey]: Reference to a [TriggerMesh secret][tm-secret] containing an Access Key ID and a Secret
8787
Access Key to communicate with the AWS SQS API, as described in the previous sections.
88-
* [**AWS ARN**][arn]: ARN of the SQS queue, as described in the previous sections.
88+
- [**AWS ARN**][arn]: ARN of the SQS queue, as described in the previous sections.
8989

9090
![AWS SQS source form](../images/awssqs-source/bridge-form-sqs-source-form.png)
9191

@@ -103,7 +103,7 @@ SQS queue.
103103

104104
The AWS SQS event source emits events of the following type:
105105

106-
* `com.amazon.sqs.message`
106+
- `com.amazon.sqs.message`
107107

108108
[sqs-docs]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/welcome.html
109109
[sqs-getting-started]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-getting-started.html

docs/sources/azureactivitylogs.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ selected set of log categories to a dedicated Event Hub, then subscribing to the
66

77
## Prerequisite(s)
88

9-
* Service Principal
10-
* Event Hubs Namespace
11-
* Event Hubs Instance _(optional)_
12-
* Shared Access Policy / Shared Access Signature (SAS)
9+
- Service Principal
10+
- Event Hubs Namespace
11+
- Event Hubs Instance _(optional)_
12+
- Shared Access Policy / Shared Access Signature (SAS)
1313

1414
### Service Principal
1515

@@ -20,10 +20,10 @@ authority over the Azure Subscription to monitor. You can create a Service Princ
2020
The section called _Assign a role to the application_ describes how to assign permissions to the Service Principal. Make
2121
sure you select a role which has at least the following permissions:
2222

23-
* `Microsoft.Insights/DiagnosticSettings/Read`
24-
* `Microsoft.Insights/DiagnosticSettings/Delete`
25-
* `Microsoft.Insights/DiagnosticSettings/Write`
26-
* `Microsoft.EventHub/namespaces/authorizationRules/listkeys/action`
23+
- `Microsoft.Insights/DiagnosticSettings/Read`
24+
- `Microsoft.Insights/DiagnosticSettings/Delete`
25+
- `Microsoft.Insights/DiagnosticSettings/Write`
26+
- `Microsoft.EventHub/namespaces/authorizationRules/listkeys/action`
2727

2828
Additionally, assign the role `Azure Event Hubs Data Receiver` to the Service Principal to allow it to receive events
2929
from Event Hubs.
@@ -62,8 +62,8 @@ The corresponding role JSON is given as a reference which you can replicate to c
6262

6363
After the Service Principal is created and assigned suitable roles, take note of the following information:
6464

65-
* **Tenant ID** and **Client ID** (see _Get tenant and app ID values for signing in_)
66-
* **Client secret** (see _Create a new application secret_)
65+
- **Tenant ID** and **Client ID** (see _Get tenant and app ID values for signing in_)
66+
- **Client secret** (see _Create a new application secret_)
6767

6868
### Event Hubs Namespace
6969

@@ -137,13 +137,13 @@ In the Source creation form, give a name to the event source and add the followi
137137
The ID of the Azure subscription which Activity Logs are to be subscribed to is inferred from the **Event Hub ID**
138138
parameter below. Therefore, the form does not require providing a subscription ID explicitly.
139139

140-
* [Secret][sp-create]: Service Principal authentication credentials, as described in the previous sections.
141-
* [Event Hub ID][eventhubs-create]: Resource ID of either
142-
* an Event Hubs _namespace_ (Event Hub managed by Azure, defaults to `insights-activity-logs`)
143-
* an Event Hubs _instance_ (Event Hub managed by the user)
144-
* [SAS Policy][sas-policy]: _(optional)_ Name of a SAS policy with Manage permissions on the Event Hubs namespace
140+
- [Secret][sp-create]: Service Principal authentication credentials, as described in the previous sections.
141+
- [Event Hub ID][eventhubs-create]: Resource ID of either
142+
- an Event Hubs _namespace_ (Event Hub managed by Azure, defaults to `insights-activity-logs`)
143+
- an Event Hubs _instance_ (Event Hub managed by the user)
144+
- [SAS Policy][sas-policy]: _(optional)_ Name of a SAS policy with Manage permissions on the Event Hubs namespace
145145
referenced in the **Event Hub ID** field. Uses Azure's default "RootManageSharedAccessKey" policy if not provided.
146-
* [Log categories][log-categories]: _(optional)_ Categories of Activity Logs to collect. All available categories are
146+
- [Log categories][log-categories]: _(optional)_ Categories of Activity Logs to collect. All available categories are
147147
selected when the list of categories is left empty.
148148

149149
![Azure Activity Logs source form](../images/azureactivitylogs-source/create-bridge-2.png)
@@ -168,7 +168,7 @@ within the Azure Subscription.
168168

169169
The Azure Activity Logs event source emits events of the following type:
170170

171-
* `com.microsoft.azure.monitor.activity-log`
171+
- `com.microsoft.azure.monitor.activity-log`
172172

173173
[activity-logs]: https://docs.microsoft.com/en-us/azure/azure-monitor/platform/activity-log
174174
[diag-settings]: https://docs.microsoft.com/en-us/azure/azure-monitor/platform/diagnostic-settings

0 commit comments

Comments
 (0)