File Coverage

blib/lib/Paws/Kinesis/StartStreamEncryption.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::Kinesis::StartStreamEncryption;
3 1     1   533 use Moose;
  1         2  
  1         8  
4             has EncryptionType => (is => 'ro', isa => 'Str', required => 1);
5             has KeyId => (is => 'ro', isa => 'Str', required => 1);
6             has StreamName => (is => 'ro', isa => 'Str', required => 1);
7              
8 1     1   6335 use MooseX::ClassAttribute;
  1         3  
  1         8  
9              
10             class_has _api_call => (isa => 'Str', is => 'ro', default => 'StartStreamEncryption');
11             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::API::Response');
12             class_has _result_key => (isa => 'Str', is => 'ro');
13             1;
14              
15             ### main pod documentation begin ###
16              
17             =head1 NAME
18              
19             Paws::Kinesis::StartStreamEncryption - Arguments for method StartStreamEncryption on Paws::Kinesis
20              
21             =head1 DESCRIPTION
22              
23             This class represents the parameters used for calling the method StartStreamEncryption on the
24             Amazon Kinesis service. Use the attributes of this class
25             as arguments to method StartStreamEncryption.
26              
27             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartStreamEncryption.
28              
29             As an example:
30              
31             $service_obj->StartStreamEncryption(Att1 => $value1, Att2 => $value2, ...);
32              
33             Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.
34              
35             =head1 ATTRIBUTES
36              
37              
38             =head2 B<REQUIRED> EncryptionType => Str
39              
40             The encryption type to use. This parameter can be one of the following
41             values:
42              
43             =over
44              
45             =item *
46              
47             C<NONE>: Not valid for this operation. An C<InvalidOperationException>
48             will be thrown.
49              
50             =item *
51              
52             C<KMS>: Use server-side encryption on the records in the stream using a
53             customer-managed KMS key.
54              
55             =back
56              
57              
58             Valid values are: C<"NONE">, C<"KMS">
59              
60             =head2 B<REQUIRED> KeyId => Str
61              
62             The GUID for the customer-managed KMS key to use for encryption. You
63             can also use a Kinesis-owned master key by specifying the alias
64             C<aws/kinesis>.
65              
66              
67              
68             =head2 B<REQUIRED> StreamName => Str
69              
70             The name of the stream for which to start encrypting records.
71              
72              
73              
74              
75             =head1 SEE ALSO
76              
77             This class forms part of L<Paws>, documenting arguments for method StartStreamEncryption in L<Paws::Kinesis>
78              
79             =head1 BUGS and CONTRIBUTIONS
80              
81             The source code is located here: https://github.com/pplu/aws-sdk-perl
82              
83             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
84              
85             =cut
86