File Coverage

blib/lib/Paws/RedShift/EnableLogging.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::RedShift::EnableLogging;
3 1     1   281 use Moose;
  1         4  
  1         6  
4             has BucketName => (is => 'ro', isa => 'Str', required => 1);
5             has ClusterIdentifier => (is => 'ro', isa => 'Str', required => 1);
6             has S3KeyPrefix => (is => 'ro', isa => 'Str');
7              
8 1     1   5283 use MooseX::ClassAttribute;
  1         2  
  1         9  
9              
10             class_has _api_call => (isa => 'Str', is => 'ro', default => 'EnableLogging');
11             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RedShift::LoggingStatus');
12             class_has _result_key => (isa => 'Str', is => 'ro', default => 'EnableLoggingResult');
13             1;
14              
15             ### main pod documentation begin ###
16              
17             =head1 NAME
18              
19             Paws::RedShift::EnableLogging - Arguments for method EnableLogging on Paws::RedShift
20              
21             =head1 DESCRIPTION
22              
23             This class represents the parameters used for calling the method EnableLogging on the
24             Amazon Redshift service. Use the attributes of this class
25             as arguments to method EnableLogging.
26              
27             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to EnableLogging.
28              
29             As an example:
30              
31             $service_obj->EnableLogging(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> BucketName => Str
39              
40             The name of an existing S3 bucket where the log files are to be stored.
41              
42             Constraints:
43              
44             =over
45              
46             =item *
47              
48             Must be in the same region as the cluster
49              
50             =item *
51              
52             The cluster must have read bucket and put object permissions
53              
54             =back
55              
56              
57              
58              
59             =head2 B<REQUIRED> ClusterIdentifier => Str
60              
61             The identifier of the cluster on which logging is to be started.
62              
63             Example: C<examplecluster>
64              
65              
66              
67             =head2 S3KeyPrefix => Str
68              
69             The prefix applied to the log file names.
70              
71             Constraints:
72              
73             =over
74              
75             =item *
76              
77             Cannot exceed 512 characters
78              
79             =item *
80              
81             Cannot contain spaces( ), double quotes ("), single quotes ('), a
82             backslash (\), or control characters. The hexadecimal codes for invalid
83             characters are:
84              
85             =over
86              
87             =item *
88              
89             x00 to x20
90              
91             =item *
92              
93             x22
94              
95             =item *
96              
97             x27
98              
99             =item *
100              
101             x5c
102              
103             =item *
104              
105             x7f or larger
106              
107             =back
108              
109             =back
110              
111              
112              
113              
114              
115             =head1 SEE ALSO
116              
117             This class forms part of L<Paws>, documenting arguments for method EnableLogging in L<Paws::RedShift>
118              
119             =head1 BUGS and CONTRIBUTIONS
120              
121             The source code is located here: https://github.com/pplu/aws-sdk-perl
122              
123             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
124              
125             =cut
126