@aws-cdk/aws-ivs-alpha 2.165.0-alpha.0 → 2.167.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,7 +8,7 @@
8
8
  "url": "https://aws.amazon.com"
9
9
  },
10
10
  "dependencies": {
11
- "aws-cdk-lib": "^2.165.0",
11
+ "aws-cdk-lib": "^2.167.0",
12
12
  "constructs": "^10.0.0"
13
13
  },
14
14
  "dependencyClosure": {
@@ -3861,7 +3861,7 @@
3861
3861
  "stability": "experimental"
3862
3862
  },
3863
3863
  "homepage": "https://github.com/aws/aws-cdk",
3864
- "jsiiVersion": "5.4.36 (build 0893030)",
3864
+ "jsiiVersion": "5.5.8 (build 06b640f)",
3865
3865
  "keywords": [
3866
3866
  "aws",
3867
3867
  "cdk",
@@ -3884,7 +3884,7 @@
3884
3884
  },
3885
3885
  "name": "@aws-cdk/aws-ivs-alpha",
3886
3886
  "readme": {
3887
- "markdown": "# AWS::IVS Construct Library\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\nAmazon Interactive Video Service (Amazon IVS) is a managed live streaming\nsolution that is quick and easy to set up, and ideal for creating interactive\nvideo experiences. Send your live streams to Amazon IVS using streaming software\nand the service does everything you need to make low-latency live video\navailable to any viewer around the world, letting you focus on building\ninteractive experiences alongside the live video. You can easily customize and\nenhance the audience experience through the Amazon IVS player SDK and timed\nmetadata APIs, allowing you to build a more valuable relationship with your\nviewers on your own websites and applications.\n\nThis module is part of the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) project.\n\n## Channels\n\nAn Amazon IVS channel stores configuration information related to your live\nstream. You first create a channel and then contribute video to it using the\nchannel’s stream key to start your live stream.\n\nYou can create a channel\n\n```ts\nconst myChannel = new ivs.Channel(this, 'Channel');\n```\n\nYou can use Advanced Channel type by setting the `type` property to\n`ivs.ChannelType.ADVANCED_HD` or `ivs.ChannelType.ADVANCED_SD`.\n\nAdditionally, when using the Advanced Channel type, you can set\nthe `preset` property to `ivs.Preset.CONSTRAINED_BANDWIDTH_DELIVERY`\nor `ivs.Preset.HIGHER_BANDWIDTH_DELIVERY`.\n\nFor more information, see [Amazon IVS Streaming Configuration](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/streaming-config.html).\n\n```ts\nconst myChannel = new ivs.Channel(this, 'myChannel', {\n type: ivs.ChannelType.ADVANCED_HD,\n preset: ivs.Preset.CONSTRAINED_BANDWIDTH_DELIVERY,\n});\n```\n\nIf you want to use RTMP ingest, set `insecureIngest` property to `true`.\nBy default, `insecureIngest` is `false` which means using RTMPS ingest.\n\n**⚠ Note:** RTMP ingest might result in reduced security for your streams. AWS recommends that you use RTMPS for ingest, unless you have specific and verified use cases. For more information, see [Encoder Settings](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/streaming-config.html#streaming-config-settings).\n\n```ts\nconst myRtmpChannel = new ivs.Channel(this, 'myRtmpChannel', {\n type: ivs.ChannelType.STANDARD,\n insecureIngest: true, // default value is false\n});\n```\n\n### Importing an existing channel\n\nYou can reference an existing channel, for example, if you need to create a\nstream key for an existing channel\n\n```ts\nconst myChannel = ivs.Channel.fromChannelArn(this, 'Channel', myChannelArn);\n```\n\n## Stream Keys\n\nA Stream Key is used by a broadcast encoder to initiate a stream and identify\nto Amazon IVS which customer and channel the stream is for. If you are\nstoring this value, it should be treated as if it were a password.\n\nYou can create a stream key for a given channel\n\n```ts fixture=with-channel\nconst myStreamKey = myChannel.addStreamKey('StreamKey');\n```\n\n## Private Channels\n\nAmazon IVS offers the ability to create private channels, allowing\nyou to restrict your streams by channel or viewer. You control access\nto video playback by enabling playback authorization on channels and\ngenerating signed JSON Web Tokens (JWTs) for authorized playback requests.\n\nA playback token is a JWT that you sign (with a playback authorization key)\nand include with every playback request for a channel that has playback\nauthorization enabled.\n\nIn order for Amazon IVS to validate the token, you need to upload\nthe public key that corresponds to the private key you use to sign the token.\n\n```ts\nconst keyPair = new ivs.PlaybackKeyPair(this, 'PlaybackKeyPair', {\n publicKeyMaterial: myPublicKeyPemString,\n});\n```\n\nThen, when creating a channel, specify the authorized property\n\n```ts\nconst myChannel = new ivs.Channel(this, 'Channel', {\n authorized: true, // default value is false\n});\n```\n"
3887
+ "markdown": "# AWS::IVS Construct Library\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\nAmazon Interactive Video Service (Amazon IVS) is a managed live streaming\nsolution that is quick and easy to set up, and ideal for creating interactive\nvideo experiences. Send your live streams to Amazon IVS using streaming software\nand the service does everything you need to make low-latency live video\navailable to any viewer around the world, letting you focus on building\ninteractive experiences alongside the live video. You can easily customize and\nenhance the audience experience through the Amazon IVS player SDK and timed\nmetadata APIs, allowing you to build a more valuable relationship with your\nviewers on your own websites and applications.\n\nThis module is part of the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) project.\n\n## Channels\n\nAn Amazon IVS channel stores configuration information related to your live\nstream. You first create a channel and then contribute video to it using the\nchannel’s stream key to start your live stream.\n\nYou can create a channel\n\n```ts\nconst myChannel = new ivs.Channel(this, 'Channel');\n```\n\nYou can use Advanced Channel type by setting the `type` property to\n`ivs.ChannelType.ADVANCED_HD` or `ivs.ChannelType.ADVANCED_SD`.\n\nAdditionally, when using the Advanced Channel type, you can set\nthe `preset` property to `ivs.Preset.CONSTRAINED_BANDWIDTH_DELIVERY`\nor `ivs.Preset.HIGHER_BANDWIDTH_DELIVERY`.\n\nFor more information, see [Amazon IVS Streaming Configuration](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/streaming-config.html).\n\n```ts\nconst myChannel = new ivs.Channel(this, 'myChannel', {\n type: ivs.ChannelType.ADVANCED_HD,\n preset: ivs.Preset.CONSTRAINED_BANDWIDTH_DELIVERY,\n});\n```\n\nIf you want to use RTMP ingest, set `insecureIngest` property to `true`.\nBy default, `insecureIngest` is `false` which means using RTMPS ingest.\n\n**⚠ Note:** RTMP ingest might result in reduced security for your streams. AWS recommends that you use RTMPS for ingest, unless you have specific and verified use cases. For more information, see [Encoder Settings](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/streaming-config.html#streaming-config-settings).\n\n```ts\nconst myRtmpChannel = new ivs.Channel(this, 'myRtmpChannel', {\n type: ivs.ChannelType.STANDARD,\n insecureIngest: true, // default value is false\n});\n```\n\n### Importing an existing channel\n\nYou can reference an existing channel, for example, if you need to create a\nstream key for an existing channel\n\n```ts\nconst myChannel = ivs.Channel.fromChannelArn(this, 'Channel', myChannelArn);\n```\n\n## Stream Keys\n\nA Stream Key is used by a broadcast encoder to initiate a stream and identify\nto Amazon IVS which customer and channel the stream is for. If you are\nstoring this value, it should be treated as if it were a password.\n\nYou can create a stream key for a given channel\n\n```ts fixture=with-channel\nconst myStreamKey = myChannel.addStreamKey('StreamKey');\n```\n\n## Private Channels\n\nAmazon IVS offers the ability to create private channels, allowing\nyou to restrict your streams by channel or viewer. You control access\nto video playback by enabling playback authorization on channels and\ngenerating signed JSON Web Tokens (JWTs) for authorized playback requests.\n\nA playback token is a JWT that you sign (with a playback authorization key)\nand include with every playback request for a channel that has playback\nauthorization enabled.\n\nIn order for Amazon IVS to validate the token, you need to upload\nthe public key that corresponds to the private key you use to sign the token.\n\n```ts\nconst keyPair = new ivs.PlaybackKeyPair(this, 'PlaybackKeyPair', {\n publicKeyMaterial: myPublicKeyPemString,\n});\n```\n\nThen, when creating a channel, specify the authorized property\n\n```ts\nconst myChannel = new ivs.Channel(this, 'Channel', {\n authorized: true, // default value is false\n});\n```\n\n## Recording Configurations\n\nAn Amazon IVS Recording Configuration stores settings that specify how a channel's live streams should be recorded.\nYou can configure video quality, thumbnail generation, and where recordings are stored in Amazon S3.\n\nFor more information about IVS recording, see [IVS Auto-Record to Amazon S3 | Low-Latency Streaming](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/record-to-s3.html).\n\nYou can create a recording configuration:\n\n```ts\n// create an S3 bucket for storing recordings\nconst recordingBucket = new s3.Bucket(this, 'RecordingBucket');\n\n// create a basic recording configuration\nconst recordingConfiguration = new ivs.RecordingConfiguration(this, 'RecordingConfiguration', {\n bucket: recordingBucket,\n});\n```\n\n### Renditions of a Recording\n\nWhen you stream content to an Amazon IVS channel, auto-record-to-s3 uses the source video to generate multiple renditions.\n\nFor more information, see [Discovering the Renditions of a Recording](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/record-to-s3.html#r2s3-recording-renditions).\n\n```ts\ndeclare const recordingBucket: s3.Bucket;\n\nconst recordingConfiguration= new ivs.RecordingConfiguration(this, 'RecordingConfiguration', {\n bucket: recordingBucket,\n\n // set rendition configuration\n renditionConfiguration: ivs.RenditionConfiguration.custom([ivs.Resolution.HD, ivs.Resolution.SD]),\n});\n```\n\n### Thumbnail Generation\n\nYou can enable or disable the recording of thumbnails for a live session and modify the interval at which thumbnails are generated for the live session.\n\nThumbnail intervals may range from 1 second to 60 seconds; by default, thumbnail recording is enabled, at an interval of 60 seconds.\n\nFor more information, see [Thumbnails](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/record-to-s3.html#r2s3-thumbnails).\n\n```ts\ndeclare const recordingBucket: s3.Bucket;\n\nconst recordingConfiguration = new ivs.RecordingConfiguration(this, 'RecordingConfiguration', {\n bucket: recordingBucket,\n\n // set thumbnail settings\n thumbnailConfiguration: ivs.ThumbnailConfiguration.interval(ivs.Resolution.HD, [ivs.Storage.LATEST, ivs.Storage.SEQUENTIAL], Duration.seconds(30)),\n});\n```\n\n### Merge Fragmented Streams\n\nThe `recordingReconnectWindow` property allows you to specify a window of time (in seconds) during which, if your stream is interrupted and a new stream is started, Amazon IVS tries to record to the same S3 prefix as the previous stream.\n\nIn other words, if a broadcast disconnects and then reconnects within the specified interval, the multiple streams are considered a single broadcast and merged together.\n\nFor more information, see [Merge Fragmented Streams](https://docs.aws.amazon.com/ivs/latest/LowLatencyUserGuide/record-to-s3.html#r2s3-merge-fragmented-streams).\n\n```ts\ndeclare const recordingBucket: s3.Bucket;\n\nconst recordingConfiguration= new ivs.RecordingConfiguration(this, 'RecordingConfiguration', {\n bucket: recordingBucket,\n\n // set recording reconnect window\n recordingReconnectWindow: Duration.seconds(60),\n});\n```\n\n### Attaching Recording Configuration to a Channel\n\nTo enable recording for a channel, specify the recording configuration when creating the channel:\n\n```ts\ndeclare const recordingConfiguration: ivs.RecordingConfiguration;\n\nconst channel = new ivs.Channel(this, 'Channel', {\n // set recording configuration\n recordingConfiguration: recordingConfiguration,\n});\n```\n"
3888
3888
  },
