« blib/lib/Paws/Firehose/SplunkDestinationConfiguration.pm
↑ Summary
blib/lib/Paws/Firehose/SplunkDestinationUpdate.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Firehose::SplunkDestinationDescription; | ||
| 3 | use Moose; | ||
| 4 | has CloudWatchLoggingOptions => (is => 'ro', isa => 'Paws::Firehose::CloudWatchLoggingOptions'); | ||
| 5 | has HECAcknowledgmentTimeoutInSeconds => (is => 'ro', isa => 'Int'); | ||
| 6 | has HECEndpoint => (is => 'ro', isa => 'Str'); | ||
| 7 | has HECEndpointType => (is => 'ro', isa => 'Str'); | ||
| 8 | has HECToken => (is => 'ro', isa => 'Str'); | ||
| 9 | has ProcessingConfiguration => (is => 'ro', isa => 'Paws::Firehose::ProcessingConfiguration'); | ||
| 10 | has RetryOptions => (is => 'ro', isa => 'Paws::Firehose::SplunkRetryOptions'); | ||
| 11 | has S3BackupMode => (is => 'ro', isa => 'Str'); | ||
| 12 | has S3DestinationDescription => (is => 'ro', isa => 'Paws::Firehose::S3DestinationDescription'); | ||
| 13 | |||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::Firehose::SplunkDestinationDescription | ||
| 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::SplunkDestinationDescription object: | ||
| 32 | |||
| 33 | $service_obj->Method(Att1 => { CloudWatchLoggingOptions => $value, ..., S3DestinationDescription => $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::SplunkDestinationDescription object: | ||
| 38 | |||
| 39 | $result = $service_obj->Method(...); | ||
| 40 | $result->Att1->CloudWatchLoggingOptions | ||
| 41 | |||
| 42 | =head1 DESCRIPTION | ||
| 43 | |||
| 44 | Describes a destination in Splunk. | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 CloudWatchLoggingOptions => L<Paws::Firehose::CloudWatchLoggingOptions> | ||
| 50 | |||
| 51 | The Amazon CloudWatch logging options for your delivery stream. | ||
| 52 | |||
| 53 | |||
| 54 | =head2 HECAcknowledgmentTimeoutInSeconds => Int | ||
| 55 | |||
| 56 | The amount of time that Kinesis Data Firehose waits to receive an | ||
| 57 | acknowledgment from Splunk after it sends it data. At the end of the | ||
| 58 | timeout period, Kinesis Data Firehose either tries to send the data | ||
| 59 | again or considers it an error, based on your retry settings. | ||
| 60 | |||
| 61 | |||
| 62 | =head2 HECEndpoint => Str | ||
| 63 | |||
| 64 | The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose | ||
| 65 | sends your data. | ||
| 66 | |||
| 67 | |||
| 68 | =head2 HECEndpointType => Str | ||
| 69 | |||
| 70 | This type can be either "Raw" or "Event." | ||
| 71 | |||
| 72 | |||
| 73 | =head2 HECToken => Str | ||
| 74 | |||
| 75 | A GUID you obtain from your Splunk cluster when you create a new HEC | ||
| 76 | endpoint. | ||
| 77 | |||
| 78 | |||
| 79 | =head2 ProcessingConfiguration => L<Paws::Firehose::ProcessingConfiguration> | ||
| 80 | |||
| 81 | The data processing configuration. | ||
| 82 | |||
| 83 | |||
| 84 | =head2 RetryOptions => L<Paws::Firehose::SplunkRetryOptions> | ||
| 85 | |||
| 86 | The retry behavior in case Kinesis Data Firehose is unable to deliver | ||
| 87 | data to Splunk or if it doesn't receive an acknowledgment of receipt | ||
| 88 | from Splunk. | ||
| 89 | |||
| 90 | |||
| 91 | =head2 S3BackupMode => Str | ||
| 92 | |||
| 93 | Defines how documents should be delivered to Amazon S3. When set to | ||
| 94 | C<FailedDocumentsOnly>, Kinesis Data Firehose writes any data that | ||
| 95 | could not be indexed to the configured Amazon S3 destination. When set | ||
| 96 | to C<AllDocuments>, Kinesis Data Firehose delivers all incoming records | ||
| 97 | to Amazon S3, and also writes failed documents to Amazon S3. Default | ||
| 98 | value is C<FailedDocumentsOnly>. | ||
| 99 | |||
| 100 | |||
| 101 | =head2 S3DestinationDescription => L<Paws::Firehose::S3DestinationDescription> | ||
| 102 | |||
| 103 | The Amazon S3 destination.E<gt> | ||
| 104 | |||
| 105 | |||
| 106 | |||
| 107 | =head1 SEE ALSO | ||
| 108 | |||
| 109 | This class forms part of L<Paws>, describing an object used in L<Paws::Firehose> | ||
| 110 | |||
| 111 | =head1 BUGS and CONTRIBUTIONS | ||
| 112 | |||
| 113 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 114 | |||
| 115 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 116 | |||
| 117 | =cut | ||
| 118 |