CognitoStreams (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.cognitosync.model.CognitoStreams

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CognitoStreams
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Configuration options for configure Cognito streams.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

CognitoStreams()

Constructors
Constructor and Description
`CognitoStreams()`

Method Summary

All Methods Instance Methods Concrete 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`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`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
getClass, notify, notifyAll, wait, wait, wait

- 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()
  - 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
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class CognitoStreams

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CognitoStreams

Method Detail

setStreamName

getStreamName

withStreamName

setRoleArn

getRoleArn

withRoleArn

setStreamingStatus

getStreamingStatus

withStreamingStatus

setStreamingStatus

withStreamingStatus

toString

equals

hashCode

clone

marshall