Interface CreateStreamRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateStreamRequest.Builder,CreateStreamRequest>, KinesisVideoRequest.Builder, SdkBuilder<CreateStreamRequest.Builder,CreateStreamRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateStreamRequest
@Mutable @NotThreadSafe public static interface CreateStreamRequest.Builder extends KinesisVideoRequest.Builder, SdkPojo, CopyableBuilder<CreateStreamRequest.Builder,CreateStreamRequest>

  • Method Details

    • deviceName

      CreateStreamRequest.Builder deviceName(String deviceName)

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

      In the current implementation, Kinesis Video Streams doesn't use this name.

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

      In the current implementation, Kinesis Video Streams doesn't 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.

      Example valid values include "video/h264" and "video/h264,audio/aac".

      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.

      Example valid values include "video/h264" and "video/h264,audio/aac".

      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 Key Management Service (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 Key Management Service (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. The minimum is 1 hour.

      When the DataRetentionInHours value is 0, consumers can still consume the fragments that remain in the service host buffer, which has a retention time limit of 5 minutes and a retention memory limit of 200 MB. Fragments are removed from the buffer when either limit is reached.

      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. The minimum is 1 hour.

      When the DataRetentionInHours value is 0, consumers can still consume the fragments that remain in the service host buffer, which has a retention time limit of 5 minutes and a retention memory limit of 200 MB. Fragments are removed from the buffer when either limit is reached.

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

    • tags

      CreateStreamRequest.Builder tags(Map<String,String> tags)

      A list of tags to associate with the specified stream. Each tag is a key-value pair (the value is optional).

      Parameters:
      tags - A list of tags to associate with the specified stream. Each tag is a key-value pair (the value is optional).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • streamStorageConfiguration

      CreateStreamRequest.Builder streamStorageConfiguration(StreamStorageConfiguration streamStorageConfiguration)

      The configuration for the stream's storage, including the default storage tier for stream data. This configuration determines how stream data is stored and accessed, with different tiers offering varying levels of performance and cost optimization.

      If not specified, the stream will use the default storage configuration with HOT tier for optimal performance.

      Parameters:
      streamStorageConfiguration - The configuration for the stream's storage, including the default storage tier for stream data. This configuration determines how stream data is stored and accessed, with different tiers offering varying levels of performance and cost optimization.

      If not specified, the stream will use the default storage configuration with HOT tier for optimal performance.

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

    • streamStorageConfiguration

      default CreateStreamRequest.Builder streamStorageConfiguration(Consumer<StreamStorageConfiguration.Builder> streamStorageConfiguration)

      The configuration for the stream's storage, including the default storage tier for stream data. This configuration determines how stream data is stored and accessed, with different tiers offering varying levels of performance and cost optimization.

      If not specified, the stream will use the default storage configuration with HOT tier for optimal performance.

      This is a convenience method that creates an instance of the StreamStorageConfiguration.Builder avoiding the need to create one manually via StreamStorageConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to streamStorageConfiguration(StreamStorageConfiguration).

      Parameters:
      streamStorageConfiguration - a consumer that will call methods on StreamStorageConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • 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.