@aws-cdk/aws-pipes-sources-alpha 2.160.0-alpha.0 → 2.161.0-alpha.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/.jsii CHANGED
@@ -8,8 +8,8 @@
8
8
  "url": "https://aws.amazon.com"
9
9
  },
10
10
  "dependencies": {
11
- "@aws-cdk/aws-pipes-alpha": "2.160.0-alpha.0",
12
- "aws-cdk-lib": "^2.160.0",
11
+ "@aws-cdk/aws-pipes-alpha": "2.161.0-alpha.0",
12
+ "aws-cdk-lib": "^2.161.0",
13
13
  "constructs": "^10.0.0"
14
14
  },
15
15
  "dependencyClosure": {
@@ -3914,7 +3914,7 @@
3914
3914
  },
3915
3915
  "name": "@aws-cdk/aws-pipes-sources-alpha",
3916
3916
  "readme": {
3917
- "markdown": "# Amazon EventBridge Pipes Sources Construct Library\n\n<!--BEGIN STABILITY BANNER-->\n\n---\n\n![cdk-constructs: Experimental](https://img.shields.io/badge/cdk--constructs-experimental-important.svg?style=for-the-badge)\n\n> The APIs of higher level constructs in this module are experimental and under active development.\n> They are subject to non-backward compatible changes or removal in any future version. These are\n> not subject to the [Semantic Versioning](https://semver.org/) model and breaking changes will be\n> announced in the release notes. This means that while you may use them, you may need to update\n> your source code when upgrading to a newer version of this package.\n\n---\n\n<!--END STABILITY BANNER-->\n\n\nEventBridge Pipes Sources let you create a source for a EventBridge Pipe.\n\n\nFor more details see the service documentation:\n\n[Documentation](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-source.html)\n\n## Pipe sources\n\nPipe sources are the starting point of a EventBridge Pipe. They are the source of the events that are sent to the pipe.\n\n### Amazon SQS\n\nA SQS message queue can be used as a source for a pipe. The queue will be polled for new messages and the messages will be sent to the pipe.\n\n```ts\ndeclare const sourceQueue: sqs.Queue;\ndeclare const targetQueue: sqs.Queue;\n\nconst pipeSource = new sources.SqsSource(sourceQueue);\n\nconst pipe = new pipes.Pipe(this, 'Pipe', {\n source: pipeSource,\n target: new SomeTarget(targetQueue)\n});\n```\n\nThe polling configuration can be customized:\n\n```ts\ndeclare const sourceQueue: sqs.Queue;\ndeclare const targetQueue: sqs.Queue;\n\nconst pipeSource = new sources.SqsSource(sourceQueue, {\n batchSize: 10,\n maximumBatchingWindow: cdk.Duration.seconds(10)\n});\n\nconst pipe = new pipes.Pipe(this, 'Pipe', {\n source: pipeSource,\n target: new SomeTarget(targetQueue)\n});\n```\n\n"
3917
+ "markdown": "# Amazon EventBridge Pipes Sources Construct Library\n\n<!--BEGIN STABILITY BANNER-->\n\n---\n\n![cdk-constructs: Experimental](https://img.shields.io/badge/cdk--constructs-experimental-important.svg?style=for-the-badge)\n\n> The APIs of higher level constructs in this module are experimental and under active development.\n> They are subject to non-backward compatible changes or removal in any future version. These are\n> not subject to the [Semantic Versioning](https://semver.org/) model and breaking changes will be\n> announced in the release notes. This means that while you may use them, you may need to update\n> your source code when upgrading to a newer version of this package.\n\n---\n\n<!--END STABILITY BANNER-->\n\n\nEventBridge Pipes Sources let you create a source for a EventBridge Pipe.\n\n\nFor more details see the service documentation:\n\n[Documentation](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-source.html)\n\n## Pipe sources\n\nPipe sources are the starting point of a EventBridge Pipe. They are the source of the events that are sent to the pipe.\n\n### Amazon SQS\n\nA SQS message queue can be used as a source for a pipe. The queue will be polled for new messages and the messages will be sent to the pipe.\n\n```ts\ndeclare const sourceQueue: sqs.Queue;\ndeclare const targetQueue: sqs.Queue;\n\nconst pipeSource = new sources.SqsSource(sourceQueue);\n\nconst pipe = new pipes.Pipe(this, 'Pipe', {\n source: pipeSource,\n target: new SomeTarget(targetQueue)\n});\n```\n\nThe polling configuration can be customized:\n\n```ts\ndeclare const sourceQueue: sqs.Queue;\ndeclare const targetQueue: sqs.Queue;\n\nconst pipeSource = new sources.SqsSource(sourceQueue, {\n batchSize: 10,\n maximumBatchingWindow: cdk.Duration.seconds(10)\n});\n\nconst pipe = new pipes.Pipe(this, 'Pipe', {\n source: pipeSource,\n target: new SomeTarget(targetQueue)\n});\n```\n\n### Amazon Kinesis\n\nA Kinesis stream can be used as a source for a pipe. The stream will be polled for new messages and the messages will be sent to the pipe.\n\n```ts\ndeclare const sourceStream: kinesis.Stream;\ndeclare const targetQueue: sqs.Queue;\n\nconst pipeSource = new sources.KinesisSource(sourceStream, {\n startingPosition: sources.KinesisStartingPosition.LATEST,\n});\n\nconst pipe = new pipes.Pipe(this, 'Pipe', {\n source: pipeSource,\n target: new SomeTarget(targetQueue)\n});\n```\n\n### Amazon DynamoDB\n\nA DynamoDB stream can be used as a source for a pipe. The stream will be polled for new messages and the messages will be sent to the pipe.\n\n```ts\nconst table = new ddb.TableV2(this, 'MyTable', {\n partitionKey: {\n name: 'id',\n type: ddb.AttributeType.STRING,\n },\n dynamoStream: ddb.StreamViewType.NEW_IMAGE,\n});\ndeclare const targetQueue: sqs.Queue;\n\nconst pipeSource = new sources.DynamoDBSource(table, {\n startingPosition: sources.DynamoDBStartingPosition.LATEST,\n});\n\nconst pipe = new pipes.Pipe(this, 'Pipe', {\n source: pipeSource,\n target: new SomeTarget(targetQueue)\n});\n```\n"
3918
3918
  },
