Package software.amazon.awssdk.services.cognitosync.model

Interface CognitoStreams.Builder

All Superinterfaces:
Buildable, CopyableBuilder<CognitoStreams.Builder,CognitoStreams>, SdkBuilder<CognitoStreams.Builder,CognitoStreams>, SdkPojo
Enclosing class:
CognitoStreams
public static interface CognitoStreams.Builder extends SdkPojo, CopyableBuilder<CognitoStreams.Builder,CognitoStreams>

  • Method Details

    • streamName

      CognitoStreams.Builder streamName(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.

    • roleArn

      CognitoStreams.Builder roleArn(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.

    • streamingStatus

      CognitoStreams.Builder streamingStatus(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

      CognitoStreams.Builder streamingStatus(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: