« blib/lib/Paws/RedShift/DisableSnapshotCopyResult.pm
↑ Summary
blib/lib/Paws/RedShift/EnableSnapshotCopy.pm »
| 1 | |||
| 2 | package Paws::RedShift::EnableLogging; | ||
| 3 | use Moose; | ||
| 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 | use MooseX::ClassAttribute; | ||
| 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 L<Paws::RedShift> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method EnableLogging on the | ||
| 24 | L<Amazon Redshift|Paws::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 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $redshift = Paws->service('RedShift'); | ||
| 32 | my $LoggingStatus = $redshift->EnableLogging( | ||
| 33 | BucketName => 'MyString', | ||
| 34 | ClusterIdentifier => 'MyString', | ||
| 35 | S3KeyPrefix => 'MyString', # OPTIONAL | ||
| 36 | ); | ||
| 37 | |||
| 38 | # Results: | ||
| 39 | my $BucketName = $LoggingStatus->BucketName; | ||
| 40 | my $LastFailureMessage = $LoggingStatus->LastFailureMessage; | ||
| 41 | my $LastFailureTime = $LoggingStatus->LastFailureTime; | ||
| 42 | my $LastSuccessfulDeliveryTime = $LoggingStatus->LastSuccessfulDeliveryTime; | ||
| 43 | my $LoggingEnabled = $LoggingStatus->LoggingEnabled; | ||
| 44 | my $S3KeyPrefix = $LoggingStatus->S3KeyPrefix; | ||
| 45 | |||
| 46 | # Returns a L<Paws::RedShift::LoggingStatus> object. | ||
| 47 | |||
| 48 | 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. | ||
| 49 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/redshift/EnableLogging> | ||
| 50 | |||
| 51 | =head1 ATTRIBUTES | ||
| 52 | |||
| 53 | |||
| 54 | =head2 B<REQUIRED> BucketName => Str | ||
| 55 | |||
| 56 | The name of an existing S3 bucket where the log files are to be stored. | ||
| 57 | |||
| 58 | Constraints: | ||
| 59 | |||
| 60 | =over | ||
| 61 | |||
| 62 | =item * | ||
| 63 | |||
| 64 | Must be in the same region as the cluster | ||
| 65 | |||
| 66 | =item * | ||
| 67 | |||
| 68 | The cluster must have read bucket and put object permissions | ||
| 69 | |||
| 70 | =back | ||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head2 B<REQUIRED> ClusterIdentifier => Str | ||
| 76 | |||
| 77 | The identifier of the cluster on which logging is to be started. | ||
| 78 | |||
| 79 | Example: C<examplecluster> | ||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | =head2 S3KeyPrefix => Str | ||
| 84 | |||
| 85 | The prefix applied to the log file names. | ||
| 86 | |||
| 87 | Constraints: | ||
| 88 | |||
| 89 | =over | ||
| 90 | |||
| 91 | =item * | ||
| 92 | |||
| 93 | Cannot exceed 512 characters | ||
| 94 | |||
| 95 | =item * | ||
| 96 | |||
| 97 | Cannot contain spaces( ), double quotes ("), single quotes ('), a | ||
| 98 | backslash (\), or control characters. The hexadecimal codes for invalid | ||
| 99 | characters are: | ||
| 100 | |||
| 101 | =over | ||
| 102 | |||
| 103 | =item * | ||
| 104 | |||
| 105 | x00 to x20 | ||
| 106 | |||
| 107 | =item * | ||
| 108 | |||
| 109 | x22 | ||
| 110 | |||
| 111 | =item * | ||
| 112 | |||
| 113 | x27 | ||
| 114 | |||
| 115 | =item * | ||
| 116 | |||
| 117 | x5c | ||
| 118 | |||
| 119 | =item * | ||
| 120 | |||
| 121 | x7f or larger | ||
| 122 | |||
| 123 | =back | ||
| 124 | |||
| 125 | =back | ||
| 126 | |||
| 127 | |||
| 128 | |||
| 129 | |||
| 130 | |||
| 131 | =head1 SEE ALSO | ||
| 132 | |||
| 133 | This class forms part of L<Paws>, documenting arguments for method EnableLogging in L<Paws::RedShift> | ||
| 134 | |||
| 135 | =head1 BUGS and CONTRIBUTIONS | ||
| 136 | |||
| 137 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 138 | |||
| 139 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 140 | |||
| 141 | =cut | ||
| 142 |