Class: AWSCDK::Cognito::CfnIdentityPool::CognitoStreamsProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
cognito/cfn_identity_pool.rb

Overview

CognitoStreams is a property of the AWS::Cognito::IdentityPool resource that defines configuration options for Amazon Cognito streams.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(role_arn: nil, streaming_status: nil, stream_name: nil) ⇒ CognitoStreamsProperty

Returns a new instance of CognitoStreamsProperty.

Parameters:

  • role_arn (String, nil) (defaults to: nil) —

    The Amazon Resource Name (ARN) of the role Amazon Cognito can assume to publish to the stream.

  • streaming_status (String, nil) (defaults to: nil) —

    Status of the Amazon Cognito streams.

  • stream_name (String, nil) (defaults to: nil) —

    The name of the Amazon Cognito stream to receive updates.



744
745
746
747
748
749
750
751
 
# File 'cognito/cfn_identity_pool.rb', line 744

def initialize(role_arn: nil, streaming_status: nil, stream_name: nil)
  @role_arn = role_arn
  Jsii::Type.check_type(@role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn") unless @role_arn.nil?
  @streaming_status = streaming_status
  Jsii::Type.check_type(@streaming_status, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "streamingStatus") unless @streaming_status.nil?
  @stream_name = stream_name
  Jsii::Type.check_type(@stream_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "streamName") unless @stream_name.nil?
end

Instance Attribute Details

#role_arn ⇒ String? (readonly)

The Amazon Resource Name (ARN) of the role Amazon Cognito can assume to publish to the stream.

This role must grant access to Amazon Cognito (cognito-sync) to invoke PutRecord on your Amazon Cognito stream.

Returns:

  • (String, nil)

See Also:



759
760
761
 
# File 'cognito/cfn_identity_pool.rb', line 759

def role_arn
  @role_arn
end

#stream_name ⇒ String? (readonly)

The name of the Amazon Cognito stream to receive updates.

This stream must be in the developer's account and in the same Region as the identity pool.

Returns:

  • (String, nil)

See Also:



773
774
775
 
# File 'cognito/cfn_identity_pool.rb', line 773

def stream_name
  @stream_name
end

#streaming_status ⇒ String? (readonly)

Status of the Amazon Cognito streams.

Valid values are: ENABLED or DISABLED .

Returns:

  • (String, nil)

See Also:



766
767
768
 
# File 'cognito/cfn_identity_pool.rb', line 766

def streaming_status
  @streaming_status
end

Class Method Details

.jsii_properties ⇒ Object 



775
776
777
778
779
780
781
 
# File 'cognito/cfn_identity_pool.rb', line 775

def self.jsii_properties
  {
    :role_arn => "roleArn",
    :streaming_status => "streamingStatus",
    :stream_name => "streamName",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



783
784
785
786
787
788
789
790
791
 
# File 'cognito/cfn_identity_pool.rb', line 783

def to_jsii
  result = {}
  result.merge!({
    "roleArn" => @role_arn,
    "streamingStatus" => @streaming_status,
    "streamName" => @stream_name,
  })
  result.compact
end