Skip to content

Commit ef8bd0e

Browse files
author
awstools
committed
feat(client-eventbridge): Amazon EventBridge adds support for customer-managed keys on Archives and validations for two fields: eventSourceArn and kmsKeyIdentifier.
1 parent 18df102 commit ef8bd0e

File tree

9 files changed

+158
-117
lines changed

9 files changed

+158
-117
lines changed

clients/client-eventbridge/src/commands/CreateArchiveCommand.ts

Lines changed: 6 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -33,29 +33,11 @@ export interface CreateArchiveCommandOutput extends CreateArchiveResponse, __Met
3333
* time for changes to take effect. If you do not specify a pattern to filter events sent to the
3434
* archive, all events are sent to the archive except replayed events. Replayed events are not
3535
* sent to an archive.</p>
36-
* <note>
37-
* <p>Archives and schema discovery are not supported for event buses encrypted using a
38-
* customer managed key. EventBridge returns an error if:</p>
39-
* <ul>
40-
* <li>
41-
* <p>You call <code>
42-
* <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_CreateArchive.html">CreateArchive</a>
43-
* </code> on an event bus set to use a customer managed key for encryption.</p>
44-
* </li>
45-
* <li>
46-
* <p>You call <code>
47-
* <a href="https://docs.aws.amazon.com/eventbridge/latest/schema-reference/v1-discoverers.html#CreateDiscoverer">CreateDiscoverer</a>
48-
* </code> on an event bus set to use a customer managed key for encryption.</p>
49-
* </li>
50-
* <li>
51-
* <p>You call <code>
52-
* <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_UpdatedEventBus.html">UpdatedEventBus</a>
53-
* </code> to set a customer managed key on an event bus with an archives or schema discovery enabled.</p>
54-
* </li>
55-
* </ul>
56-
* <p>To enable archives or schema discovery on an event bus, choose to
57-
* use an Amazon Web Services owned key. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-encryption.html">Data encryption in EventBridge</a> in the <i>Amazon EventBridge User Guide</i>.</p>
58-
* </note>
36+
* <important>
37+
* <p>If you have specified that EventBridge use a customer managed key for encrypting the source event bus, we strongly recommend you also specify a
38+
* customer managed key for any archives for the event bus as well. </p>
39+
* <p>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/encryption-archives.html">Encrypting archives</a> in the <i>Amazon EventBridge User Guide</i>.</p>
40+
* </important>
5941
* @example
6042
* Use a bare-bones client and the command you need to make an API call.
6143
* ```javascript
@@ -68,6 +50,7 @@ export interface CreateArchiveCommandOutput extends CreateArchiveResponse, __Met
6850
* Description: "STRING_VALUE",
6951
* EventPattern: "STRING_VALUE",
7052
* RetentionDays: Number("int"),
53+
* KmsKeyIdentifier: "STRING_VALUE",
7154
* };
7255
* const command = new CreateArchiveCommand(input);
7356
* const response = await client.send(command);

clients/client-eventbridge/src/commands/CreateConnectionCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ export interface CreateConnectionCommandOutput extends CreateConnectionResponse,
138138
* @see {@link EventBridgeClientResolvedConfig | config} for EventBridgeClient's `config` shape.
139139
*
140140
* @throws {@link AccessDeniedException} (client fault)
141-
* <p>You do not have the necessary permissons for this action.</p>
141+
* <p>You do not have the necessary permissions for this action.</p>
142142
*
143143
* @throws {@link InternalException} (server fault)
144144
* <p>This exception occurs due to unexpected causes.</p>

clients/client-eventbridge/src/commands/DescribeArchiveCommand.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ export interface DescribeArchiveCommandOutput extends DescribeArchiveResponse, _
4848
* // EventPattern: "STRING_VALUE",
4949
* // State: "ENABLED" || "DISABLED" || "CREATING" || "UPDATING" || "CREATE_FAILED" || "UPDATE_FAILED",
5050
* // StateReason: "STRING_VALUE",
51+
* // KmsKeyIdentifier: "STRING_VALUE",
5152
* // RetentionDays: Number("int"),
5253
* // SizeBytes: Number("long"),
5354
* // EventCount: Number("long"),

clients/client-eventbridge/src/commands/PutEventsCommand.ts

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,12 @@ export interface PutEventsCommandOutput extends PutEventsResponse, __MetadataBea
2929

3030
/**
3131
* <p>Sends custom events to Amazon EventBridge so that they can be matched to rules.</p>
32-
* <p>The maximum size for a PutEvents event entry is 256 KB. Entry size is calculated including
33-
* the event and any necessary characters and keys of the JSON representation of the event. To
34-
* learn more, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-putevent-size.html">Calculating PutEvents event entry
32+
* <p>You can batch multiple event entries into one request for efficiency.
33+
* However, the total entry size must be less than 256KB. You can calculate the entry size before you send the events.
34+
* For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-putevents.html#eb-putevent-size">Calculating PutEvents event entry
3535
* size</a> in the <i>
3636
* <i>Amazon EventBridge User Guide</i>
37-
* </i>
38-
* </p>
37+
* </i>.</p>
3938
* <p>PutEvents accepts the data in JSON format. For the JSON number (integer) data type, the
4039
* constraints are: a minimum value of -9,223,372,036,854,775,808 and a maximum value of
4140
* 9,223,372,036,854,775,807.</p>

clients/client-eventbridge/src/commands/UpdateArchiveCommand.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ export interface UpdateArchiveCommandOutput extends UpdateArchiveResponse, __Met
4040
* Description: "STRING_VALUE",
4141
* EventPattern: "STRING_VALUE",
4242
* RetentionDays: Number("int"),
43+
* KmsKeyIdentifier: "STRING_VALUE",
4344
* };
4445
* const command = new UpdateArchiveCommand(input);
4546
* const response = await client.send(command);

clients/client-eventbridge/src/commands/UpdateConnectionCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ export interface UpdateConnectionCommandOutput extends UpdateConnectionResponse,
137137
* @see {@link EventBridgeClientResolvedConfig | config} for EventBridgeClient's `config` shape.
138138
*
139139
* @throws {@link AccessDeniedException} (client fault)
140-
* <p>You do not have the necessary permissons for this action.</p>
140+
* <p>You do not have the necessary permissions for this action.</p>
141141
*
142142
* @throws {@link ConcurrentModificationException} (client fault)
143143
* <p>There is concurrent modification on a rule, target, archive, or replay.</p>

0 commit comments

Comments
 (0)