« blib/lib/Paws/Firehose/S3DestinationConfiguration.pm
↑ Summary
blib/lib/Paws/Firehose/S3DestinationUpdate.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Firehose::S3DestinationDescription; | ||
| 3 | use Moose; | ||
| 4 | has BucketARN => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has BufferingHints => (is => 'ro', isa => 'Paws::Firehose::BufferingHints', required => 1); | ||
| 6 | has CloudWatchLoggingOptions => (is => 'ro', isa => 'Paws::Firehose::CloudWatchLoggingOptions'); | ||
| 7 | has CompressionFormat => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has EncryptionConfiguration => (is => 'ro', isa => 'Paws::Firehose::EncryptionConfiguration', required => 1); | ||
| 9 | has ErrorOutputPrefix => (is => 'ro', isa => 'Str'); | ||
| 10 | has Prefix => (is => 'ro', isa => 'Str'); | ||
| 11 | has RoleARN => (is => 'ro', isa => 'Str', required => 1); | ||
| 12 | |||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::Firehose::S3DestinationDescription | ||
| 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::S3DestinationDescription object: | ||
| 31 | |||
| 32 | $service_obj->Method(Att1 => { BucketARN => $value, ..., RoleARN => $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::S3DestinationDescription object: | ||
| 37 | |||
| 38 | $result = $service_obj->Method(...); | ||
| 39 | $result->Att1->BucketARN | ||
| 40 | |||
| 41 | =head1 DESCRIPTION | ||
| 42 | |||
| 43 | Describes a destination in Amazon S3. | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 B<REQUIRED> BucketARN => Str | ||
| 49 | |||
| 50 | The ARN of the S3 bucket. For more information, see Amazon Resource | ||
| 51 | Names (ARNs) and AWS Service Namespaces | ||
| 52 | (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). | ||
| 53 | |||
| 54 | |||
| 55 | =head2 B<REQUIRED> BufferingHints => L<Paws::Firehose::BufferingHints> | ||
| 56 | |||
| 57 | The buffering option. If no value is specified, C<BufferingHints> | ||
| 58 | object default values are used. | ||
| 59 | |||
| 60 | |||
| 61 | =head2 CloudWatchLoggingOptions => L<Paws::Firehose::CloudWatchLoggingOptions> | ||
| 62 | |||
| 63 | The Amazon CloudWatch logging options for your delivery stream. | ||
| 64 | |||
| 65 | |||
| 66 | =head2 B<REQUIRED> CompressionFormat => Str | ||
| 67 | |||
| 68 | The compression format. If no value is specified, the default is | ||
| 69 | C<UNCOMPRESSED>. | ||
| 70 | |||
| 71 | |||
| 72 | =head2 B<REQUIRED> EncryptionConfiguration => L<Paws::Firehose::EncryptionConfiguration> | ||
| 73 | |||
| 74 | The encryption configuration. If no value is specified, the default is | ||
| 75 | no encryption. | ||
| 76 | |||
| 77 | |||
| 78 | =head2 ErrorOutputPrefix => Str | ||
| 79 | |||
| 80 | A prefix that Kinesis Data Firehose evaluates and adds to failed | ||
| 81 | records before writing them to S3. This prefix appears immediately | ||
| 82 | following the bucket name. For information about how to specify this | ||
| 83 | prefix, see Custom Prefixes for Amazon S3 Objects | ||
| 84 | (https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html). | ||
| 85 | |||
| 86 | |||
| 87 | =head2 Prefix => Str | ||
| 88 | |||
| 89 | The "YYYY/MM/DD/HH" time format prefix is automatically used for | ||
| 90 | delivered Amazon S3 files. You can also specify a custom prefix, as | ||
| 91 | described in Custom Prefixes for Amazon S3 Objects | ||
| 92 | (https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html). | ||
| 93 | |||
| 94 | |||
| 95 | =head2 B<REQUIRED> RoleARN => Str | ||
| 96 | |||
| 97 | The Amazon Resource Name (ARN) of the AWS credentials. For more | ||
| 98 | information, see Amazon Resource Names (ARNs) and AWS Service | ||
| 99 | Namespaces | ||
| 100 | (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). | ||
| 101 | |||
| 102 | |||
| 103 | |||
| 104 | =head1 SEE ALSO | ||
| 105 | |||
| 106 | This class forms part of L<Paws>, describing an object used in L<Paws::Firehose> | ||
| 107 | |||
| 108 | =head1 BUGS and CONTRIBUTIONS | ||
| 109 | |||
| 110 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 111 | |||
| 112 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 113 | |||
| 114 | =cut | ||
| 115 |