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:
  • Constructor Details

    • CognitoStreams

      public CognitoStreams()
  • Method Details

    • 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.
      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.
    • 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.
      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.
    • 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.
      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:
      Returns a reference to this object so that method calls can be chained together.
    • 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.
      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.
    • 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.
      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.
    • 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.
      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:
      Returns a reference to this object so that method calls can be chained together.
    • 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.

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

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

      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:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • 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.

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

      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:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • 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:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • clone

      public CognitoStreams clone()
      Overrides:
      clone in class Object