Class CognitoStreams
- All Implemented Interfaces:
Serializable
,Cloneable
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
The ARN of the role Amazon Cognito can assume in order to publish to the stream.Status of the Cognito streams.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.toString()
Returns a string representation of this object; useful for testing and debugging.withRoleArn
(String roleArn) The ARN of the role Amazon Cognito can assume in order to publish to the stream.withStreamingStatus
(StreamingStatus streamingStatus) Status of the Cognito streams.withStreamingStatus
(String streamingStatus) Status of the Cognito streams.withStreamName
(String streamName) The name of the Cognito stream to receive updates.
-
Constructor Details
-
CognitoStreams
public CognitoStreams()
-
-
Method Details
-
setStreamName
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
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
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
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
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
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
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
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
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
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
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
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-