Package software.amazon.awssdk.services.chimesdkmediapipelines.model

Class KinesisVideoStreamConfiguration

java.lang.Object

software.amazon.awssdk.services.chimesdkmediapipelines.model.KinesisVideoStreamConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<KinesisVideoStreamConfiguration.Builder,KinesisVideoStreamConfiguration>

@Generated("software.amazon.awssdk:codegen")
public final class KinesisVideoStreamConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<KinesisVideoStreamConfiguration.Builder,KinesisVideoStreamConfiguration>

The configuration of an Kinesis video stream.

If a meeting uses an opt-in Region as its MediaRegion, the KVS stream must be in that same Region. For example, if a meeting uses the af-south-1 Region, the KVS stream must also be in af-south-1. However, if the meeting uses a Region that AWS turns on by default, the KVS stream can be in any available Region, including an opt-in Region. For example, if the meeting uses ca-central-1, the KVS stream can be in eu-west-2, us-east-1, af-south-1, or any other Region that the Amazon Chime SDK supports.

To learn which AWS Region a meeting uses, call the GetMeeting API and use the MediaRegion parameter from the response.

For more information about opt-in Regions, refer to Available Regions in the Amazon Chime SDK Developer Guide, and Specify which AWS Regions your account can use, in the AWS Account Management Reference Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	KinesisVideoStreamConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static KinesisVideoStreamConfiguration.Builder	builder()
Integer	dataRetentionInHours()	The amount of time that data is retained.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	region()	The Amazon Web Services Region of the video stream.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends KinesisVideoStreamConfiguration.Builder>	serializableBuilderClass()
KinesisVideoStreamConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

region

public final String region()

The Amazon Web Services Region of the video stream.

Returns:

The Amazon Web Services Region of the video stream.

dataRetentionInHours

public final Integer dataRetentionInHours()

The amount of time that data is retained.

Returns:

The amount of time that data is retained.

toBuilder

public KinesisVideoStreamConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<KinesisVideoStreamConfiguration.Builder,KinesisVideoStreamConfiguration>

builder

public static KinesisVideoStreamConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends KinesisVideoStreamConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo