« blib/lib/Paws/Firehose/HttpEndpointDescription.pm
↑ Summary
blib/lib/Paws/Firehose/HttpEndpointDestinationDescription.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Firehose::HttpEndpointDestinationConfiguration; | ||
| 3 | use Moose; | ||
| 4 | has BufferingHints => (is => 'ro', isa => 'Paws::Firehose::HttpEndpointBufferingHints'); | ||
| 5 | has CloudWatchLoggingOptions => (is => 'ro', isa => 'Paws::Firehose::CloudWatchLoggingOptions'); | ||
| 6 | has EndpointConfiguration => (is => 'ro', isa => 'Paws::Firehose::HttpEndpointConfiguration', required => 1); | ||
| 7 | has ProcessingConfiguration => (is => 'ro', isa => 'Paws::Firehose::ProcessingConfiguration'); | ||
| 8 | has RequestConfiguration => (is => 'ro', isa => 'Paws::Firehose::HttpEndpointRequestConfiguration'); | ||
| 9 | has RetryOptions => (is => 'ro', isa => 'Paws::Firehose::HttpEndpointRetryOptions'); | ||
| 10 | has RoleARN => (is => 'ro', isa => 'Str'); | ||
| 11 | has S3BackupMode => (is => 'ro', isa => 'Str'); | ||
| 12 | has S3Configuration => (is => 'ro', isa => 'Paws::Firehose::S3DestinationConfiguration', required => 1); | ||
| 13 | |||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::Firehose::HttpEndpointDestinationConfiguration | ||
| 21 | |||
| 22 | =head1 USAGE | ||
| 23 | |||
| 24 | This class represents one of two things: | ||
| 25 | |||
| 26 | =head3 Arguments in a call to a service | ||
| 27 | |||
| 28 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 29 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 30 | |||
| 31 | As an example, if Att1 is expected to be a Paws::Firehose::HttpEndpointDestinationConfiguration object: | ||
| 32 | |||
| 33 | $service_obj->Method(Att1 => { BufferingHints => $value, ..., S3Configuration => $value }); | ||
| 34 | |||
| 35 | =head3 Results returned from an API call | ||
| 36 | |||
| 37 | Use accessors for each attribute. If Att1 is expected to be an Paws::Firehose::HttpEndpointDestinationConfiguration object: | ||
| 38 | |||
| 39 | $result = $service_obj->Method(...); | ||
| 40 | $result->Att1->BufferingHints | ||
| 41 | |||
| 42 | =head1 DESCRIPTION | ||
| 43 | |||
| 44 | Describes the configuration of the HTTP endpoint destination. | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 BufferingHints => L<Paws::Firehose::HttpEndpointBufferingHints> | ||
| 50 | |||
| 51 | The buffering options that can be used before data is delivered to the | ||
| 52 | specified destination. Kinesis Data Firehose treats these options as | ||
| 53 | hints, and it might choose to use more optimal values. The C<SizeInMBs> | ||
| 54 | and C<IntervalInSeconds> parameters are optional. However, if you | ||
| 55 | specify a value for one of them, you must also provide a value for the | ||
| 56 | other. | ||
| 57 | |||
| 58 | |||
| 59 | =head2 CloudWatchLoggingOptions => L<Paws::Firehose::CloudWatchLoggingOptions> | ||
| 60 | |||
| 61 | |||
| 62 | |||
| 63 | |||
| 64 | =head2 B<REQUIRED> EndpointConfiguration => L<Paws::Firehose::HttpEndpointConfiguration> | ||
| 65 | |||
| 66 | The configuration of the HTTP endpoint selected as the destination. | ||
| 67 | |||
| 68 | |||
| 69 | =head2 ProcessingConfiguration => L<Paws::Firehose::ProcessingConfiguration> | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | =head2 RequestConfiguration => L<Paws::Firehose::HttpEndpointRequestConfiguration> | ||
| 75 | |||
| 76 | The configuration of the requeste sent to the HTTP endpoint specified | ||
| 77 | as the destination. | ||
| 78 | |||
| 79 | |||
| 80 | =head2 RetryOptions => L<Paws::Firehose::HttpEndpointRetryOptions> | ||
| 81 | |||
| 82 | Describes the retry behavior in case Kinesis Data Firehose is unable to | ||
| 83 | deliver data to the specified HTTP endpoint destination, or if it | ||
| 84 | doesn't receive a valid acknowledgment of receipt from the specified | ||
| 85 | HTTP endpoint destination. | ||
| 86 | |||
| 87 | |||
| 88 | =head2 RoleARN => Str | ||
| 89 | |||
| 90 | Kinesis Data Firehose uses this IAM role for all the permissions that | ||
| 91 | the delivery stream needs. | ||
| 92 | |||
| 93 | |||
| 94 | =head2 S3BackupMode => Str | ||
| 95 | |||
| 96 | Describes the S3 bucket backup options for the data that Kinesis Data | ||
| 97 | Firehose delivers to the HTTP endpoint destination. You can back up all | ||
| 98 | documents (C<AllData>) or only the documents that Kinesis Data Firehose | ||
| 99 | could not deliver to the specified HTTP endpoint destination | ||
| 100 | (C<FailedDataOnly>). | ||
| 101 | |||
| 102 | |||
| 103 | =head2 B<REQUIRED> S3Configuration => L<Paws::Firehose::S3DestinationConfiguration> | ||
| 104 | |||
| 105 | |||
| 106 | |||
| 107 | |||
| 108 | |||
| 109 | =head1 SEE ALSO | ||
| 110 | |||
| 111 | This class forms part of L<Paws>, describing an object used in L<Paws::Firehose> | ||
| 112 | |||
| 113 | =head1 BUGS and CONTRIBUTIONS | ||
| 114 | |||
| 115 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 116 | |||
| 117 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 118 | |||
| 119 | =cut | ||
| 120 |