Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(ivs-alpha): support advanced channel type #30075

Closed
1 of 2 tasks
mazyu36 opened this issue May 6, 2024 · 2 comments · Fixed by #30086
Closed
1 of 2 tasks

(ivs-alpha): support advanced channel type #30075

mazyu36 opened this issue May 6, 2024 · 2 comments · Fixed by #30086
Labels
@aws-cdk/aws-ivs Related to Amazon IVS effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. p2

Comments

@mazyu36
Copy link
Contributor

mazyu36 commented May 6, 2024

Describe the feature

Amazon IVS has been supporting advanced channel types since June 2023.
However, the current Channel Construct only supports BASIC and STANDARD channel types.

See:
https://aws.amazon.com/about-aws/whats-new/2023/06/amazon-ivs-advanced-channel-types-input-encoding/?nc1=h_ls

Use Case

To use advanced channel types using CDK.

Proposed Solution

  • Add ADVANCED_HD and ADVANCED_SD to the ChannelType.
  • Add preset property to the Channel Construct. Additionally, implement validation according to the following:

An optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").

See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ivs-channel.html#cfn-ivs-channel-preset

Other Information

No response

Acknowledgements

  • I may be able to implement this feature request
  • This feature might incur a breaking change

CDK version used

2.140.0

Environment details (OS name and version, etc.)

MacOS

@mazyu36 mazyu36 added feature-request A feature should be added or improved. needs-triage This issue or PR still needs to be triaged. labels May 6, 2024
@github-actions github-actions bot added the @aws-cdk/aws-ivs Related to Amazon IVS label May 6, 2024
@mazyu36 mazyu36 changed the title (ivs): support advanced channel type (ivs-alpha): support advanced channel type May 6, 2024
@ashishdhingra ashishdhingra self-assigned this May 6, 2024
@ashishdhingra ashishdhingra added investigating This issue is being investigated and/or work is in progress to resolve the issue. and removed needs-triage This issue or PR still needs to be triaged. labels May 6, 2024
@ashishdhingra
Copy link
Contributor

  • https://github.com/aws/aws-cdk/tree/main/packages/aws-cdk-lib/aws-ivs, there are no official hand-written (L2) constructs for this service yet.
    An experimental construct library for this service is available in preview. Since it is not stable yet, it is distributed as a separate package so that you can pin its version independently of the rest of the CDK. See the package:
    
    @aws-cdk/aws-ivs-alpha
    
  • The CF documentation link does specify support for ADVANCED_SD and ADVANCED_HD channel types. However, CDK ChannelType enum is missing these channel types.

@mazyu36 Feel free to contribute a PR for this feature request which could be reviewed by the team.

Thanks,
Ashish

@ashishdhingra ashishdhingra added p2 effort/small Small work item – less than a day of effort and removed investigating This issue is being investigated and/or work is in progress to resolve the issue. labels May 6, 2024
@ashishdhingra ashishdhingra removed their assignment May 6, 2024
@mergify mergify bot closed this as completed in #30086 May 24, 2024
mergify bot pushed a commit that referenced this issue May 24, 2024
### Issue # (if applicable)

Closes #30075 

### Reason for this change
As described in the issue.

### Description of changes
* Add `ADVANCED_HD` and `ADVANCED_SD` to the `ivs.ChannelType`.
* Add `preset` property to the Channel Construct. Additionally, validation has been implemented to allow setting the preset property only when using the Advanced channel type

### Description of how you validated changes
Add both unit tests and integ tests.

### Checklist
- [x] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md)

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Copy link

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

atanaspam pushed a commit to atanaspam/aws-cdk that referenced this issue Jun 3, 2024
### Issue # (if applicable)

Closes aws#30075 

### Reason for this change
As described in the issue.

### Description of changes
* Add `ADVANCED_HD` and `ADVANCED_SD` to the `ivs.ChannelType`.
* Add `preset` property to the Channel Construct. Additionally, validation has been implemented to allow setting the preset property only when using the Advanced channel type

### Description of how you validated changes
Add both unit tests and integ tests.

### Checklist
- [x] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md)

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
@aws-cdk/aws-ivs Related to Amazon IVS effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. p2
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants