« blib/lib/Paws/Firehose/ExtendedS3DestinationConfiguration.pm
↑ Summary
blib/lib/Paws/Firehose/ExtendedS3DestinationUpdate.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Firehose::ExtendedS3DestinationDescription; | ||
| 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 DataFormatConversionConfiguration => (is => 'ro', isa => 'Paws::Firehose::DataFormatConversionConfiguration'); | ||
| 9 | has EncryptionConfiguration => (is => 'ro', isa => 'Paws::Firehose::EncryptionConfiguration', required => 1); | ||
| 10 | has ErrorOutputPrefix => (is => 'ro', isa => 'Str'); | ||
| 11 | has Prefix => (is => 'ro', isa => 'Str'); | ||
| 12 | has ProcessingConfiguration => (is => 'ro', isa => 'Paws::Firehose::ProcessingConfiguration'); | ||
| 13 | has RoleARN => (is => 'ro', isa => 'Str', required => 1); | ||
| 14 | has S3BackupDescription => (is => 'ro', isa => 'Paws::Firehose::S3DestinationDescription'); | ||
| 15 | has S3BackupMode => (is => 'ro', isa => 'Str'); | ||
| 16 | |||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::Firehose::ExtendedS3DestinationDescription | ||
| 24 | |||
| 25 | =head1 USAGE | ||
| 26 | |||
| 27 | This class represents one of two things: | ||
| 28 | |||
| 29 | =head3 Arguments in a call to a service | ||
| 30 | |||
| 31 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 32 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 33 | |||
| 34 | As an example, if Att1 is expected to be a Paws::Firehose::ExtendedS3DestinationDescription object: | ||
| 35 | |||
| 36 | $service_obj->Method(Att1 => { BucketARN => $value, ..., S3BackupMode => $value }); | ||
| 37 | |||
| 38 | =head3 Results returned from an API call | ||
| 39 | |||
| 40 | Use accessors for each attribute. If Att1 is expected to be an Paws::Firehose::ExtendedS3DestinationDescription object: | ||
| 41 | |||
| 42 | $result = $service_obj->Method(...); | ||
| 43 | $result->Att1->BucketARN | ||
| 44 | |||
| 45 | =head1 DESCRIPTION | ||
| 46 | |||
| 47 | Describes a destination in Amazon S3. | ||
| 48 | |||
| 49 | =head1 ATTRIBUTES | ||
| 50 | |||
| 51 | |||
| 52 | =head2 B<REQUIRED> BucketARN => Str | ||
| 53 | |||
| 54 | The ARN of the S3 bucket. For more information, see Amazon Resource | ||
| 55 | Names (ARNs) and AWS Service Namespaces | ||
| 56 | (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). | ||
| 57 | |||
| 58 | |||
| 59 | =head2 B<REQUIRED> BufferingHints => L<Paws::Firehose::BufferingHints> | ||
| 60 | |||
| 61 | The buffering option. | ||
| 62 | |||
| 63 | |||
| 64 | =head2 CloudWatchLoggingOptions => L<Paws::Firehose::CloudWatchLoggingOptions> | ||
| 65 | |||
| 66 | The Amazon CloudWatch logging options for your delivery stream. | ||
| 67 | |||
| 68 | |||
| 69 | =head2 B<REQUIRED> CompressionFormat => Str | ||
| 70 | |||
| 71 | The compression format. If no value is specified, the default is | ||
| 72 | C<UNCOMPRESSED>. | ||
| 73 | |||
| 74 | |||
| 75 | =head2 DataFormatConversionConfiguration => L<Paws::Firehose::DataFormatConversionConfiguration> | ||
| 76 | |||
| 77 | The serializer, deserializer, and schema for converting data from the | ||
| 78 | JSON format to the Parquet or ORC format before writing it to Amazon | ||
| 79 | S3. | ||
| 80 | |||
| 81 | |||
| 82 | =head2 B<REQUIRED> EncryptionConfiguration => L<Paws::Firehose::EncryptionConfiguration> | ||
| 83 | |||
| 84 | The encryption configuration. If no value is specified, the default is | ||
| 85 | no encryption. | ||
| 86 | |||
| 87 | |||
| 88 | =head2 ErrorOutputPrefix => Str | ||
| 89 | |||
| 90 | A prefix that Kinesis Data Firehose evaluates and adds to failed | ||
| 91 | records before writing them to S3. This prefix appears immediately | ||
| 92 | following the bucket name. For information about how to specify this | ||
| 93 | prefix, see Custom Prefixes for Amazon S3 Objects | ||
| 94 | (https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html). | ||
| 95 | |||
| 96 | |||
| 97 | =head2 Prefix => Str | ||
| 98 | |||
| 99 | The "YYYY/MM/DD/HH" time format prefix is automatically used for | ||
| 100 | delivered Amazon S3 files. You can also specify a custom prefix, as | ||
| 101 | described in Custom Prefixes for Amazon S3 Objects | ||
| 102 | (https://docs.aws.amazon.com/firehose/latest/dev/s3-prefixes.html). | ||
| 103 | |||
| 104 | |||
| 105 | =head2 ProcessingConfiguration => L<Paws::Firehose::ProcessingConfiguration> | ||
| 106 | |||
| 107 | The data processing configuration. | ||
| 108 | |||
| 109 | |||
| 110 | =head2 B<REQUIRED> RoleARN => Str | ||
| 111 | |||
| 112 | The Amazon Resource Name (ARN) of the AWS credentials. For more | ||
| 113 | information, see Amazon Resource Names (ARNs) and AWS Service | ||
| 114 | Namespaces | ||
| 115 | (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). | ||
| 116 | |||
| 117 | |||
| 118 | =head2 S3BackupDescription => L<Paws::Firehose::S3DestinationDescription> | ||
| 119 | |||
| 120 | The configuration for backup in Amazon S3. | ||
| 121 | |||
| 122 | |||
| 123 | =head2 S3BackupMode => Str | ||
| 124 | |||
| 125 | The Amazon S3 backup mode. | ||
| 126 | |||
| 127 | |||
| 128 | |||
| 129 | =head1 SEE ALSO | ||
| 130 | |||
| 131 | This class forms part of L<Paws>, describing an object used in L<Paws::Firehose> | ||
| 132 | |||
| 133 | =head1 BUGS and CONTRIBUTIONS | ||
| 134 | |||
| 135 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 136 | |||
| 137 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 138 | |||
| 139 | =cut | ||
| 140 |