3889
3889
  "repository": {
3890
3890
  "directory": "packages/@aws-cdk/aws-ivs-alpha",
@@ -3940,7 +3940,7 @@
3940
3940
  },
3941
3941
  "locationInModule": {
3942
3942
  "filename": "lib/channel.ts",
3943
- "line": 200
3943
+ "line": 208
3944
3944
  },
3945
3945
  "parameters": [
3946
3946
  {
@@ -3970,7 +3970,7 @@
3970
3970
  "kind": "class",
3971
3971
  "locationInModule": {
3972
3972
  "filename": "lib/channel.ts",
3973
- "line": 161
3973
+ "line": 169
3974
3974
  },
3975
3975
  "methods": [
3976
3976
  {
@@ -3980,7 +3980,7 @@
3980
3980
  },
3981
3981
  "locationInModule": {
3982
3982
  "filename": "lib/channel.ts",
3983
- "line": 165
3983
+ "line": 173
3984
3984
  },
3985
3985
  "name": "fromChannelArn",
3986
3986
  "parameters": [
@@ -4017,7 +4017,7 @@
4017
4017
  },
4018
4018
  "locationInModule": {
4019
4019
  "filename": "lib/channel.ts",
4020
- "line": 31
4020
+ "line": 32
4021
4021
  },
4022
4022
  "name": "addStreamKey",
4023
4023
  "overrides": "@aws-cdk/aws-ivs-alpha.IChannel",
@@ -4047,7 +4047,7 @@
4047
4047
  "immutable": true,
4048
4048
  "locationInModule": {
4049
4049
  "filename": "lib/channel.ts",
4050
- "line": 184
4050
+ "line": 192
4051
4051
  },
4052
4052
  "name": "channelArn",
4053
4053
  "overrides": "@aws-cdk/aws-ivs-alpha.IChannel",
@@ -4067,7 +4067,7 @@
4067
4067
  "immutable": true,
4068
4068
  "locationInModule": {
4069
4069
  "filename": "lib/channel.ts",
4070
- "line": 191
4070
+ "line": 199
4071
4071
  },
4072
4072
  "name": "channelIngestEndpoint",
4073
4073
  "type": {
@@ -4086,7 +4086,7 @@
4086
4086
  "immutable": true,
4087
4087
  "locationInModule": {
4088
4088
  "filename": "lib/channel.ts",
4089
- "line": 198
4089
+ "line": 206
4090
4090
  },
4091
4091
  "name": "channelPlaybackUrl",
4092
4092
  "type": {
@@ -4111,7 +4111,7 @@
4111
4111
  "kind": "interface",
4112
4112
  "locationInModule": {
4113
4113
  "filename": "lib/channel.ts",
4114
- "line": 108
4114
+ "line": 109
4115
4115
  },
4116
4116
  "name": "ChannelProps",
4117
4117
  "properties": [
@@ -4126,7 +4126,7 @@
4126
4126
  "immutable": true,
4127
4127
  "locationInModule": {
4128
4128
  "filename": "lib/channel.ts",
4129
- "line": 118
4129
+ "line": 119
4130
4130
  },
4131
4131
  "name": "authorized",
4132
4132
  "optional": true,
@@ -4144,7 +4144,7 @@
4144
4144
  "immutable": true,
4145
4145
  "locationInModule": {
4146
4146
  "filename": "lib/channel.ts",
4147
- "line": 139
4147
+ "line": 140
4148
4148
  },
4149
4149
  "name": "channelName",
4150
4150
  "optional": true,
@@ -4162,7 +4162,7 @@
4162
4162
  "immutable": true,
4163
4163
  "locationInModule": {
4164
4164
  "filename": "lib/channel.ts",
4165
- "line": 125
4165
+ "line": 126
4166
4166
  },
4167
4167
  "name": "insecureIngest",
4168
4168
  "optional": true,
@@ -4180,7 +4180,7 @@
4180
4180
  "immutable": true,
4181
4181
  "locationInModule": {
4182
4182
  "filename": "lib/channel.ts",
4183
- "line": 132
4183
+ "line": 133
4184
4184
  },
4185
4185
  "name": "latencyMode",
4186
4186
  "optional": true,
@@ -4199,7 +4199,7 @@
4199
4199
  "immutable": true,
4200
4200
  "locationInModule": {
4201
4201
  "filename": "lib/channel.ts",
4202
- "line": 155
4202
+ "line": 156
4203
4203
  },
4204
4204
  "name": "preset",
4205
4205
  "optional": true,
@@ -4207,6 +4207,24 @@
4207
4207
  "fqn": "@aws-cdk/aws-ivs-alpha.Preset"
4208
4208
  }
4209
4209
  },
4210
+ {
4211
+ "abstract": true,
4212
+ "docs": {
4213
+ "default": "- recording is disabled",
4214
+ "stability": "experimental",
4215
+ "summary": "A recording configuration for the channel."
4216
+ },
4217
+ "immutable": true,
4218
+ "locationInModule": {
4219
+ "filename": "lib/channel.ts",
4220
+ "line": 163
4221
+ },
4222
+ "name": "recordingConfiguration",
4223
+ "optional": true,
4224
+ "type": {
4225
+ "fqn": "@aws-cdk/aws-ivs-alpha.IRecordingConfiguration"
4226
+ }
4227
+ },
4210
4228
  {
4211
4229
  "abstract": true,
4212
4230
  "docs": {
@@ -4218,7 +4236,7 @@
4218
4236
  "immutable": true,
4219
4237
  "locationInModule": {
4220
4238
  "filename": "lib/channel.ts",
4221
- "line": 147
4239
+ "line": 148
4222
4240
  },
4223
4241
  "name": "type",
4224
4242
  "optional": true,
@@ -4245,7 +4263,7 @@
4245
4263
  "kind": "enum",
4246
4264
  "locationInModule": {
4247
4265
  "filename": "lib/channel.ts",
4248
- "line": 59
4266
+ "line": 60
4249
4267
  },
4250
4268
  "members": [
4251
4269
  {
@@ -4297,7 +4315,7 @@
4297
4315
  "kind": "interface",
4298
4316
  "locationInModule": {
4299
4317
  "filename": "lib/channel.ts",
4300
- "line": 10
4318
+ "line": 11
4301
4319
  },
4302
4320
  "methods": [
4303
4321
  {
@@ -4308,7 +4326,7 @@
4308
4326
  },
4309
4327
  "locationInModule": {
4310
4328
  "filename": "lib/channel.ts",
4311
- "line": 22
4329
+ "line": 23
4312
4330
  },
4313
4331
  "name": "addStreamKey",
4314
4332
  "parameters": [
@@ -4344,7 +4362,7 @@
4344
4362
  "immutable": true,
4345
4363
  "locationInModule": {
4346
4364
  "filename": "lib/channel.ts",
4347
- "line": 16
4365
+ "line": 17
4348
4366
  },
4349
4367
  "name": "channelArn",
4350
4368
  "type": {
@@ -4394,6 +4412,64 @@
4394
4412
  ],
4395
4413
  "symbolId": "lib/playback-key-pair:IPlaybackKeyPair"
4396
4414
  },
4415
+ "@aws-cdk/aws-ivs-alpha.IRecordingConfiguration": {
4416
+ "assembly": "@aws-cdk/aws-ivs-alpha",
4417
+ "docs": {
4418
+ "stability": "experimental",
4419
+ "summary": "Represents the IVS Recording configuration."
4420
+ },
4421
+ "fqn": "@aws-cdk/aws-ivs-alpha.IRecordingConfiguration",
4422
+ "interfaces": [
4423
+ "aws-cdk-lib.IResource"
4424
+ ],
4425
+ "kind": "interface",
4426
+ "locationInModule": {
4427
+ "filename": "lib/recording-configuration.ts",
4428
+ "line": 57
4429
+ },
4430
+ "name": "IRecordingConfiguration",
4431
+ "properties": [
4432
+ {
4433
+ "abstract": true,
4434
+ "docs": {
4435
+ "custom": {
4436
+ "attribute": "true"
4437
+ },
4438
+ "stability": "experimental",
4439
+ "summary": "The ARN of the Recording configuration."
4440
+ },
4441
+ "immutable": true,
4442
+ "locationInModule": {
4443
+ "filename": "lib/recording-configuration.ts",
4444
+ "line": 68
4445
+ },
4446
+ "name": "recordingConfigurationArn",
4447
+ "type": {
4448
+ "primitive": "string"
4449
+ }
4450
+ },
4451
+ {
4452
+ "abstract": true,
4453
+ "docs": {
4454
+ "custom": {
4455
+ "attribute": "true"
4456
+ },
4457
+ "stability": "experimental",
4458
+ "summary": "The ID of the Recording configuration."
4459
+ },
4460
+ "immutable": true,
4461
+ "locationInModule": {
4462
+ "filename": "lib/recording-configuration.ts",
4463
+ "line": 62
4464
+ },
4465
+ "name": "recordingConfigurationId",
4466
+ "type": {
4467
+ "primitive": "string"
4468
+ }
4469
+ }
4470
+ ],
4471
+ "symbolId": "lib/recording-configuration:IRecordingConfiguration"
4472
+ },
4397
4473
  "@aws-cdk/aws-ivs-alpha.IStreamKey": {
4398
4474
  "assembly": "@aws-cdk/aws-ivs-alpha",
4399
4475
  "docs": {
@@ -4444,7 +4520,7 @@
4444
4520
  "kind": "enum",
4445
4521
  "locationInModule": {
4446
4522
  "filename": "lib/channel.ts",
4447
- "line": 41
4523
+ "line": 42
4448
4524
  },
4449
4525
  "members": [
4450
4526
  {
@@ -4628,7 +4704,7 @@
4628
4704
  "kind": "enum",
4629
4705
  "locationInModule": {
4630
4706
  "filename": "lib/channel.ts",
4631
- "line": 92
4707
+ "line": 93
4632
4708
  },
4633
4709
  "members": [
4634
4710
  {
@@ -4651,25 +4727,26 @@
4651
4727
  "name": "Preset",
4652
4728
  "symbolId": "lib/channel:Preset"
4653
4729
  },
4654
- "@aws-cdk/aws-ivs-alpha.StreamKey": {
4730
+ "@aws-cdk/aws-ivs-alpha.RecordingConfiguration": {
4655
4731
  "assembly": "@aws-cdk/aws-ivs-alpha",
4656
4732
  "base": "aws-cdk-lib.Resource",
4657
4733
  "docs": {
4658
- "stability": "experimental",
4659
- "summary": "A new IVS Stream Key.",
4660
- "example": "const myStreamKey = myChannel.addStreamKey('StreamKey');",
4661
4734
  "custom": {
4662
- "exampleMetadata": "fixture=with-channel infused"
4663
- }
4735
+ "resource": "AWS::IVS::RecordingConfiguration",
4736
+ "exampleMetadata": "infused"
4737
+ },
4738
+ "stability": "experimental",
4739
+ "summary": "The IVS Recording configuration.",
4740
+ "example": "declare const recordingBucket: s3.Bucket;\n\nconst recordingConfiguration= new ivs.RecordingConfiguration(this, 'RecordingConfiguration', {\n bucket: recordingBucket,\n\n // set rendition configuration\n renditionConfiguration: ivs.RenditionConfiguration.custom([ivs.Resolution.HD, ivs.Resolution.SD]),\n});"
4664
4741
  },
4665
- "fqn": "@aws-cdk/aws-ivs-alpha.StreamKey",
4742
+ "fqn": "@aws-cdk/aws-ivs-alpha.RecordingConfiguration",
4666
4743
  "initializer": {
4667
4744
  "docs": {
4668
4745
  "stability": "experimental"
4669
4746
  },
4670
4747
  "locationInModule": {
4671
- "filename": "lib/stream-key.ts",
4672
- "line": 41
4748
+ "filename": "lib/recording-configuration.ts",
4749
+ "line": 129
4673
4750
  },
4674
4751
  "parameters": [
4675
4752
  {
@@ -4687,34 +4764,112 @@
4687
4764
  {
4688
4765
  "name": "props",
4689
4766
  "type": {
4690
- "fqn": "@aws-cdk/aws-ivs-alpha.StreamKeyProps"
4767
+ "fqn": "@aws-cdk/aws-ivs-alpha.RecordingConfigurationProps"
4691
4768
  }
4692
4769
  }
4693
4770
  ]
4694
4771
  },
4695
4772
  "interfaces": [
4696
- "@aws-cdk/aws-ivs-alpha.IStreamKey"
4773
+ "@aws-cdk/aws-ivs-alpha.IRecordingConfiguration"
4697
4774
  ],
4698
4775
  "kind": "class",
4699
4776
  "locationInModule": {
4700
- "filename": "lib/stream-key.ts",
4701
- "line": 31
4777
+ "filename": "lib/recording-configuration.ts",
4778
+ "line": 76
4702
4779
  },
4703
- "name": "StreamKey",
4780
+ "methods": [
4781
+ {
4782
+ "docs": {
4783
+ "stability": "experimental",
4784
+ "summary": "Imports an IVS Recording Configuration from its ARN."
4785
+ },
4786
+ "locationInModule": {
4787
+ "filename": "lib/recording-configuration.ts",
4788
+ "line": 98
4789
+ },
4790
+ "name": "fromArn",
4791
+ "parameters": [
4792
+ {
4793
+ "name": "scope",
4794
+ "type": {
4795
+ "fqn": "constructs.Construct"
4796
+ }
4797
+ },
4798
+ {
4799
+ "name": "id",
4800
+ "type": {
4801
+ "primitive": "string"
4802
+ }
4803
+ },
4804
+ {
4805
+ "name": "recordingConfigurationArn",
4806
+ "type": {
4807
+ "primitive": "string"
4808
+ }
4809
+ }
4810
+ ],
4811
+ "returns": {
4812
+ "type": {
4813
+ "fqn": "@aws-cdk/aws-ivs-alpha.IRecordingConfiguration"
4814
+ }
4815
+ },
4816
+ "static": true
4817
+ },
4818
+ {
4819
+ "docs": {
4820
+ "stability": "experimental",
4821
+ "summary": "Imports an IVS Recording Configuration from attributes."
4822
+ },
4823
+ "locationInModule": {
4824
+ "filename": "lib/recording-configuration.ts",
4825
+ "line": 80
4826
+ },
4827
+ "name": "fromRecordingConfigurationId",
4828
+ "parameters": [
4829
+ {
4830
+ "name": "scope",
4831
+ "type": {
4832
+ "fqn": "constructs.Construct"
4833
+ }
4834
+ },
4835
+ {
4836
+ "name": "id",
4837
+ "type": {
4838
+ "primitive": "string"
4839
+ }
4840
+ },
4841
+ {
4842
+ "name": "recordingConfigurationId",
4843
+ "type": {
4844
+ "primitive": "string"
4845
+ }
4846
+ }
4847
+ ],
4848
+ "returns": {
4849
+ "type": {
4850
+ "fqn": "@aws-cdk/aws-ivs-alpha.IRecordingConfiguration"
4851
+ }
4852
+ },
4853
+ "static": true
4854
+ }
4855
+ ],
4856
+ "name": "RecordingConfiguration",
4704
4857
  "properties": [
4705
4858
  {
4706
4859
  "docs": {
4707
- "remarks": "For example: arn:aws:ivs:us-west-2:123456789012:stream-key/g1H2I3j4k5L6",
4860
+ "custom": {
4861
+ "attribute": "true"
4862
+ },
4708
4863
  "stability": "experimental",
4709
- "summary": "The stream-key ARN."
4864
+ "summary": "The ARN of the Recording configuration."
4710
4865
  },
4711
4866
  "immutable": true,
4712
4867
  "locationInModule": {
4713
- "filename": "lib/stream-key.ts",
4714
- "line": 32
4868
+ "filename": "lib/recording-configuration.ts",
4869
+ "line": 125
4715
4870
  },
4716
- "name": "streamKeyArn",
4717
- "overrides": "@aws-cdk/aws-ivs-alpha.IStreamKey",
4871
+ "name": "recordingConfigurationArn",
4872
+ "overrides": "@aws-cdk/aws-ivs-alpha.IRecordingConfiguration",
4718
4873
  "type": {
4719
4874
  "primitive": "string"
4720
4875
  }
@@ -4724,62 +4879,717 @@
4724
4879
  "custom": {
4725
4880
  "attribute": "true"
4726
4881
  },
4727
- "remarks": "For example: sk_us-west-2_abcdABCDefgh_567890abcdef",
4728
4882
  "stability": "experimental",
4729
- "summary": "The stream-key value."
4883
+ "summary": "The ID of the Recording configuration."
4730
4884
  },
4731
4885
  "immutable": true,
4732
4886
  "locationInModule": {
4733
- "filename": "lib/stream-key.ts",
4734
- "line": 39
4887
+ "filename": "lib/recording-configuration.ts",
4888
+ "line": 119
4735
4889
  },
4736
- "name": "streamKeyValue",
4890
+ "name": "recordingConfigurationId",
4891
+ "overrides": "@aws-cdk/aws-ivs-alpha.IRecordingConfiguration",
4737
4892
  "type": {
4738
4893
  "primitive": "string"
4739
4894
  }
4740
4895
  }
4741
4896
  ],
4742
- "symbolId": "lib/stream-key:StreamKey"
4897
+ "symbolId": "lib/recording-configuration:RecordingConfiguration"
4743
4898
  },
4744
- "@aws-cdk/aws-ivs-alpha.StreamKeyProps": {
4899
+ "@aws-cdk/aws-ivs-alpha.RecordingConfigurationProps": {
4745
4900
  "assembly": "@aws-cdk/aws-ivs-alpha",
4746
4901
  "datatype": true,
4747
4902
  "docs": {
4748
4903
  "stability": "experimental",
4749
- "summary": "Properties for creating a new Stream Key.",
4750
- "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ivs_alpha from '@aws-cdk/aws-ivs-alpha';\n\ndeclare const channel: ivs_alpha.Channel;\nconst streamKeyProps: ivs_alpha.StreamKeyProps = {\n channel: channel,\n};",
4904
+ "summary": "Properties of the IVS Recording configuration.",
4905
+ "example": "declare const recordingBucket: s3.Bucket;\n\nconst recordingConfiguration= new ivs.RecordingConfiguration(this, 'RecordingConfiguration', {\n bucket: recordingBucket,\n\n // set rendition configuration\n renditionConfiguration: ivs.RenditionConfiguration.custom([ivs.Resolution.HD, ivs.Resolution.SD]),\n});",
4751
4906
  "custom": {
4752
- "exampleMetadata": "fixture=_generated"
4907
+ "exampleMetadata": "infused"
4753
4908
  }
4754
4909
  },
4755
- "fqn": "@aws-cdk/aws-ivs-alpha.StreamKeyProps",
4910
+ "fqn": "@aws-cdk/aws-ivs-alpha.RecordingConfigurationProps",
4756
4911
  "kind": "interface",
4757
4912
  "locationInModule": {
4758
- "filename": "lib/stream-key.ts",
4759
- "line": 21
4913
+ "filename": "lib/recording-configuration.ts",
4914
+ "line": 11
4760
4915
  },
4761
- "name": "StreamKeyProps",
4916
+ "name": "RecordingConfigurationProps",
4762
4917
  "properties": [
4763
4918
  {
4764
4919
  "abstract": true,
4765
4920
  "docs": {
4766
4921
  "stability": "experimental",
4767
- "summary": "Channel ARN for the stream."
4922
+ "summary": "S3 bucket where recorded videos will be stored."
4768
4923
  },
4769
4924
  "immutable": true,
4770
4925
  "locationInModule": {
4771
- "filename": "lib/stream-key.ts",
4772
- "line": 25
4926
+ "filename": "lib/recording-configuration.ts",
4927
+ "line": 15
4773
4928
  },
4774
- "name": "channel",
4929
+ "name": "bucket",
4775
4930
  "type": {
4776
- "fqn": "@aws-cdk/aws-ivs-alpha.IChannel"
4931
+ "fqn": "aws-cdk-lib.aws_s3.IBucket"
4932
+ }
4933
+ },
4934
+ {
4935
+ "abstract": true,
4936
+ "docs": {
4937
+ "default": "- auto generate",
4938
+ "remarks": "The value does not need to be unique.",
4939
+ "stability": "experimental",
4940
+ "summary": "The name of the Recording configuration."
4941
+ },
4942
+ "immutable": true,
4943
+ "locationInModule": {
4944
+ "filename": "lib/recording-configuration.ts",
4945
+ "line": 23
4946
+ },
4947
+ "name": "recordingConfigurationName",
4948
+ "optional": true,
4949
+ "type": {
4950
+ "primitive": "string"
4951
+ }
4952
+ },
4953
+ {
4954
+ "abstract": true,
4955
+ "docs": {
4956
+ "default": "- 0 seconds (means disabled)",
4957
+ "remarks": "`recordingReconnectWindow` must be between 0 and 300 seconds",
4958
+ "stability": "experimental",
4959
+ "summary": "If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together."
4960
+ },
4961
+ "immutable": true,
4962
+ "locationInModule": {
4963
+ "filename": "lib/recording-configuration.ts",
4964
+ "line": 33
4965
+ },
4966
+ "name": "recordingReconnectWindow",
4967
+ "optional": true,
4968
+ "type": {
4969
+ "fqn": "aws-cdk-lib.Duration"
4970
+ }
4971
+ },
4972
+ {
4973
+ "abstract": true,
4974
+ "docs": {
4975
+ "default": "- no rendition configuration",
4976
+ "see": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-recordingconfiguration-renditionconfiguration.html",
4977
+ "stability": "experimental",
4978
+ "summary": "A rendition configuration describes which renditions should be recorded for a stream."
4979
+ },
4980
+ "immutable": true,
4981
+ "locationInModule": {
4982
+ "filename": "lib/recording-configuration.ts",
4983
+ "line": 42
4984
+ },
4985
+ "name": "renditionConfiguration",
4986
+ "optional": true,
4987
+ "type": {
4988
+ "fqn": "@aws-cdk/aws-ivs-alpha.RenditionConfiguration"
4989
+ }
4990
+ },
4991
+ {
4992
+ "abstract": true,
4993
+ "docs": {
4994
+ "default": "- no thumbnail configuration",
4995
+ "see": "https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ivs-recordingconfiguration-thumbnailconfiguration.html",
4996
+ "stability": "experimental",
4997
+ "summary": "A thumbnail configuration enables/disables the recording of thumbnails for a live session and controls the interval at which thumbnails are generated for the live session."
4998
+ },
4999
+ "immutable": true,
5000
+ "locationInModule": {
5001
+ "filename": "lib/recording-configuration.ts",
5002
+ "line": 51
5003
+ },
5004
+ "name": "thumbnailConfiguration",
5005
+ "optional": true,
5006
+ "type": {
5007
+ "fqn": "@aws-cdk/aws-ivs-alpha.ThumbnailConfiguration"
4777
5008
  }
4778
5009
  }
4779
5010
  ],
4780
- "symbolId": "lib/stream-key:StreamKeyProps"
5011
+ "symbolId": "lib/recording-configuration:RecordingConfigurationProps"
5012
+ },
5013
+ "@aws-cdk/aws-ivs-alpha.RecordingMode": {
5014
+ "assembly": "@aws-cdk/aws-ivs-alpha",
5015
+ "docs": {
5016
+ "stability": "experimental",
5017
+ "summary": "Thumbnail recording mode."
5018
+ },
5019
+ "fqn": "@aws-cdk/aws-ivs-alpha.RecordingMode",
5020
+ "kind": "enum",
5021
+ "locationInModule": {
5022
+ "filename": "lib/thumbnail-configuration.ts",
5023
+ "line": 7
5024
+ },
5025
+ "members": [
5026
+ {
5027
+ "docs": {
5028
+ "stability": "experimental",
5029
+ "summary": "Use INTERVAL to enable the generation of thumbnails for recorded video at a time interval controlled by the TargetIntervalSeconds property."
5030
+ },
5031
+ "name": "INTERVAL"
5032
+ },
5033
+ {
5034
+ "docs": {
5035
+ "stability": "experimental",
5036
+ "summary": "Use DISABLED to disable the generation of thumbnails for recorded video."
5037
+ },
5038
+ "name": "DISABLED"
5039
+ }
5040
+ ],
5041
+ "name": "RecordingMode",
5042
+ "symbolId": "lib/thumbnail-configuration:RecordingMode"
5043
+ },
5044
+ "@aws-cdk/aws-ivs-alpha.RenditionConfiguration": {
5045
+ "assembly": "@aws-cdk/aws-ivs-alpha",
5046
+ "docs": {
5047
+ "stability": "experimental",
5048
+ "summary": "Rendition configuration for IVS Recording configuration.",
5049
+ "example": "declare const recordingBucket: s3.Bucket;\n\nconst recordingConfiguration= new ivs.RecordingConfiguration(this, 'RecordingConfiguration', {\n bucket: recordingBucket,\n\n // set rendition configuration\n renditionConfiguration: ivs.RenditionConfiguration.custom([ivs.Resolution.HD, ivs.Resolution.SD]),\n});",
5050
+ "custom": {
5051
+ "exampleMetadata": "infused"
5052
+ }
5053
+ },
5054
+ "fqn": "@aws-cdk/aws-ivs-alpha.RenditionConfiguration",
5055
+ "kind": "class",
5056
+ "locationInModule": {
5057
+ "filename": "lib/rendition-configuration.ts",
5058
+ "line": 26
5059
+ },
5060
+ "methods": [
5061
+ {
5062
+ "docs": {
5063
+ "stability": "experimental",
5064
+ "summary": "Record all available renditions."
5065
+ },
5066
+ "locationInModule": {
5067
+ "filename": "lib/rendition-configuration.ts",
5068
+ "line": 30
5069
+ },
5070
+ "name": "all",
5071
+ "returns": {
5072
+ "type": {
5073
+ "fqn": "@aws-cdk/aws-ivs-alpha.RenditionConfiguration"
5074
+ }
5075
+ },
5076
+ "static": true
5077
+ },
5078
+ {
5079
+ "docs": {
5080
+ "stability": "experimental",
5081
+ "summary": "Record a subset of video renditions."
5082
+ },
5083
+ "locationInModule": {
5084
+ "filename": "lib/rendition-configuration.ts",
5085
+ "line": 46
5086
+ },
5087
+ "name": "custom",
5088
+ "parameters": [
5089
+ {
5090
+ "docs": {
5091
+ "summary": "A list of which renditions are recorded for a stream."
5092
+ },
5093
+ "name": "renditions",
5094
+ "type": {
5095
+ "collection": {
5096
+ "elementtype": {
5097
+ "fqn": "@aws-cdk/aws-ivs-alpha.Resolution"
5098
+ },
5099
+ "kind": "array"
5100
+ }
5101
+ }
5102
+ }
5103
+ ],
5104
+ "returns": {
5105
+ "type": {
5106
+ "fqn": "@aws-cdk/aws-ivs-alpha.RenditionConfiguration"
5107
+ }
5108
+ },
5109
+ "static": true
5110
+ },
5111
+ {
5112
+ "docs": {
5113
+ "stability": "experimental",
5114
+ "summary": "Does not record any video."
5115
+ },
5116
+ "locationInModule": {
5117
+ "filename": "lib/rendition-configuration.ts",
5118
+ "line": 37
5119
+ },
5120
+ "name": "none",
5121
+ "returns": {
5122
+ "type": {
5123
+ "fqn": "@aws-cdk/aws-ivs-alpha.RenditionConfiguration"
5124
+ }
5125
+ },
5126
+ "static": true
5127
+ }
5128
+ ],
5129
+ "name": "RenditionConfiguration",
5130
+ "properties": [
5131
+ {
5132
+ "docs": {
5133
+ "stability": "experimental",
5134
+ "summary": "The set of renditions are recorded for a stream."
5135
+ },
5136
+ "immutable": true,
5137
+ "locationInModule": {
5138
+ "filename": "lib/rendition-configuration.ts",
5139
+ "line": 54
5140
+ },
5141
+ "name": "renditionSelection",
5142
+ "type": {
5143
+ "fqn": "@aws-cdk/aws-ivs-alpha.RenditionSelection"
5144
+ }
5145
+ },
5146
+ {
5147
+ "docs": {
5148
+ "remarks": "If you do not specify this property, no resolution is selected.",
5149
+ "stability": "experimental",
5150
+ "summary": "A list of which renditions are recorded for a stream."
5151
+ },
5152
+ "immutable": true,
5153
+ "locationInModule": {
5154
+ "filename": "lib/rendition-configuration.ts",
5155
+ "line": 54
5156
+ },
5157
+ "name": "renditions",
5158
+ "optional": true,
5159
+ "type": {
5160
+ "collection": {
5161
+ "elementtype": {
5162
+ "fqn": "@aws-cdk/aws-ivs-alpha.Resolution"
5163
+ },
5164
+ "kind": "array"
5165
+ }
5166
+ }
5167
+ }
5168
+ ],
5169
+ "symbolId": "lib/rendition-configuration:RenditionConfiguration"
5170
+ },
5171
+ "@aws-cdk/aws-ivs-alpha.RenditionSelection": {
5172
+ "assembly": "@aws-cdk/aws-ivs-alpha",
5173
+ "docs": {
5174
+ "stability": "experimental",
5175
+ "summary": "Rendition selection mode."
5176
+ },
5177
+ "fqn": "@aws-cdk/aws-ivs-alpha.RenditionSelection",
5178
+ "kind": "enum",
5179
+ "locationInModule": {
5180
+ "filename": "lib/rendition-configuration.ts",
5181
+ "line": 6
5182
+ },
5183
+ "members": [
5184
+ {
5185
+ "docs": {
5186
+ "stability": "experimental",
5187
+ "summary": "Record all available renditions."
5188
+ },
5189
+ "name": "ALL"
5190
+ },
5191
+ {
5192
+ "docs": {
5193
+ "remarks": "This option is useful if you just want to record thumbnails.",
5194
+ "stability": "experimental",
5195
+ "summary": "Does not record any video."
5196
+ },
5197
+ "name": "NONE"
5198
+ },
5199
+ {
5200
+ "docs": {
5201
+ "stability": "experimental",
5202
+ "summary": "Select a subset of video renditions to record."
5203
+ },
5204
+ "name": "CUSTOM"
5205
+ }
5206
+ ],
5207
+ "name": "RenditionSelection",
5208
+ "symbolId": "lib/rendition-configuration:RenditionSelection"
5209
+ },
5210
+ "@aws-cdk/aws-ivs-alpha.Resolution": {
5211
+ "assembly": "@aws-cdk/aws-ivs-alpha",
5212
+ "docs": {
5213
+ "stability": "experimental",
5214
+ "summary": "Resolution for rendition.",
5215
+ "example": "declare const recordingBucket: s3.Bucket;\n\nconst recordingConfiguration= new ivs.RecordingConfiguration(this, 'RecordingConfiguration', {\n bucket: recordingBucket,\n\n // set rendition configuration\n renditionConfiguration: ivs.RenditionConfiguration.custom([ivs.Resolution.HD, ivs.Resolution.SD]),\n});",
5216
+ "custom": {
5217
+ "exampleMetadata": "infused"
5218
+ }
5219
+ },
5220
+ "fqn": "@aws-cdk/aws-ivs-alpha.Resolution",
5221
+ "kind": "enum",
5222
+ "locationInModule": {
5223
+ "filename": "lib/util.ts",
5224
+ "line": 4
5225
+ },
5226
+ "members": [
5227
+ {
5228
+ "docs": {
5229
+ "stability": "experimental",
5230
+ "summary": "Full HD (1080p)."
5231
+ },
5232
+ "name": "FULL_HD"
5233
+ },
5234
+ {
5235
+ "docs": {
5236
+ "stability": "experimental",
5237
+ "summary": "HD (720p)."
5238
+ },
5239
+ "name": "HD"
5240
+ },
5241
+ {
5242
+ "docs": {
5243
+ "stability": "experimental",
5244
+ "summary": "SD (480p)."
5245
+ },
5246
+ "name": "SD"
5247
+ },
5248
+ {
5249
+ "docs": {
5250
+ "stability": "experimental",
5251
+ "summary": "Lowest resolution."
5252
+ },
5253
+ "name": "LOWEST_RESOLUTION"
5254
+ }
5255
+ ],
5256
+ "name": "Resolution",
5257
+ "symbolId": "lib/util:Resolution"
5258
+ },
5259
+ "@aws-cdk/aws-ivs-alpha.Storage": {
5260
+ "assembly": "@aws-cdk/aws-ivs-alpha",
5261
+ "docs": {
5262
+ "stability": "experimental",
5263
+ "summary": "The format in which thumbnails are recorded for a stream.",
5264
+ "example": "declare const recordingBucket: s3.Bucket;\n\nconst recordingConfiguration = new ivs.RecordingConfiguration(this, 'RecordingConfiguration', {\n bucket: recordingBucket,\n\n // set thumbnail settings\n thumbnailConfiguration: ivs.ThumbnailConfiguration.interval(ivs.Resolution.HD, [ivs.Storage.LATEST, ivs.Storage.SEQUENTIAL], Duration.seconds(30)),\n});",
5265
+ "custom": {
5266
+ "exampleMetadata": "infused"
5267
+ }
5268
+ },
5269
+ "fqn": "@aws-cdk/aws-ivs-alpha.Storage",
5270
+ "kind": "enum",
5271
+ "locationInModule": {
5272
+ "filename": "lib/thumbnail-configuration.ts",
5273
+ "line": 22
5274
+ },
5275
+ "members": [
5276
+ {
5277
+ "docs": {
5278
+ "stability": "experimental",
5279
+ "summary": "SEQUENTIAL records all generated thumbnails in a serial manner, to the media/thumbnails directory."
5280
+ },
5281
+ "name": "SEQUENTIAL"
5282
+ },
5283
+ {
5284
+ "docs": {
5285
+ "stability": "experimental",
5286
+ "summary": "LATEST saves the latest thumbnail in media/thumbnails/latest/thumb.jpg and overwrites it at the interval specified by thumbnailTargetInterval."
5287
+ },
5288
+ "name": "LATEST"
5289
+ }
5290
+ ],
5291
+ "name": "Storage",
5292
+ "symbolId": "lib/thumbnail-configuration:Storage"
5293
+ },
5294
+ "@aws-cdk/aws-ivs-alpha.StreamKey": {
5295
+ "assembly": "@aws-cdk/aws-ivs-alpha",
5296
+ "base": "aws-cdk-lib.Resource",
5297
+ "docs": {
5298
+ "stability": "experimental",
5299
+ "summary": "A new IVS Stream Key.",
5300
+ "example": "const myStreamKey = myChannel.addStreamKey('StreamKey');",
5301
+ "custom": {
5302
+ "exampleMetadata": "fixture=with-channel infused"
5303
+ }
5304
+ },
5305
+ "fqn": "@aws-cdk/aws-ivs-alpha.StreamKey",
5306
+ "initializer": {
5307
+ "docs": {
5308
+ "stability": "experimental"
5309
+ },
5310
+ "locationInModule": {
5311
+ "filename": "lib/stream-key.ts",
5312
+ "line": 41
5313
+ },
5314
+ "parameters": [
5315
+ {
5316
+ "name": "scope",
5317
+ "type": {
5318
+ "fqn": "constructs.Construct"
5319
+ }
5320
+ },
5321
+ {
5322
+ "name": "id",
5323
+ "type": {
5324
+ "primitive": "string"
5325
+ }
5326
+ },
5327
+ {
5328
+ "name": "props",
5329
+ "type": {
5330
+ "fqn": "@aws-cdk/aws-ivs-alpha.StreamKeyProps"
5331
+ }
5332
+ }
5333
+ ]
5334
+ },
5335
+ "interfaces": [
5336
+ "@aws-cdk/aws-ivs-alpha.IStreamKey"
5337
+ ],
5338
+ "kind": "class",
5339
+ "locationInModule": {
5340
+ "filename": "lib/stream-key.ts",
5341
+ "line": 31
5342
+ },
5343
+ "name": "StreamKey",
5344
+ "properties": [
5345
+ {
5346
+ "docs": {
5347
+ "remarks": "For example: arn:aws:ivs:us-west-2:123456789012:stream-key/g1H2I3j4k5L6",
5348
+ "stability": "experimental",
5349
+ "summary": "The stream-key ARN."
5350
+ },
5351
+ "immutable": true,
5352
+ "locationInModule": {
5353
+ "filename": "lib/stream-key.ts",
5354
+ "line": 32
5355
+ },
5356
+ "name": "streamKeyArn",
5357
+ "overrides": "@aws-cdk/aws-ivs-alpha.IStreamKey",
5358
+ "type": {
5359
+ "primitive": "string"
5360
+ }
5361
+ },
5362
+ {
5363
+ "docs": {
5364
+ "custom": {
5365
+ "attribute": "true"
5366
+ },
5367
+ "remarks": "For example: sk_us-west-2_abcdABCDefgh_567890abcdef",
5368
+ "stability": "experimental",
5369
+ "summary": "The stream-key value."
5370
+ },
5371
+ "immutable": true,
5372
+ "locationInModule": {
5373
+ "filename": "lib/stream-key.ts",
5374
+ "line": 39
5375
+ },
5376
+ "name": "streamKeyValue",
5377
+ "type": {
5378
+ "primitive": "string"
5379
+ }
5380
+ }
5381
+ ],
5382
+ "symbolId": "lib/stream-key:StreamKey"
5383
+ },
5384
+ "@aws-cdk/aws-ivs-alpha.StreamKeyProps": {
5385
+ "assembly": "@aws-cdk/aws-ivs-alpha",
5386
+ "datatype": true,
5387
+ "docs": {
5388
+ "stability": "experimental",
5389
+ "summary": "Properties for creating a new Stream Key.",
5390
+ "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ivs_alpha from '@aws-cdk/aws-ivs-alpha';\n\ndeclare const channel: ivs_alpha.Channel;\nconst streamKeyProps: ivs_alpha.StreamKeyProps = {\n channel: channel,\n};",
5391
+ "custom": {
5392
+ "exampleMetadata": "fixture=_generated"
5393
+ }
5394
+ },
5395
+ "fqn": "@aws-cdk/aws-ivs-alpha.StreamKeyProps",
5396
+ "kind": "interface",
5397
+ "locationInModule": {
5398
+ "filename": "lib/stream-key.ts",
5399
+ "line": 21
5400
+ },
5401
+ "name": "StreamKeyProps",
5402
+ "properties": [
5403
+ {
5404
+ "abstract": true,
5405
+ "docs": {
5406
+ "stability": "experimental",
5407
+ "summary": "Channel ARN for the stream."
5408
+ },
5409
+ "immutable": true,
5410
+ "locationInModule": {
5411
+ "filename": "lib/stream-key.ts",
5412
+ "line": 25
5413
+ },
5414
+ "name": "channel",
5415
+ "type": {
5416
+ "fqn": "@aws-cdk/aws-ivs-alpha.IChannel"
5417
+ }
5418
+ }
5419
+ ],
5420
+ "symbolId": "lib/stream-key:StreamKeyProps"
5421
+ },
5422
+ "@aws-cdk/aws-ivs-alpha.ThumbnailConfiguration": {
5423
+ "assembly": "@aws-cdk/aws-ivs-alpha",
5424
+ "docs": {
5425
+ "stability": "experimental",
5426
+ "summary": "Thumbnail configuration for IVS Recording configuration.",
5427
+ "example": "declare const recordingBucket: s3.Bucket;\n\nconst recordingConfiguration = new ivs.RecordingConfiguration(this, 'RecordingConfiguration', {\n bucket: recordingBucket,\n\n // set thumbnail settings\n thumbnailConfiguration: ivs.ThumbnailConfiguration.interval(ivs.Resolution.HD, [ivs.Storage.LATEST, ivs.Storage.SEQUENTIAL], Duration.seconds(30)),\n});",
5428
+ "custom": {
5429
+ "exampleMetadata": "infused"
5430
+ }
5431
+ },
5432
+ "fqn": "@aws-cdk/aws-ivs-alpha.ThumbnailConfiguration",
5433
+ "kind": "class",
5434
+ "locationInModule": {
5435
+ "filename": "lib/thumbnail-configuration.ts",
5436
+ "line": 37
5437
+ },
5438
+ "methods": [
5439
+ {
5440
+ "docs": {
5441
+ "stability": "experimental",
5442
+ "summary": "Disable the generation of thumbnails for recorded video."
5443
+ },
5444
+ "locationInModule": {
5445
+ "filename": "lib/thumbnail-configuration.ts",
5446
+ "line": 41
5447
+ },
5448
+ "name": "disable",
5449
+ "returns": {
5450
+ "type": {
5451
+ "fqn": "@aws-cdk/aws-ivs-alpha.ThumbnailConfiguration"
5452
+ }
5453
+ },
5454
+ "static": true
5455
+ },
5456
+ {
5457
+ "docs": {
5458
+ "stability": "experimental",
5459
+ "summary": "Enable the generation of thumbnails for recorded video at a time interval."
5460
+ },
5461
+ "locationInModule": {
5462
+ "filename": "lib/thumbnail-configuration.ts",
5463
+ "line": 52
5464
+ },
5465
+ "name": "interval",
5466
+ "parameters": [
5467
+ {
5468
+ "docs": {
5469
+ "remarks": "If you do not specify this property, same resolution as Input stream is used.",
5470
+ "summary": "The desired resolution of recorded thumbnails for a stream."
5471
+ },
5472
+ "name": "resolution",
5473
+ "optional": true,
5474
+ "type": {
5475
+ "fqn": "@aws-cdk/aws-ivs-alpha.Resolution"
5476
+ }
5477
+ },
5478
+ {
5479
+ "docs": {
5480
+ "remarks": "If you do not specify this property, `ThumbnailStorage.SEQUENTIAL` is set.",
5481
+ "summary": "The format in which thumbnails are recorded for a stream."
5482
+ },
5483
+ "name": "storage",
5484
+ "optional": true,
5485
+ "type": {
5486
+ "collection": {
5487
+ "elementtype": {
5488
+ "fqn": "@aws-cdk/aws-ivs-alpha.Storage"
5489
+ },
5490
+ "kind": "array"
5491
+ }
5492
+ }
5493
+ },
5494
+ {
5495
+ "docs": {
5496
+ "remarks": "If you do not specify this property, `Duration.seconds(60)` is set.",
5497
+ "summary": "The targeted thumbnail-generation interval."
5498
+ },
5499
+ "name": "targetInterval",
5500
+ "optional": true,
5501
+ "type": {
5502
+ "fqn": "aws-cdk-lib.Duration"
5503
+ }
5504
+ }
5505
+ ],
5506
+ "returns": {
5507
+ "type": {
5508
+ "fqn": "@aws-cdk/aws-ivs-alpha.ThumbnailConfiguration"
5509
+ }
5510
+ },
5511
+ "static": true
5512
+ }
5513
+ ],
5514
+ "name": "ThumbnailConfiguration",
5515
+ "properties": [
5516
+ {
5517
+ "docs": {
5518
+ "remarks": "If you do not specify this property, `ThumbnailRecordingMode.INTERVAL` is set.",
5519
+ "stability": "experimental",
5520
+ "summary": "Thumbnail recording mode."
5521
+ },
5522
+ "immutable": true,
5523
+ "locationInModule": {
5524
+ "filename": "lib/thumbnail-configuration.ts",
5525
+ "line": 63
5526
+ },
5527
+ "name": "recordingMode",
5528
+ "optional": true,
5529
+ "type": {
5530
+ "fqn": "@aws-cdk/aws-ivs-alpha.RecordingMode"
5531
+ }
5532
+ },
5533
+ {
5534
+ "docs": {
5535
+ "remarks": "If you do not specify this property, same resolution as Input stream is used.",
5536
+ "stability": "experimental",
5537
+ "summary": "The desired resolution of recorded thumbnails for a stream."
5538
+ },
5539
+ "immutable": true,
5540
+ "locationInModule": {
5541
+ "filename": "lib/thumbnail-configuration.ts",
5542
+ "line": 64
5543
+ },
5544
+ "name": "resolution",
5545
+ "optional": true,
5546
+ "type": {
5547
+ "fqn": "@aws-cdk/aws-ivs-alpha.Resolution"
5548
+ }
5549
+ },
5550
+ {
5551
+ "docs": {
5552
+ "remarks": "If you do not specify this property, `ThumbnailStorage.SEQUENTIAL` is set.",
5553
+ "stability": "experimental",
5554
+ "summary": "The format in which thumbnails are recorded for a stream."
5555
+ },
5556
+ "immutable": true,
5557
+ "locationInModule": {
5558
+ "filename": "lib/thumbnail-configuration.ts",
5559
+ "line": 65
5560
+ },
5561
+ "name": "storage",
5562
+ "optional": true,
5563
+ "type": {
5564
+ "collection": {
5565
+ "elementtype": {
5566
+ "fqn": "@aws-cdk/aws-ivs-alpha.Storage"
5567
+ },
5568
+ "kind": "array"
5569
+ }
5570
+ }
5571
+ },
5572
+ {
5573
+ "docs": {
5574
+ "remarks": "Must be between 1 and 60 seconds. If you do not specify this property, `Duration.seconds(60)` is set.",
5575
+ "stability": "experimental",
5576
+ "summary": "The targeted thumbnail-generation interval."
5577
+ },
5578
+ "immutable": true,
5579
+ "locationInModule": {
5580
+ "filename": "lib/thumbnail-configuration.ts",
5581
+ "line": 66
5582
+ },
5583
+ "name": "targetInterval",
5584
+ "optional": true,
5585
+ "type": {
5586
+ "fqn": "aws-cdk-lib.Duration"
5587
+ }
5588
+ }
5589
+ ],
5590
+ "symbolId": "lib/thumbnail-configuration:ThumbnailConfiguration"
4781
5591
  }
4782
5592
  },
4783
- "version": "2.165.0-alpha.0",
5593
+ "version": "2.167.0-alpha.0",
4784
5594
  "fingerprint": "**********"
4785
5595
  }