Class CognitoStreams

    • Constructor Detail

      • CognitoStreams

        public CognitoStreams()
    • Method Detail

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

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

        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.

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