Skip to content

Commit a0eda25

Browse files
author
awstools
committed
feat(client-pipes): This release adds support for customer managed KMS keys in Amazon EventBridge Pipe
1 parent 968260e commit a0eda25

File tree

6 files changed

+73
-37
lines changed

6 files changed

+73
-37
lines changed

Diff for: ‎clients/client-pipes/src/commands/CreatePipeCommand.ts

+1
Original file line numberDiff line numberDiff line change
@@ -389,6 +389,7 @@ export interface CreatePipeCommandOutput extends CreatePipeResponse, __MetadataB
389389
* "STRING_VALUE",
390390
* ],
391391
* },
392+
* KmsKeyIdentifier: "STRING_VALUE",
392393
* };
393394
* const command = new CreatePipeCommand(input);
394395
* const response = await client.send(command);

Diff for: ‎clients/client-pipes/src/commands/DescribePipeCommand.ts

+1
Original file line numberDiff line numberDiff line change
@@ -398,6 +398,7 @@ export interface DescribePipeCommandOutput extends DescribePipeResponse, __Metad
398398
* // "STRING_VALUE",
399399
* // ],
400400
* // },
401+
* // KmsKeyIdentifier: "STRING_VALUE",
401402
* // };
402403
*
403404
* ```

Diff for: ‎clients/client-pipes/src/commands/UpdatePipeCommand.ts

+1
Original file line numberDiff line numberDiff line change
@@ -380,6 +380,7 @@ export interface UpdatePipeCommandOutput extends UpdatePipeResponse, __MetadataB
380380
* "STRING_VALUE",
381381
* ],
382382
* },
383+
* KmsKeyIdentifier: "STRING_VALUE",
383384
* };
384385
* const command = new UpdatePipeCommand(input);
385386
* const response = await client.send(command);

Diff for: ‎clients/client-pipes/src/models/models_0.ts

+36-34
Original file line numberDiff line numberDiff line change
@@ -620,22 +620,7 @@ export interface S3LogDestinationParameters {
620620

621621
/**
622622
* <p>How EventBridge should format the log records.</p>
623-
* <ul>
624-
* <li>
625-
* <p>
626-
* <code>json</code>: JSON </p>
627-
* </li>
628-
* <li>
629-
* <p>
630-
* <code>plain</code>: Plain text</p>
631-
* </li>
632-
* <li>
633-
* <p>
634-
* <code>w3c</code>: <a href="https://www.w3.org/TR/WD-logfile">W3C extended
635-
* logging file format</a>
636-
* </p>
637-
* </li>
638-
* </ul>
623+
* <p>EventBridge currently only supports <code>json</code> formatting.</p>
639624
* @public
640625
*/
641626
OutputFormat?: S3OutputFormat;
@@ -1260,8 +1245,7 @@ export interface SelfManagedKafkaAccessConfigurationVpc {
12601245

12611246
/**
12621247
* <p>Specifies the security groups associated with the stream. These security groups must all
1263-
* be in the same VPC. You can specify as many as five security groups. If you do not specify
1264-
* a security group, the default security group for the VPC is used.</p>
1248+
* be in the same VPC. You can specify as many as five security groups.</p>
12651249
* @public
12661250
*/
12671251
SecurityGroup?: string[];
@@ -2736,6 +2720,18 @@ export interface CreatePipeRequest {
27362720
* @public
27372721
*/
27382722
LogConfiguration?: PipeLogConfigurationParameters;
2723+
2724+
/**
2725+
* <p>The identifier of the KMS
2726+
* customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt pipe data. The identifier can be the key
2727+
* Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.</p>
2728+
* <p>If you do not specify a customer managed key identifier, EventBridge uses an
2729+
* Amazon Web Services owned key to encrypt pipe data.</p>
2730+
* <p>For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/getting-started.html">Managing keys</a> in the <i>Key Management Service
2731+
* Developer Guide</i>. </p>
2732+
* @public
2733+
*/
2734+
KmsKeyIdentifier?: string;
27392735
}
27402736

27412737
/**
@@ -3109,22 +3105,7 @@ export interface S3LogDestination {
31093105

31103106
/**
31113107
* <p>The format EventBridge uses for the log records.</p>
3112-
* <ul>
3113-
* <li>
3114-
* <p>
3115-
* <code>json</code>: JSON </p>
3116-
* </li>
3117-
* <li>
3118-
* <p>
3119-
* <code>plain</code>: Plain text</p>
3120-
* </li>
3121-
* <li>
3122-
* <p>
3123-
* <code>w3c</code>: <a href="https://www.w3.org/TR/WD-logfile">W3C extended
3124-
* logging file format</a>
3125-
* </p>
3126-
* </li>
3127-
* </ul>
3108+
* <p>EventBridge currently only supports <code>json</code> formatting.</p>
31283109
* @public
31293110
*/
31303111
OutputFormat?: S3OutputFormat;
@@ -3277,6 +3258,14 @@ export interface DescribePipeResponse {
32773258
* @public
32783259
*/
32793260
LogConfiguration?: PipeLogConfiguration;
3261+
3262+
/**
3263+
* <p>The identifier of the KMS
3264+
* customer managed key for EventBridge to use to encrypt pipe data, if one has been specified.</p>
3265+
* <p>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>
3266+
* @public
3267+
*/
3268+
KmsKeyIdentifier?: string;
32803269
}
32813270

32823271
/**
@@ -3899,6 +3888,19 @@ export interface UpdatePipeRequest {
38993888
* @public
39003889
*/
39013890
LogConfiguration?: PipeLogConfigurationParameters;
3891+
3892+
/**
3893+
* <p>The identifier of the KMS
3894+
* customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt pipe data. The identifier can be the key
3895+
* Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.</p>
3896+
* <p>To update a pipe that is using the default Amazon Web Services owned key to use a customer managed key instead, or update a pipe that is using a customer managed key to use a
3897+
* different customer managed key, specify a customer managed key identifier.</p>
3898+
* <p>To update a pipe that is using a customer managed key to use the default Amazon Web Services owned key, specify an empty string.</p>
3899+
* <p>For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/getting-started.html">Managing keys</a> in the <i>Key Management Service
3900+
* Developer Guide</i>. </p>
3901+
* @public
3902+
*/
3903+
KmsKeyIdentifier?: string;
39023904
}
39033905

39043906
/**

Diff for: ‎clients/client-pipes/src/protocols/Aws_restJson1.ts

+3
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,7 @@ export const se_CreatePipeCommand = async (
136136
DesiredState: [],
137137
Enrichment: [],
138138
EnrichmentParameters: (_) => _json(_),
139+
KmsKeyIdentifier: [],
139140
LogConfiguration: (_) => _json(_),
140141
RoleArn: [],
141142
Source: [],
@@ -318,6 +319,7 @@ export const se_UpdatePipeCommand = async (
318319
DesiredState: [],
319320
Enrichment: [],
320321
EnrichmentParameters: (_) => _json(_),
322+
KmsKeyIdentifier: [],
321323
LogConfiguration: (_) => _json(_),
322324
RoleArn: [],
323325
SourceParameters: (_) => _json(_),
@@ -403,6 +405,7 @@ export const de_DescribePipeCommand = async (
403405
DesiredState: __expectString,
404406
Enrichment: __expectString,
405407
EnrichmentParameters: _json,
408+
KmsKeyIdentifier: __expectString,
406409
LastModifiedTime: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
407410
LogConfiguration: _json,
408411
Name: __expectString,

Diff for: ‎codegen/sdk-codegen/aws-models/pipes.json

+31-3
Original file line numberDiff line numberDiff line change
@@ -547,6 +547,12 @@
547547
"aws.cloudformation#cfnMutability": "write",
548548
"smithy.api#documentation": "<p>The logging configuration settings for the pipe.</p>"
549549
}
550+
},
551+
"KmsKeyIdentifier": {
552+
"target": "com.amazonaws.pipes#KmsKeyIdentifier",
553+
"traits": {
554+
"smithy.api#documentation": "<p>The identifier of the KMS\n customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt pipe data. The identifier can be the key \n Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.</p>\n <p>If you do not specify a customer managed key identifier, EventBridge uses an\n Amazon Web Services owned key to encrypt pipe data.</p>\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/getting-started.html\">Managing keys</a> in the <i>Key Management Service\n Developer Guide</i>. </p>"
555+
}
550556
}
551557
},
552558
"traits": {
@@ -887,6 +893,12 @@
887893
"aws.cloudformation#cfnMutability": "read",
888894
"smithy.api#documentation": "<p>The logging configuration settings for the pipe.</p>"
889895
}
896+
},
897+
"KmsKeyIdentifier": {
898+
"target": "com.amazonaws.pipes#KmsKeyIdentifier",
899+
"traits": {
900+
"smithy.api#documentation": "<p>The identifier of the KMS\n customer managed key for EventBridge to use to encrypt pipe data, if one has been specified.</p>\n <p>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>"
901+
}
890902
}
891903
},
892904
"traits": {
@@ -1563,6 +1575,16 @@
15631575
]
15641576
}
15651577
},
1578+
"com.amazonaws.pipes#KmsKeyIdentifier": {
1579+
"type": "string",
1580+
"traits": {
1581+
"smithy.api#length": {
1582+
"min": 0,
1583+
"max": 2048
1584+
},
1585+
"smithy.api#pattern": "^[a-zA-Z0-9_\\-/:]*$"
1586+
}
1587+
},
15661588
"com.amazonaws.pipes#LaunchType": {
15671589
"type": "string",
15681590
"traits": {
@@ -4383,7 +4405,7 @@
43834405
"OutputFormat": {
43844406
"target": "com.amazonaws.pipes#S3OutputFormat",
43854407
"traits": {
4386-
"smithy.api#documentation": "<p>The format EventBridge uses for the log records.</p>\n <ul>\n <li>\n <p>\n <code>json</code>: JSON </p>\n </li>\n <li>\n <p>\n <code>plain</code>: Plain text</p>\n </li>\n <li>\n <p>\n <code>w3c</code>: <a href=\"https://www.w3.org/TR/WD-logfile\">W3C extended\n logging file format</a>\n </p>\n </li>\n </ul>"
4408+
"smithy.api#documentation": "<p>The format EventBridge uses for the log records.</p>\n <p>EventBridge currently only supports <code>json</code> formatting.</p>"
43874409
}
43884410
}
43894411
},
@@ -4416,7 +4438,7 @@
44164438
"OutputFormat": {
44174439
"target": "com.amazonaws.pipes#S3OutputFormat",
44184440
"traits": {
4419-
"smithy.api#documentation": "<p>How EventBridge should format the log records.</p>\n <ul>\n <li>\n <p>\n <code>json</code>: JSON </p>\n </li>\n <li>\n <p>\n <code>plain</code>: Plain text</p>\n </li>\n <li>\n <p>\n <code>w3c</code>: <a href=\"https://www.w3.org/TR/WD-logfile\">W3C extended\n logging file format</a>\n </p>\n </li>\n </ul>"
4441+
"smithy.api#documentation": "<p>How EventBridge should format the log records.</p>\n <p>EventBridge currently only supports <code>json</code> formatting.</p>"
44204442
}
44214443
},
44224444
"Prefix": {
@@ -4620,7 +4642,7 @@
46204642
"SecurityGroup": {
46214643
"target": "com.amazonaws.pipes#SecurityGroupIds",
46224644
"traits": {
4623-
"smithy.api#documentation": "<p>Specifies the security groups associated with the stream. These security groups must all\n be in the same VPC. You can specify as many as five security groups. If you do not specify\n a security group, the default security group for the VPC is used.</p>"
4645+
"smithy.api#documentation": "<p>Specifies the security groups associated with the stream. These security groups must all\n be in the same VPC. You can specify as many as five security groups.</p>"
46244646
}
46254647
}
46264648
},
@@ -5402,6 +5424,12 @@
54025424
"aws.cloudformation#cfnMutability": "write",
54035425
"smithy.api#documentation": "<p>The logging configuration settings for the pipe.</p>"
54045426
}
5427+
},
5428+
"KmsKeyIdentifier": {
5429+
"target": "com.amazonaws.pipes#KmsKeyIdentifier",
5430+
"traits": {
5431+
"smithy.api#documentation": "<p>The identifier of the KMS\n customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt pipe data. The identifier can be the key \n Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.</p>\n <p>To update a pipe that is using the default Amazon Web Services owned key to use a customer managed key instead, or update a pipe that is using a customer managed key to use a\n different customer managed key, specify a customer managed key identifier.</p>\n <p>To update a pipe that is using a customer managed key to use the default Amazon Web Services owned key, specify an empty string.</p>\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/getting-started.html\">Managing keys</a> in the <i>Key Management Service\n Developer Guide</i>. </p>"
5432+
}
54055433
}
54065434
},
54075435
"traits": {

0 commit comments

Comments
 (0)