cloudshift.awscdk.dsl.services.kinesisvideo.CfnStreamDsl.kt Maven / Gradle / Ivy
@file:Suppress("RedundantVisibilityModifier", "RedundantUnitReturnType", "RemoveRedundantQualifierName", "unused", "UnusedImport", "ClassName", "REDUNDANT_PROJECTION", "DEPRECATION")
package cloudshift.awscdk.dsl.services.kinesisvideo
import cloudshift.awscdk.common.CdkDslMarker
import cloudshift.awscdk.dsl.CfnTagDsl
import software.amazon.awscdk.CfnTag
import software.amazon.awscdk.services.kinesisvideo.CfnStream
import software.constructs.Construct
import kotlin.Number
import kotlin.String
import kotlin.Unit
import kotlin.collections.Collection
import kotlin.collections.MutableList
/**
* Specifies a new Kinesis video stream.
*
* When you create a new stream, Kinesis Video Streams assigns it a version number. When you change
* the stream's metadata, Kinesis Video Streams updates the version.
*
* `CreateStream` is an asynchronous operation.
*
* For information about how the service works, see [How it
* Works](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/how-it-works.html) .
*
* You must have permissions for the `KinesisVideo:CreateStream` action.
*
* Example:
*
* ```
* // The code below shows an example of how to instantiate this type.
* // The values are placeholders you should change.
* import software.amazon.awscdk.services.kinesisvideo.*;
* CfnStream cfnStream = CfnStream.Builder.create(this, "MyCfnStream")
* .dataRetentionInHours(123)
* .deviceName("deviceName")
* .kmsKeyId("kmsKeyId")
* .mediaType("mediaType")
* .name("name")
* .tags(List.of(CfnTag.builder()
* .key("key")
* .value("value")
* .build()))
* .build();
* ```
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisvideo-stream.html)
*/
@CdkDslMarker
public class CfnStreamDsl(
scope: Construct,
id: String
) {
private val cdkBuilder: CfnStream.Builder = CfnStream.Builder.create(scope, id)
private val _tags: MutableList = mutableListOf()
/**
* How long the stream retains data, in hours.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisvideo-stream.html#cfn-kinesisvideo-stream-dataretentioninhours)
* @param dataRetentionInHours How long the stream retains data, in hours.
*/
public fun dataRetentionInHours(dataRetentionInHours: Number) {
cdkBuilder.dataRetentionInHours(dataRetentionInHours)
}
/**
* The name of the device that is associated with the stream.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisvideo-stream.html#cfn-kinesisvideo-stream-devicename)
* @param deviceName The name of the device that is associated with the stream.
*/
public fun deviceName(deviceName: String) {
cdkBuilder.deviceName(deviceName)
}
/**
* The ID of the AWS Key Management Service ( AWS KMS ) key that Kinesis Video Streams uses to
* encrypt data on the stream.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisvideo-stream.html#cfn-kinesisvideo-stream-kmskeyid)
* @param kmsKeyId The ID of the AWS Key Management Service ( AWS KMS ) key that Kinesis Video
* Streams uses to encrypt data on the stream.
*/
public fun kmsKeyId(kmsKeyId: String) {
cdkBuilder.kmsKeyId(kmsKeyId)
}
/**
* The `MediaType` of the stream.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisvideo-stream.html#cfn-kinesisvideo-stream-mediatype)
* @param mediaType The `MediaType` of the stream.
*/
public fun mediaType(mediaType: String) {
cdkBuilder.mediaType(mediaType)
}
/**
* The name of the stream.
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisvideo-stream.html#cfn-kinesisvideo-stream-name)
* @param name The name of the stream.
*/
public fun name(name: String) {
cdkBuilder.name(name)
}
/**
* An array of key-value pairs to apply to this resource.
*
* For more information, see
* [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)
* .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisvideo-stream.html#cfn-kinesisvideo-stream-tags)
* @param tags An array of key-value pairs to apply to this resource.
*/
public fun tags(tags: CfnTagDsl.() -> Unit) {
_tags.add(CfnTagDsl().apply(tags).build())
}
/**
* An array of key-value pairs to apply to this resource.
*
* For more information, see
* [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)
* .
*
* [Documentation](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisvideo-stream.html#cfn-kinesisvideo-stream-tags)
* @param tags An array of key-value pairs to apply to this resource.
*/
public fun tags(tags: Collection) {
_tags.addAll(tags)
}
public fun build(): CfnStream {
if (_tags.isNotEmpty()) cdkBuilder.tags(_tags)
return cdkBuilder.build()
}
}