com.amazonaws.services.cognitosync.model

Class CognitoStreams

java.lang.Object

com.amazonaws.services.cognitosync.model.CognitoStreams

All Implemented Interfaces:

Serializable, Cloneable

public class CognitoStreams
extends Object
implements Serializable, Cloneable

Configuration options for configure Cognito streams.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CognitoStreams()

Method Summary

Methods

Modifier and Type	Method and Description
CognitoStreams	clone()
boolean	equals(Object obj)
String	getRoleArn() The ARN of the role Amazon Cognito can assume in order to publish to the stream.
String	getStreamingStatus() Status of the Cognito streams.
String	getStreamName() The name of the Cognito stream to receive updates.
int	hashCode()
void	setRoleArn(String roleArn) The ARN of the role Amazon Cognito can assume in order to publish to the stream.
void	setStreamingStatus(StreamingStatus streamingStatus) Status of the Cognito streams.
void	setStreamingStatus(String streamingStatus) Status of the Cognito streams.
void	setStreamName(String streamName) The name of the Cognito stream to receive updates.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CognitoStreams	withRoleArn(String roleArn) The ARN of the role Amazon Cognito can assume in order to publish to the stream.
CognitoStreams	withStreamingStatus(StreamingStatus streamingStatus) Status of the Cognito streams.
CognitoStreams	withStreamingStatus(String streamingStatus) Status of the Cognito streams.
CognitoStreams	withStreamName(String streamName) The name of the Cognito stream to receive updates.

Methods inherited from class java.lang.Object

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

Constructor Detail

CognitoStreams

public CognitoStreams()

Method Detail

getStreamName

public String getStreamName()

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.

Constraints:
Length: 1 - 128

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.

setStreamName

public void setStreamName(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.

Constraints:
Length: 1 - 128

Parameters:

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.

withStreamName

public CognitoStreams withStreamName(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 a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 128

Parameters:

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:

A reference to this updated object so that method calls can be chained together.

getRoleArn

public String getRoleArn()

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.

Constraints:
Length: 20 - 2048
Pattern: arn:aws:iam::\d+:role/.*

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.

setRoleArn

public void setRoleArn(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.

Constraints:
Length: 20 - 2048
Pattern: arn:aws:iam::\d+:role/.*

Parameters:

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.

withRoleArn

public CognitoStreams withRoleArn(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 a reference to this object so that method calls can be chained together.

Constraints:
Length: 20 - 2048
Pattern: arn:aws:iam::\d+:role/.*

Parameters:

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:

A reference to this updated object so that method calls can be chained together.

getStreamingStatus

public String getStreamingStatus()

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.

Constraints:
Allowed Values: ENABLED, DISABLED

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

setStreamingStatus

public void setStreamingStatus(String 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.

Constraints:
Allowed Values: ENABLED, DISABLED

Parameters:

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.

See Also:

StreamingStatus

withStreamingStatus

public CognitoStreams withStreamingStatus(String 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.

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

Constraints:
Allowed Values: ENABLED, DISABLED

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

StreamingStatus

setStreamingStatus

public void setStreamingStatus(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.

Constraints:
Allowed Values: ENABLED, DISABLED

Parameters:

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.

See Also:

StreamingStatus

withStreamingStatus

public CognitoStreams withStreamingStatus(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.

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

Constraints:
Allowed Values: ENABLED, DISABLED

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

StreamingStatus

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public CognitoStreams clone()

Overrides:

clone in class Object