File Coverage

blib/lib/Paws/Firehose/DeliveryStreamDescription.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::Firehose::DeliveryStreamDescription;
2 1     1   288 use Moose;
  1         3  
  1         6  
3             has CreateTimestamp => (is => 'ro', isa => 'Str');
4             has DeliveryStreamARN => (is => 'ro', isa => 'Str', required => 1);
5             has DeliveryStreamName => (is => 'ro', isa => 'Str', required => 1);
6             has DeliveryStreamStatus => (is => 'ro', isa => 'Str', required => 1);
7             has DeliveryStreamType => (is => 'ro', isa => 'Str', required => 1);
8             has Destinations => (is => 'ro', isa => 'ArrayRef[Paws::Firehose::DestinationDescription]', required => 1);
9             has HasMoreDestinations => (is => 'ro', isa => 'Bool', required => 1);
10             has LastUpdateTimestamp => (is => 'ro', isa => 'Str');
11             has Source => (is => 'ro', isa => 'Paws::Firehose::SourceDescription');
12             has VersionId => (is => 'ro', isa => 'Str', required => 1);
13             1;
14              
15             ### main pod documentation begin ###
16              
17             =head1 NAME
18              
19             Paws::Firehose::DeliveryStreamDescription
20              
21             =head1 USAGE
22              
23             This class represents one of two things:
24              
25             =head3 Arguments in a call to a service
26              
27             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
28             Each attribute should be used as a named argument in the calls that expect this type of object.
29              
30             As an example, if Att1 is expected to be a Paws::Firehose::DeliveryStreamDescription object:
31              
32             $service_obj->Method(Att1 => { CreateTimestamp => $value, ..., VersionId => $value });
33              
34             =head3 Results returned from an API call
35              
36             Use accessors for each attribute. If Att1 is expected to be an Paws::Firehose::DeliveryStreamDescription object:
37              
38             $result = $service_obj->Method(...);
39             $result->Att1->CreateTimestamp
40              
41             =head1 DESCRIPTION
42              
43             Contains information about a delivery stream.
44              
45             =head1 ATTRIBUTES
46              
47              
48             =head2 CreateTimestamp => Str
49              
50             The date and time that the delivery stream was created.
51              
52              
53             =head2 B<REQUIRED> DeliveryStreamARN => Str
54              
55             The Amazon Resource Name (ARN) of the delivery stream.
56              
57              
58             =head2 B<REQUIRED> DeliveryStreamName => Str
59              
60             The name of the delivery stream.
61              
62              
63             =head2 B<REQUIRED> DeliveryStreamStatus => Str
64              
65             The status of the delivery stream.
66              
67              
68             =head2 B<REQUIRED> DeliveryStreamType => Str
69              
70             The delivery stream type. This can be one of the following values:
71              
72             =over
73              
74             =item *
75              
76             C<DirectPut>: Provider applications access the delivery stream
77             directly.
78              
79             =item *
80              
81             C<KinesisStreamAsSource>: The delivery stream uses a Kinesis stream as
82             a source.
83              
84             =back
85              
86              
87              
88             =head2 B<REQUIRED> Destinations => ArrayRef[L<Paws::Firehose::DestinationDescription>]
89              
90             The destinations.
91              
92              
93             =head2 B<REQUIRED> HasMoreDestinations => Bool
94              
95             Indicates whether there are more destinations available to list.
96              
97              
98             =head2 LastUpdateTimestamp => Str
99              
100             The date and time that the delivery stream was last updated.
101              
102              
103             =head2 Source => L<Paws::Firehose::SourceDescription>
104              
105             If the C<DeliveryStreamType> parameter is C<KinesisStreamAsSource>, a
106             SourceDescription object describing the source Kinesis stream.
107              
108              
109             =head2 B<REQUIRED> VersionId => Str
110              
111             Each time the destination is updated for a delivery stream, the version
112             ID is changed, and the current version ID is required when updating the
113             destination. This is so that the service knows it is applying the
114             changes to the correct version of the delivery stream.
115              
116              
117              
118             =head1 SEE ALSO
119              
120             This class forms part of L<Paws>, describing an object used in L<Paws::Firehose>
121              
122             =head1 BUGS and CONTRIBUTIONS
123              
124             The source code is located here: https://github.com/pplu/aws-sdk-perl
125              
126             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
127              
128             =cut
129