software.amazon.awssdk.services.kinesisvideo.model

Interface CreateStreamRequest.Builder

All Superinterfaces:

AwsRequest.Builder, CopyableBuilder<CreateStreamRequest.Builder,CreateStreamRequest>, KinesisVideoRequest.Builder, SdkBuilder<CreateStreamRequest.Builder,CreateStreamRequest>, SdkRequest.Builder

Enclosing class:

CreateStreamRequest

public static interface CreateStreamRequest.Builder
extends KinesisVideoRequest.Builder, CopyableBuilder<CreateStreamRequest.Builder,CreateStreamRequest>

Method Summary

Modifier and Type	Method and Description
CreateStreamRequest.Builder	dataRetentionInHours(Integer dataRetentionInHours) The number of hours that you want to retain the data in the stream.
CreateStreamRequest.Builder	deviceName(String deviceName) The name of the device that is writing to the stream.
CreateStreamRequest.Builder	kmsKeyId(String kmsKeyId) The ID of the AWS Key Management Service (AWS KMS) key that you want Kinesis Video Streams to use to encrypt stream data.
CreateStreamRequest.Builder	mediaType(String mediaType) The media type of the stream.
CreateStreamRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
CreateStreamRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
CreateStreamRequest.Builder	streamName(String streamName) A name for the stream that you are creating.

Methods inherited from interface software.amazon.awssdk.services.kinesisvideo.model.KinesisVideoRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

deviceName

CreateStreamRequest.Builder deviceName(String deviceName)

The name of the device that is writing to the stream.

In the current implementation, Kinesis Video Streams does not use this name.

Parameters:

deviceName - The name of the device that is writing to the stream.

In the current implementation, Kinesis Video Streams does not use this name.

Returns:

Returns a reference to this object so that method calls can be chained together.

streamName

CreateStreamRequest.Builder streamName(String streamName)

A name for the stream that you are creating.

The stream name is an identifier for the stream, and must be unique for each account and region.

Parameters:

streamName - A name for the stream that you are creating.

The stream name is an identifier for the stream, and must be unique for each account and region.

Returns:

Returns a reference to this object so that method calls can be chained together.

mediaType

CreateStreamRequest.Builder mediaType(String mediaType)

The media type of the stream. Consumers of the stream can use this information when processing the stream. For more information about media types, see Media Types. If you choose to specify the MediaType, see Naming Requirements for guidelines.

To play video on the console, the media must be H.264 encoded, and you need to specify this video type in this parameter as video/h264.

This parameter is optional; the default value is null (or empty in JSON).

Parameters:

mediaType - The media type of the stream. Consumers of the stream can use this information when processing the stream. For more information about media types, see Media Types. If you choose to specify the MediaType, see Naming Requirements for guidelines.

To play video on the console, the media must be H.264 encoded, and you need to specify this video type in this parameter as video/h264.

This parameter is optional; the default value is null (or empty in JSON).

Returns:

Returns a reference to this object so that method calls can be chained together.

kmsKeyId

CreateStreamRequest.Builder kmsKeyId(String kmsKeyId)

The ID of the AWS Key Management Service (AWS KMS) key that you want Kinesis Video Streams to use to encrypt stream data.

If no key ID is specified, the default, Kinesis Video-managed key (aws/kinesisvideo) is used.

For more information, see DescribeKey.

Parameters:

kmsKeyId - The ID of the AWS Key Management Service (AWS KMS) key that you want Kinesis Video Streams to use to encrypt stream data.

If no key ID is specified, the default, Kinesis Video-managed key (aws/kinesisvideo) is used.

For more information, see DescribeKey.

Returns:

Returns a reference to this object so that method calls can be chained together.

dataRetentionInHours

CreateStreamRequest.Builder dataRetentionInHours(Integer dataRetentionInHours)

The number of hours that you want to retain the data in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream.

The default value is 0, indicating that the stream does not persist data.

Parameters:

dataRetentionInHours - The number of hours that you want to retain the data in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream.

The default value is 0, indicating that the stream does not persist data.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

CreateStreamRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateStreamRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.