software.amazon.awssdk.services.cognitosync.model

Class CognitoStreams

java.lang.Object

software.amazon.awssdk.services.cognitosync.model.CognitoStreams

All Implemented Interfaces:

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

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

Configuration options for configure Cognito streams.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CognitoStreams.Builder

Method Summary

Modifier and Type	Method and Description
static CognitoStreams.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	roleArn() The ARN of the role Amazon Cognito can assume in order to publish to the stream.
List<SdkField<?>>	sdkFields()
static Class<? extends CognitoStreams.Builder>	serializableBuilderClass()
StreamingStatus	streamingStatus() Status of the Cognito streams.
String	streamingStatusAsString() Status of the Cognito streams.
String	streamName() The name of the Cognito stream to receive updates.
CognitoStreams.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

streamName

public final String streamName()

The name of the Cognito stream to receive updates. This stream must be in the developers account and in the same region as the identity pool.

Returns:

The name of the Cognito stream to receive updates. This stream must be in the developers account and in the same region as the identity pool.

roleArn

public final String roleArn()

The ARN of the role Amazon Cognito can assume in order to publish to the stream. This role must grant access to Amazon Cognito (cognito-sync) to invoke PutRecord on your Cognito stream.

Returns:

The ARN of the role Amazon Cognito can assume in order to publish to the stream. This role must grant access to Amazon Cognito (cognito-sync) to invoke PutRecord on your Cognito stream.

streamingStatus

public final StreamingStatus streamingStatus()

Status of the Cognito streams. Valid values are:

ENABLED - Streaming of updates to identity pool is enabled.

DISABLED - Streaming of updates to identity pool is disabled. Bulk publish will also fail if StreamingStatus is DISABLED.

If the service returns an enum value that is not available in the current SDK version, streamingStatus will return StreamingStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from streamingStatusAsString().

Returns:

Status of the Cognito streams. Valid values are:

ENABLED - Streaming of updates to identity pool is enabled.

DISABLED - Streaming of updates to identity pool is disabled. Bulk publish will also fail if StreamingStatus is DISABLED.

See Also:

StreamingStatus

streamingStatusAsString

public final String streamingStatusAsString()

Status of the Cognito streams. Valid values are:

ENABLED - Streaming of updates to identity pool is enabled.

DISABLED - Streaming of updates to identity pool is disabled. Bulk publish will also fail if StreamingStatus is DISABLED.

If the service returns an enum value that is not available in the current SDK version, streamingStatus will return StreamingStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from streamingStatusAsString().

Returns:

Status of the Cognito streams. Valid values are:

ENABLED - Streaming of updates to identity pool is enabled.

DISABLED - Streaming of updates to identity pool is disabled. Bulk publish will also fail if StreamingStatus is DISABLED.

See Also:

StreamingStatus

toBuilder

public CognitoStreams.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CognitoStreams.Builder,CognitoStreams>

builder

public static CognitoStreams.Builder builder()

serializableBuilderClass

public static Class<? extends CognitoStreams.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