3919
3919
  "repository": {
3920
3920
  "directory": "packages/@aws-cdk/aws-pipes-sources-alpha",
@@ -3952,12 +3952,397 @@
3952
3952
  }
3953
3953
  },
3954
3954
  "types": {
3955
+ "@aws-cdk/aws-pipes-sources-alpha.DynamoDBSource": {
3956
+ "assembly": "@aws-cdk/aws-pipes-sources-alpha",
3957
+ "base": "@aws-cdk/aws-pipes-sources-alpha.StreamSource",
3958
+ "docs": {
3959
+ "stability": "experimental",
3960
+ "summary": "A source that reads from an DynamoDB stream.",
3961
+ "example": "const table = new ddb.TableV2(this, 'MyTable', {\n partitionKey: {\n name: 'id',\n type: ddb.AttributeType.STRING,\n },\n dynamoStream: ddb.StreamViewType.NEW_IMAGE,\n});\ndeclare const targetQueue: sqs.Queue;\n\nconst pipeSource = new sources.DynamoDBSource(table, {\n startingPosition: sources.DynamoDBStartingPosition.LATEST,\n});\n\nconst pipe = new pipes.Pipe(this, 'Pipe', {\n source: pipeSource,\n target: new SomeTarget(targetQueue)\n});",
3962
+ "custom": {
3963
+ "exampleMetadata": "infused"
3964
+ }
3965
+ },
3966
+ "fqn": "@aws-cdk/aws-pipes-sources-alpha.DynamoDBSource",
3967
+ "initializer": {
3968
+ "docs": {
3969
+ "stability": "experimental"
3970
+ },
3971
+ "locationInModule": {
3972
+ "filename": "lib/dynamodb.ts",
3973
+ "line": 27
3974
+ },
3975
+ "parameters": [
3976
+ {
3977
+ "name": "table",
3978
+ "type": {
3979
+ "fqn": "aws-cdk-lib.aws_dynamodb.ITableV2"
3980
+ }
3981
+ },
3982
+ {
3983
+ "name": "parameters",
3984
+ "type": {
3985
+ "fqn": "@aws-cdk/aws-pipes-sources-alpha.DynamoDBSourceParameters"
3986
+ }
3987
+ }
3988
+ ]
3989
+ },
3990
+ "kind": "class",
3991
+ "locationInModule": {
3992
+ "filename": "lib/dynamodb.ts",
3993
+ "line": 22
3994
+ },
3995
+ "methods": [
3996
+ {
3997
+ "docs": {
3998
+ "stability": "experimental",
3999
+ "summary": "Bind the source to a pipe."
4000
+ },
4001
+ "locationInModule": {
4002
+ "filename": "lib/dynamodb.ts",
4003
+ "line": 38
4004
+ },
4005
+ "name": "bind",
4006
+ "overrides": "@aws-cdk/aws-pipes-alpha.SourceWithDeadLetterTarget",
4007
+ "parameters": [
4008
+ {
4009
+ "name": "_pipe",
4010
+ "type": {
4011
+ "fqn": "@aws-cdk/aws-pipes-alpha.IPipe"
4012
+ }
4013
+ }
4014
+ ],
4015
+ "returns": {
4016
+ "type": {
4017
+ "fqn": "@aws-cdk/aws-pipes-alpha.SourceConfig"
4018
+ }
4019
+ }
4020
+ },
4021
+ {
4022
+ "docs": {
4023
+ "stability": "experimental",
4024
+ "summary": "Grant the pipe role read access to the source."
4025
+ },
4026
+ "locationInModule": {
4027
+ "filename": "lib/dynamodb.ts",
4028
+ "line": 55
4029
+ },
4030
+ "name": "grantRead",
4031
+ "overrides": "@aws-cdk/aws-pipes-alpha.SourceWithDeadLetterTarget",
4032
+ "parameters": [
4033
+ {
4034
+ "name": "grantee",
4035
+ "type": {
4036
+ "fqn": "aws-cdk-lib.aws_iam.IRole"
4037
+ }
4038
+ }
4039
+ ]
4040
+ }
4041
+ ],
4042
+ "name": "DynamoDBSource",
4043
+ "symbolId": "lib/dynamodb:DynamoDBSource"
4044
+ },
4045
+ "@aws-cdk/aws-pipes-sources-alpha.DynamoDBSourceParameters": {
4046
+ "assembly": "@aws-cdk/aws-pipes-sources-alpha",
4047
+ "datatype": true,
4048
+ "docs": {
4049
+ "stability": "experimental",
4050
+ "summary": "Parameters for the DynamoDB source.",
4051
+ "example": "const table = new ddb.TableV2(this, 'MyTable', {\n partitionKey: {\n name: 'id',\n type: ddb.AttributeType.STRING,\n },\n dynamoStream: ddb.StreamViewType.NEW_IMAGE,\n});\ndeclare const targetQueue: sqs.Queue;\n\nconst pipeSource = new sources.DynamoDBSource(table, {\n startingPosition: sources.DynamoDBStartingPosition.LATEST,\n});\n\nconst pipe = new pipes.Pipe(this, 'Pipe', {\n source: pipeSource,\n target: new SomeTarget(targetQueue)\n});",
4052
+ "custom": {
4053
+ "exampleMetadata": "infused"
4054
+ }
4055
+ },
4056
+ "fqn": "@aws-cdk/aws-pipes-sources-alpha.DynamoDBSourceParameters",
4057
+ "interfaces": [
4058
+ "@aws-cdk/aws-pipes-sources-alpha.StreamSourceParameters"
4059
+ ],
4060
+ "kind": "interface",
4061
+ "locationInModule": {
4062
+ "filename": "lib/dynamodb.ts",
4063
+ "line": 10
4064
+ },
4065
+ "name": "DynamoDBSourceParameters",
4066
+ "properties": [
4067
+ {
4068
+ "abstract": true,
4069
+ "docs": {
4070
+ "see": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcedynamodbstreamparameters.html#cfn-pipes-pipe-pipesourcedynamodbstreamparameters-startingposition",
4071
+ "stability": "experimental",
4072
+ "summary": "The position in a stream from which to start reading."
4073
+ },
4074
+ "immutable": true,
4075
+ "locationInModule": {
4076
+ "filename": "lib/dynamodb.ts",
4077
+ "line": 16
4078
+ },
4079
+ "name": "startingPosition",
4080
+ "type": {
4081
+ "fqn": "@aws-cdk/aws-pipes-sources-alpha.DynamoDBStartingPosition"
4082
+ }
4083
+ }
4084
+ ],
4085
+ "symbolId": "lib/dynamodb:DynamoDBSourceParameters"
4086
+ },
4087
+ "@aws-cdk/aws-pipes-sources-alpha.DynamoDBStartingPosition": {
4088
+ "assembly": "@aws-cdk/aws-pipes-sources-alpha",
4089
+ "docs": {
4090
+ "stability": "experimental",
4091
+ "summary": "The position in a DynamoDB stream from which to start reading.",
4092
+ "example": "const table = new ddb.TableV2(this, 'MyTable', {\n partitionKey: {\n name: 'id',\n type: ddb.AttributeType.STRING,\n },\n dynamoStream: ddb.StreamViewType.NEW_IMAGE,\n});\ndeclare const targetQueue: sqs.Queue;\n\nconst pipeSource = new sources.DynamoDBSource(table, {\n startingPosition: sources.DynamoDBStartingPosition.LATEST,\n});\n\nconst pipe = new pipes.Pipe(this, 'Pipe', {\n source: pipeSource,\n target: new SomeTarget(targetQueue)\n});",
4093
+ "custom": {
4094
+ "exampleMetadata": "infused"
4095
+ }
4096
+ },
4097
+ "fqn": "@aws-cdk/aws-pipes-sources-alpha.DynamoDBStartingPosition",
4098
+ "kind": "enum",
4099
+ "locationInModule": {
4100
+ "filename": "lib/enums.ts",
4101
+ "line": 36
4102
+ },
4103
+ "members": [
4104
+ {
4105
+ "docs": {
4106
+ "stability": "experimental",
4107
+ "summary": "Start reading at the last (untrimmed) stream record, which is the oldest record in the shard."
4108
+ },
4109
+ "name": "TRIM_HORIZON"
4110
+ },
4111
+ {
4112
+ "docs": {
4113
+ "stability": "experimental",
4114
+ "summary": "Start reading just after the most recent stream record in the shard, so that you always read the most recent data in the shard."
4115
+ },
4116
+ "name": "LATEST"
4117
+ }
4118
+ ],
4119
+ "name": "DynamoDBStartingPosition",
4120
+ "symbolId": "lib/enums:DynamoDBStartingPosition"
4121
+ },
4122
+ "@aws-cdk/aws-pipes-sources-alpha.KinesisSource": {
4123
+ "assembly": "@aws-cdk/aws-pipes-sources-alpha",
4124
+ "base": "@aws-cdk/aws-pipes-sources-alpha.StreamSource",
4125
+ "docs": {
4126
+ "stability": "experimental",
4127
+ "summary": "A source that reads from Kinesis.",
4128
+ "example": "declare const sourceStream: kinesis.Stream;\ndeclare const targetQueue: sqs.Queue;\n\nconst pipeSource = new sources.KinesisSource(sourceStream, {\n startingPosition: sources.KinesisStartingPosition.LATEST,\n});\n\nconst pipe = new pipes.Pipe(this, 'Pipe', {\n source: pipeSource,\n target: new SomeTarget(targetQueue)\n});",
4129
+ "custom": {
4130
+ "exampleMetadata": "infused"
4131
+ }
4132
+ },
4133
+ "fqn": "@aws-cdk/aws-pipes-sources-alpha.KinesisSource",
4134
+ "initializer": {
4135
+ "docs": {
4136
+ "stability": "experimental"
4137
+ },
4138
+ "locationInModule": {
4139
+ "filename": "lib/kinesis.ts",
4140
+ "line": 39
4141
+ },
4142
+ "parameters": [
4143
+ {
4144
+ "name": "stream",
4145
+ "type": {
4146
+ "fqn": "aws-cdk-lib.aws_kinesis.IStream"
4147
+ }
4148
+ },
4149
+ {
4150
+ "name": "parameters",
4151
+ "type": {
4152
+ "fqn": "@aws-cdk/aws-pipes-sources-alpha.KinesisSourceParameters"
4153
+ }
4154
+ }
4155
+ ]
4156
+ },
4157
+ "kind": "class",
4158
+ "locationInModule": {
4159
+ "filename": "lib/kinesis.ts",
4160
+ "line": 33
4161
+ },
4162
+ "methods": [
4163
+ {
4164
+ "docs": {
4165
+ "stability": "experimental",
4166
+ "summary": "Bind the source to a pipe."
4167
+ },
4168
+ "locationInModule": {
4169
+ "filename": "lib/kinesis.ts",
4170
+ "line": 51
4171
+ },
4172
+ "name": "bind",
4173
+ "overrides": "@aws-cdk/aws-pipes-alpha.SourceWithDeadLetterTarget",
4174
+ "parameters": [
4175
+ {
4176
+ "name": "_pipe",
4177
+ "type": {
4178
+ "fqn": "@aws-cdk/aws-pipes-alpha.IPipe"
4179
+ }
4180
+ }
4181
+ ],
4182
+ "returns": {
4183
+ "type": {
4184
+ "fqn": "@aws-cdk/aws-pipes-alpha.SourceConfig"
4185
+ }
4186
+ }
4187
+ },
4188
+ {
4189
+ "docs": {
4190
+ "stability": "experimental",
4191
+ "summary": "Grant the pipe role read access to the source."
4192
+ },
4193
+ "locationInModule": {
4194
+ "filename": "lib/kinesis.ts",
4195
+ "line": 69
4196
+ },
4197
+ "name": "grantRead",
4198
+ "overrides": "@aws-cdk/aws-pipes-alpha.SourceWithDeadLetterTarget",
4199
+ "parameters": [
4200
+ {
4201
+ "name": "grantee",
4202
+ "type": {
4203
+ "fqn": "aws-cdk-lib.aws_iam.IRole"
4204
+ }
4205
+ }
4206
+ ]
4207
+ }
4208
+ ],
4209
+ "name": "KinesisSource",
4210
+ "symbolId": "lib/kinesis:KinesisSource"
4211
+ },
4212
+ "@aws-cdk/aws-pipes-sources-alpha.KinesisSourceParameters": {
4213
+ "assembly": "@aws-cdk/aws-pipes-sources-alpha",
4214
+ "datatype": true,
4215
+ "docs": {
4216
+ "stability": "experimental",
4217
+ "summary": "Parameters for the Kinesis source.",
4218
+ "example": "declare const sourceStream: kinesis.Stream;\ndeclare const targetQueue: sqs.Queue;\n\nconst pipeSource = new sources.KinesisSource(sourceStream, {\n startingPosition: sources.KinesisStartingPosition.LATEST,\n});\n\nconst pipe = new pipes.Pipe(this, 'Pipe', {\n source: pipeSource,\n target: new SomeTarget(targetQueue)\n});",
4219
+ "custom": {
4220
+ "exampleMetadata": "infused"
4221
+ }
4222
+ },
4223
+ "fqn": "@aws-cdk/aws-pipes-sources-alpha.KinesisSourceParameters",
4224
+ "interfaces": [
4225
+ "@aws-cdk/aws-pipes-sources-alpha.StreamSourceParameters"
4226
+ ],
4227
+ "kind": "interface",
4228
+ "locationInModule": {
4229
+ "filename": "lib/kinesis.ts",
4230
+ "line": 10
4231
+ },
4232
+ "name": "KinesisSourceParameters",
4233
+ "properties": [
4234
+ {
4235
+ "abstract": true,
4236
+ "docs": {
4237
+ "see": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcekinesisstreamparameters.html#cfn-pipes-pipe-pipesourcekinesisstreamparameters-startingposition",
4238
+ "stability": "experimental",
4239
+ "summary": "The position in a stream from which to start reading."
4240
+ },
4241
+ "immutable": true,
4242
+ "locationInModule": {
4243
+ "filename": "lib/kinesis.ts",
4244
+ "line": 16
4245
+ },
4246
+ "name": "startingPosition",
4247
+ "type": {
4248
+ "fqn": "@aws-cdk/aws-pipes-sources-alpha.KinesisStartingPosition"
4249
+ }
4250
+ },
4251
+ {
4252
+ "abstract": true,
4253
+ "docs": {
4254
+ "default": "- no starting position timestamp",
4255
+ "example": "new Date(Date.UTC(1969, 10, 20, 0, 0, 0))",
4256
+ "see": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcekinesisstreamparameters.html#cfn-pipes-pipe-pipesourcekinesisstreamparameters-startingpositiontimestamp",
4257
+ "stability": "experimental",
4258
+ "summary": "With StartingPosition set to AT_TIMESTAMP, the time from which to start reading, in ISO 8601 format."
4259
+ },
4260
+ "immutable": true,
4261
+ "locationInModule": {
4262
+ "filename": "lib/kinesis.ts",
4263
+ "line": 27
4264
+ },
4265
+ "name": "startingPositionTimestamp",
4266
+ "optional": true,
4267
+ "type": {
4268
+ "primitive": "date"
4269
+ }
4270
+ }
4271
+ ],
4272
+ "symbolId": "lib/kinesis:KinesisSourceParameters"
4273
+ },
4274
+ "@aws-cdk/aws-pipes-sources-alpha.KinesisStartingPosition": {
4275
+ "assembly": "@aws-cdk/aws-pipes-sources-alpha",
4276
+ "docs": {
4277
+ "stability": "experimental",
4278
+ "summary": "The position in a Kinesis stream from which to start reading.",
4279
+ "example": "declare const sourceStream: kinesis.Stream;\ndeclare const targetQueue: sqs.Queue;\n\nconst pipeSource = new sources.KinesisSource(sourceStream, {\n startingPosition: sources.KinesisStartingPosition.LATEST,\n});\n\nconst pipe = new pipes.Pipe(this, 'Pipe', {\n source: pipeSource,\n target: new SomeTarget(targetQueue)\n});",
4280
+ "custom": {
4281
+ "exampleMetadata": "infused"
4282
+ }
4283
+ },
4284
+ "fqn": "@aws-cdk/aws-pipes-sources-alpha.KinesisStartingPosition",
4285
+ "kind": "enum",
4286
+ "locationInModule": {
4287
+ "filename": "lib/enums.ts",
4288
+ "line": 15
4289
+ },
4290
+ "members": [
4291
+ {
4292
+ "docs": {
4293
+ "stability": "experimental",
4294
+ "summary": "Start streaming at the last untrimmed record in the shard, which is the oldest data record in the shard."
4295
+ },
4296
+ "name": "TRIM_HORIZON"
4297
+ },
4298
+ {
4299
+ "docs": {
4300
+ "stability": "experimental",
4301
+ "summary": "Start streaming just after the most recent record in the shard, so that you always read the most recent data in the shard."
4302
+ },
4303
+ "name": "LATEST"
4304
+ },
4305
+ {
4306
+ "docs": {
4307
+ "stability": "experimental",
4308
+ "summary": "Start streaming from the position denoted by the time stamp specified in the `startingPositionTimestamp` field."
4309
+ },
4310
+ "name": "AT_TIMESTAMP"
4311
+ }
4312
+ ],
4313
+ "name": "KinesisStartingPosition",
4314
+ "symbolId": "lib/enums:KinesisStartingPosition"
4315
+ },
4316
+ "@aws-cdk/aws-pipes-sources-alpha.OnPartialBatchItemFailure": {
4317
+ "assembly": "@aws-cdk/aws-pipes-sources-alpha",
4318
+ "docs": {
4319
+ "stability": "experimental",
4320
+ "summary": "Define how to handle item process failures."
4321
+ },
4322
+ "fqn": "@aws-cdk/aws-pipes-sources-alpha.OnPartialBatchItemFailure",
4323
+ "kind": "enum",
4324
+ "locationInModule": {
4325
+ "filename": "lib/enums.ts",
4326
+ "line": 4
4327
+ },
4328
+ "members": [
4329
+ {
4330
+ "docs": {
4331
+ "stability": "experimental",
4332
+ "summary": "EventBridge halves each batch and will retry each half until all the records are processed or there is one failed message left in the batch."
4333
+ },
4334
+ "name": "AUTOMATIC_BISECT"
4335
+ }
4336
+ ],
4337
+ "name": "OnPartialBatchItemFailure",
4338
+ "symbolId": "lib/enums:OnPartialBatchItemFailure"
4339
+ },
3955
4340
  "@aws-cdk/aws-pipes-sources-alpha.SqsSource": {
3956
4341
  "assembly": "@aws-cdk/aws-pipes-sources-alpha",
3957
4342
  "docs": {
3958
4343
  "stability": "experimental",
3959
4344
  "summary": "A source that reads from an SQS queue.",
3960
- "example": "declare const sourceQueue: sqs.Queue;\ndeclare const targetQueue: sqs.Queue;\n\nconst pipeSource = new sources.SqsSource(sourceQueue);\n\nconst pipe = new pipes.Pipe(this, 'Pipe', {\n source: pipeSource,\n target: new SomeTarget(targetQueue)\n});",
4345
+ "example": "declare const sourceQueue: sqs.Queue;\ndeclare const targetStream: kinesis.Stream;\n\nconst streamTarget = new targets.KinesisTarget(targetStream, {\n partitionKey: 'pk',\n});\n\nconst pipe = new pipes.Pipe(this, 'Pipe', {\n source: new SqsSource(sourceQueue),\n target: streamTarget,\n});",
3961
4346
  "custom": {
3962
4347
  "exampleMetadata": "infused"
3963
4348
  }
@@ -4122,8 +4507,252 @@
4122
4507
  }
4123
4508
  ],
4124
4509
  "symbolId": "lib/sqs:SqsSourceParameters"
4510
+ },
4511
+ "@aws-cdk/aws-pipes-sources-alpha.StreamSource": {
4512
+ "abstract": true,
4513
+ "assembly": "@aws-cdk/aws-pipes-sources-alpha",
4514
+ "base": "@aws-cdk/aws-pipes-alpha.SourceWithDeadLetterTarget",
4515
+ "docs": {
4516
+ "stability": "experimental",
4517
+ "summary": "Streaming sources."
4518
+ },
4519
+ "fqn": "@aws-cdk/aws-pipes-sources-alpha.StreamSource",
4520
+ "initializer": {
4521
+ "docs": {
4522
+ "stability": "experimental"
4523
+ },
4524
+ "locationInModule": {
4525
+ "filename": "lib/streamSource.ts",
4526
+ "line": 85
4527
+ },
4528
+ "parameters": [
4529
+ {
4530
+ "docs": {
4531
+ "summary": "The ARN of the source resource."
4532
+ },
4533
+ "name": "sourceArn",
4534
+ "type": {
4535
+ "primitive": "string"
4536
+ }
4537
+ },
4538
+ {
4539
+ "name": "sourceParameters",
4540
+ "type": {
4541
+ "fqn": "@aws-cdk/aws-pipes-sources-alpha.StreamSourceParameters"
4542
+ }
4543
+ }
4544
+ ]
4545
+ },
4546
+ "kind": "class",
4547
+ "locationInModule": {
4548
+ "filename": "lib/streamSource.ts",
4549
+ "line": 75
4550
+ },
4551
+ "name": "StreamSource",
4552
+ "properties": [
4553
+ {
4554
+ "docs": {
4555
+ "stability": "experimental",
4556
+ "summary": "The ARN of the source resource."
4557
+ },
4558
+ "immutable": true,
4559
+ "locationInModule": {
4560
+ "filename": "lib/streamSource.ts",
4561
+ "line": 79
4562
+ },
4563
+ "name": "sourceArn",
4564
+ "overrides": "@aws-cdk/aws-pipes-alpha.SourceWithDeadLetterTarget",
4565
+ "type": {
4566
+ "primitive": "string"
4567
+ }
4568
+ },
4569
+ {
4570
+ "docs": {
4571
+ "stability": "experimental",
4572
+ "summary": "Base parameters for streaming sources."
4573
+ },
4574
+ "immutable": true,
4575
+ "locationInModule": {
4576
+ "filename": "lib/streamSource.ts",
4577
+ "line": 83
4578
+ },
4579
+ "name": "sourceParameters",
4580
+ "type": {
4581
+ "fqn": "@aws-cdk/aws-pipes-sources-alpha.StreamSourceParameters"
4582
+ }
4583
+ }
4584
+ ],
4585
+ "symbolId": "lib/streamSource:StreamSource"
4586
+ },
4587
+ "@aws-cdk/aws-pipes-sources-alpha.StreamSourceParameters": {
4588
+ "assembly": "@aws-cdk/aws-pipes-sources-alpha",
4589
+ "datatype": true,
4590
+ "docs": {
4591
+ "stability": "experimental",
4592
+ "summary": "Base parameters for streaming sources.",
4593
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as pipes_sources_alpha from '@aws-cdk/aws-pipes-sources-alpha';\nimport * as cdk from 'aws-cdk-lib';\nimport { aws_sqs as sqs } from 'aws-cdk-lib';\n\ndeclare const queue: sqs.Queue;\nconst streamSourceParameters: pipes_sources_alpha.StreamSourceParameters = {\n batchSize: 123,\n deadLetterTarget: queue,\n maximumBatchingWindow: cdk.Duration.minutes(30),\n maximumRecordAge: cdk.Duration.minutes(30),\n maximumRetryAttempts: 123,\n onPartialBatchItemFailure: pipes_sources_alpha.OnPartialBatchItemFailure.AUTOMATIC_BISECT,\n parallelizationFactor: 123,\n};",
4594
+ "custom": {
4595
+ "exampleMetadata": "fixture=_generated"
4596
+ }
4597
+ },
4598
+ "fqn": "@aws-cdk/aws-pipes-sources-alpha.StreamSourceParameters",
4599
+ "kind": "interface",
4600
+ "locationInModule": {
4601
+ "filename": "lib/streamSource.ts",
4602
+ "line": 10
4603
+ },
4604
+ "name": "StreamSourceParameters",
4605
+ "properties": [
4606
+ {
4607
+ "abstract": true,
4608
+ "docs": {
4609
+ "default": "1",
4610
+ "see": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcekinesisstreamparameters.html#cfn-pipes-pipe-pipesourcekinesisstreamparameters-batchsize",
4611
+ "stability": "experimental",
4612
+ "summary": "The maximum number of records to include in each batch."
4613
+ },
4614
+ "immutable": true,
4615
+ "locationInModule": {
4616
+ "filename": "lib/streamSource.ts",
4617
+ "line": 17
4618
+ },
4619
+ "name": "batchSize",
4620
+ "optional": true,
4621
+ "type": {
4622
+ "primitive": "number"
4623
+ }
4624
+ },
4625
+ {
4626
+ "abstract": true,
4627
+ "docs": {
4628
+ "default": "- no dead-letter queue or topic",
4629
+ "remarks": "The dead-letter queue stores any events that are not successfully delivered to a Pipes target after all retry attempts are exhausted.\nYou can then resolve the issue that caused the failed invocations and replay the events at a later time.\nIn some cases, such as when access is denied to a resource, events are sent directly to the dead-letter queue and are not retried.",
4630
+ "see": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcekinesisstreamparameters.html#cfn-pipes-pipe-pipesourcekinesisstreamparameters-deadletterconfig",
4631
+ "stability": "experimental",
4632
+ "summary": "Define the target to send dead-letter queue events to."
4633
+ },
4634
+ "immutable": true,
4635
+ "locationInModule": {
4636
+ "filename": "lib/streamSource.ts",
4637
+ "line": 29
4638
+ },
4639
+ "name": "deadLetterTarget",
4640
+ "optional": true,
4641
+ "type": {
4642
+ "union": {
4643
+ "types": [
4644
+ {
4645
+ "fqn": "aws-cdk-lib.aws_sqs.IQueue"
4646
+ },
4647
+ {
4648
+ "fqn": "aws-cdk-lib.aws_sns.ITopic"
4649
+ }
4650
+ ]
4651
+ }
4652
+ }
4653
+ },
4654
+ {
4655
+ "abstract": true,
4656
+ "docs": {
4657
+ "default": "- the events will be handled immediately",
4658
+ "see": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcekinesisstreamparameters.html#cfn-pipes-pipe-pipesourcekinesisstreamparameters-maximumbatchingwindowinseconds",
4659
+ "stability": "experimental",
4660
+ "summary": "The maximum length of a time to wait for events."
4661
+ },
4662
+ "immutable": true,
4663
+ "locationInModule": {
4664
+ "filename": "lib/streamSource.ts",
4665
+ "line": 37
4666
+ },
4667
+ "name": "maximumBatchingWindow",
4668
+ "optional": true,
4669
+ "type": {
4670
+ "fqn": "aws-cdk-lib.Duration"
4671
+ }
4672
+ },
4673
+ {
4674
+ "abstract": true,
4675
+ "docs": {
4676
+ "default": "-1 - EventBridge won't discard old records",
4677
+ "remarks": "The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, EventBridge never discards old records.",
4678
+ "see": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcekinesisstreamparameters.html#cfn-pipes-pipe-pipesourcekinesisstreamparameters-maximumrecordageinseconds",
4679
+ "stability": "experimental",
4680
+ "summary": "Discard records older than the specified age."
4681
+ },
4682
+ "immutable": true,
4683
+ "locationInModule": {
4684
+ "filename": "lib/streamSource.ts",
4685
+ "line": 45
4686
+ },
4687
+ "name": "maximumRecordAge",
4688
+ "optional": true,
4689
+ "type": {
4690
+ "fqn": "aws-cdk-lib.Duration"
4691
+ }
4692
+ },
4693
+ {
4694
+ "abstract": true,
4695
+ "docs": {
4696
+ "default": "-1 - EventBridge will retry failed records until the record expires in the event source",
4697
+ "remarks": "The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source.",
4698
+ "see": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcekinesisstreamparameters.html#cfn-pipes-pipe-pipesourcekinesisstreamparameters-maximumretryattempts",
4699
+ "stability": "experimental",
4700
+ "summary": "Discard records after the specified number of retries."
4701
+ },
4702
+ "immutable": true,
4703
+ "locationInModule": {
4704
+ "filename": "lib/streamSource.ts",
4705
+ "line": 53
4706
+ },
4707
+ "name": "maximumRetryAttempts",
4708
+ "optional": true,
4709
+ "type": {
4710
+ "primitive": "number"
4711
+ }
4712
+ },
4713
+ {
4714
+ "abstract": true,
4715
+ "docs": {
4716
+ "default": "off - EventBridge will retry the entire batch",
4717
+ "remarks": "{@link OnPartialBatchItemFailure.AUTOMATIC_BISECT} halves each batch and will retry each half until all the records are processed or there is one failed message left in the batch.",
4718
+ "see": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcekinesisstreamparameters.html#cfn-pipes-pipe-pipesourcekinesisstreamparameters-onpartialbatchitemfailure",
4719
+ "stability": "experimental",
4720
+ "summary": "Define how to handle item process failures."
4721
+ },
4722
+ "immutable": true,
4723
+ "locationInModule": {
4724
+ "filename": "lib/streamSource.ts",
4725
+ "line": 61
4726
+ },
4727
+ "name": "onPartialBatchItemFailure",
4728
+ "optional": true,
4729
+ "type": {
4730
+ "fqn": "@aws-cdk/aws-pipes-sources-alpha.OnPartialBatchItemFailure"
4731
+ }
4732
+ },
4733
+ {
4734
+ "abstract": true,
4735
+ "docs": {
4736
+ "default": "1",
4737
+ "see": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcekinesisstreamparameters.html#cfn-pipes-pipe-pipesourcekinesisstreamparameters-parallelizationfactor",
4738
+ "stability": "experimental",
4739
+ "summary": "The number of batches to process concurrently from each shard."
4740
+ },
4741
+ "immutable": true,
4742
+ "locationInModule": {
4743
+ "filename": "lib/streamSource.ts",
4744
+ "line": 69
4745
+ },
4746
+ "name": "parallelizationFactor",
4747
+ "optional": true,
4748
+ "type": {
4749
+ "primitive": "number"
4750
+ }
4751
+ }
4752
+ ],
4753
+ "symbolId": "lib/streamSource:StreamSourceParameters"
4125
4754
  }
4126
4755
  },
4127
- "version": "2.160.0-alpha.0",
4756
+ "version": "2.161.0-alpha.0",
4128
4757
  "fingerprint": "**********"
4129
4758
  }