File Coverage

blib/lib/Paws/CognitoSync/CognitoStreams.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::CognitoSync::CognitoStreams;
2 1     1   417 use Moose;
  1         2  
  1         7  
3             has RoleArn => (is => 'ro', isa => 'Str');
4             has StreamingStatus => (is => 'ro', isa => 'Str');
5             has StreamName => (is => 'ro', isa => 'Str');
6             1;
7              
8             ### main pod documentation begin ###
9              
10             =head1 NAME
11              
12             Paws::CognitoSync::CognitoStreams
13              
14             =head1 USAGE
15              
16             This class represents one of two things:
17              
18             =head3 Arguments in a call to a service
19              
20             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
21             Each attribute should be used as a named argument in the calls that expect this type of object.
22              
23             As an example, if Att1 is expected to be a Paws::CognitoSync::CognitoStreams object:
24              
25             $service_obj->Method(Att1 => { RoleArn => $value, ..., StreamName => $value });
26              
27             =head3 Results returned from an API call
28              
29             Use accessors for each attribute. If Att1 is expected to be an Paws::CognitoSync::CognitoStreams object:
30              
31             $result = $service_obj->Method(...);
32             $result->Att1->RoleArn
33              
34             =head1 DESCRIPTION
35              
36             Configuration options for configure Cognito streams.
37              
38             =head1 ATTRIBUTES
39              
40              
41             =head2 RoleArn => Str
42              
43             The ARN of the role Amazon Cognito can assume in order to publish to
44             the stream. This role must grant access to Amazon Cognito
45             (cognito-sync) to invoke PutRecord on your Cognito stream.
46              
47              
48             =head2 StreamingStatus => Str
49              
50             Status of the Cognito streams. Valid values are:
51              
52             ENABLED - Streaming of updates to identity pool is enabled.
53              
54             DISABLED - Streaming of updates to identity pool is disabled. Bulk
55             publish will also fail if StreamingStatus is DISABLED.
56              
57              
58             =head2 StreamName => Str
59              
60             The name of the Cognito stream to receive updates. This stream must be
61             in the developers account and in the same region as the identity pool.
62              
63              
64              
65             =head1 SEE ALSO
66              
67             This class forms part of L<Paws>, describing an object used in L<Paws::CognitoSync>
68              
69             =head1 BUGS and CONTRIBUTIONS
70              
71             The source code is located here: https://github.com/pplu/aws-sdk-perl
72              
73             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
74              
75             =cut
76