Package com.amazonaws.kinesisvideo.client

Class KinesisVideoClientConfiguration.Builder

java.lang.Object

com.amazonaws.kinesisvideo.client.KinesisVideoClientConfiguration.Builder

Enclosing class:

KinesisVideoClientConfiguration

public static class KinesisVideoClientConfiguration.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
KinesisVideoClientConfiguration	build()
KinesisVideoClientConfiguration.Builder	useInstrumentedAllocators()
KinesisVideoClientConfiguration.Builder	withCredentialsProvider(KinesisVideoCredentialsProvider credentialsProvider)	Credentials Provider to fetch credentials from, and how often to rotate the credentials.
KinesisVideoClientConfiguration.Builder	withEndpoint(String endpoint)
KinesisVideoClientConfiguration.Builder	withIPVersionFilter(IPVersionFilter ipVersionFilter)
KinesisVideoClientConfiguration.Builder	withIsLegacyEndpoint(Boolean isLegacyEndpoint)
KinesisVideoClientConfiguration.Builder	withRegion(String region)
KinesisVideoClientConfiguration.Builder	withStorageCallbacks(StorageCallbacks storageCallbacks)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

withRegion

public KinesisVideoClientConfiguration.Builder withRegion(String region)

withCredentialsProvider

public KinesisVideoClientConfiguration.Builder withCredentialsProvider(KinesisVideoCredentialsProvider credentialsProvider)

Credentials Provider to fetch credentials from, and how often to rotate the credentials.

Parameters:

credentialsProvider - The KVS Producer client will refresh the credentials based on the provider's configured rotation interval. During client initialization, the Producer client fetches the latest credentials once, and then every rotationPeriod interval afterward.

The client will pass these cached credentials to the ServiceCallbacks for ControlPlane operations. It is ServiceCallbacks responsibility to construct the request with the provided serialized credentials.

For PutMedia (DataPlane) operation, the client will fetch the credentials via the stream's GetStreamingToken state, then pass those serialized credentials to the PutStream operation.

It is important to configure the rotationPeriod to be less than the AWS-configured expiration time (e.g. role duration seconds) to prevent the client from using stale credentials during API operations.

Use JavaCredentialsFactory for constructor convenience.

Returns:

This Builder instance to allow method chaining

See Also:

JavaCredentialsProviderImpl.updateCredentials()

withStorageCallbacks

public KinesisVideoClientConfiguration.Builder withStorageCallbacks(StorageCallbacks storageCallbacks)

withEndpoint

public KinesisVideoClientConfiguration.Builder withEndpoint(String endpoint)

withIsLegacyEndpoint

public KinesisVideoClientConfiguration.Builder withIsLegacyEndpoint(Boolean isLegacyEndpoint)

withIPVersionFilter

public KinesisVideoClientConfiguration.Builder withIPVersionFilter(IPVersionFilter ipVersionFilter)

useInstrumentedAllocators

public KinesisVideoClientConfiguration.Builder useInstrumentedAllocators()

build

public KinesisVideoClientConfiguration build()