« blib/lib/Paws/Firehose/ElasticsearchDestinationConfiguration.pm
↑ Summary
blib/lib/Paws/Firehose/ElasticsearchDestinationUpdate.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Firehose::ElasticsearchDestinationDescription; | ||
| 3 | use Moose; | ||
| 4 | has BufferingHints => (is => 'ro', isa => 'Paws::Firehose::ElasticsearchBufferingHints'); | ||
| 5 | has CloudWatchLoggingOptions => (is => 'ro', isa => 'Paws::Firehose::CloudWatchLoggingOptions'); | ||
| 6 | has ClusterEndpoint => (is => 'ro', isa => 'Str'); | ||
| 7 | has DomainARN => (is => 'ro', isa => 'Str'); | ||
| 8 | has IndexName => (is => 'ro', isa => 'Str'); | ||
| 9 | has IndexRotationPeriod => (is => 'ro', isa => 'Str'); | ||
| 10 | has ProcessingConfiguration => (is => 'ro', isa => 'Paws::Firehose::ProcessingConfiguration'); | ||
| 11 | has RetryOptions => (is => 'ro', isa => 'Paws::Firehose::ElasticsearchRetryOptions'); | ||
| 12 | has RoleARN => (is => 'ro', isa => 'Str'); | ||
| 13 | has S3BackupMode => (is => 'ro', isa => 'Str'); | ||
| 14 | has S3DestinationDescription => (is => 'ro', isa => 'Paws::Firehose::S3DestinationDescription'); | ||
| 15 | has TypeName => (is => 'ro', isa => 'Str'); | ||
| 16 | has VpcConfigurationDescription => (is => 'ro', isa => 'Paws::Firehose::VpcConfigurationDescription'); | ||
| 17 | |||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::Firehose::ElasticsearchDestinationDescription | ||
| 25 | |||
| 26 | =head1 USAGE | ||
| 27 | |||
| 28 | This class represents one of two things: | ||
| 29 | |||
| 30 | =head3 Arguments in a call to a service | ||
| 31 | |||
| 32 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 33 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 34 | |||
| 35 | As an example, if Att1 is expected to be a Paws::Firehose::ElasticsearchDestinationDescription object: | ||
| 36 | |||
| 37 | $service_obj->Method(Att1 => { BufferingHints => $value, ..., VpcConfigurationDescription => $value }); | ||
| 38 | |||
| 39 | =head3 Results returned from an API call | ||
| 40 | |||
| 41 | Use accessors for each attribute. If Att1 is expected to be an Paws::Firehose::ElasticsearchDestinationDescription object: | ||
| 42 | |||
| 43 | $result = $service_obj->Method(...); | ||
| 44 | $result->Att1->BufferingHints | ||
| 45 | |||
| 46 | =head1 DESCRIPTION | ||
| 47 | |||
| 48 | The destination description in Amazon ES. | ||
| 49 | |||
| 50 | =head1 ATTRIBUTES | ||
| 51 | |||
| 52 | |||
| 53 | =head2 BufferingHints => L<Paws::Firehose::ElasticsearchBufferingHints> | ||
| 54 | |||
| 55 | The buffering options. | ||
| 56 | |||
| 57 | |||
| 58 | =head2 CloudWatchLoggingOptions => L<Paws::Firehose::CloudWatchLoggingOptions> | ||
| 59 | |||
| 60 | The Amazon CloudWatch logging options. | ||
| 61 | |||
| 62 | |||
| 63 | =head2 ClusterEndpoint => Str | ||
| 64 | |||
| 65 | The endpoint to use when communicating with the cluster. Kinesis Data | ||
| 66 | Firehose uses either this C<ClusterEndpoint> or the C<DomainARN> field | ||
| 67 | to send data to Amazon ES. | ||
| 68 | |||
| 69 | |||
| 70 | =head2 DomainARN => Str | ||
| 71 | |||
| 72 | The ARN of the Amazon ES domain. For more information, see Amazon | ||
| 73 | Resource Names (ARNs) and AWS Service Namespaces | ||
| 74 | (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). | ||
| 75 | |||
| 76 | Kinesis Data Firehose uses either C<ClusterEndpoint> or C<DomainARN> to | ||
| 77 | send data to Amazon ES. | ||
| 78 | |||
| 79 | |||
| 80 | =head2 IndexName => Str | ||
| 81 | |||
| 82 | The Elasticsearch index name. | ||
| 83 | |||
| 84 | |||
| 85 | =head2 IndexRotationPeriod => Str | ||
| 86 | |||
| 87 | The Elasticsearch index rotation period | ||
| 88 | |||
| 89 | |||
| 90 | =head2 ProcessingConfiguration => L<Paws::Firehose::ProcessingConfiguration> | ||
| 91 | |||
| 92 | The data processing configuration. | ||
| 93 | |||
| 94 | |||
| 95 | =head2 RetryOptions => L<Paws::Firehose::ElasticsearchRetryOptions> | ||
| 96 | |||
| 97 | The Amazon ES retry options. | ||
| 98 | |||
| 99 | |||
| 100 | =head2 RoleARN => Str | ||
| 101 | |||
| 102 | The Amazon Resource Name (ARN) of the AWS credentials. For more | ||
| 103 | information, see Amazon Resource Names (ARNs) and AWS Service | ||
| 104 | Namespaces | ||
| 105 | (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). | ||
| 106 | |||
| 107 | |||
| 108 | =head2 S3BackupMode => Str | ||
| 109 | |||
| 110 | The Amazon S3 backup mode. | ||
| 111 | |||
| 112 | |||
| 113 | =head2 S3DestinationDescription => L<Paws::Firehose::S3DestinationDescription> | ||
| 114 | |||
| 115 | The Amazon S3 destination. | ||
| 116 | |||
| 117 | |||
| 118 | =head2 TypeName => Str | ||
| 119 | |||
| 120 | The Elasticsearch type name. This applies to Elasticsearch 6.x and | ||
| 121 | lower versions. For Elasticsearch 7.x, there's no value for | ||
| 122 | C<TypeName>. | ||
| 123 | |||
| 124 | |||
| 125 | =head2 VpcConfigurationDescription => L<Paws::Firehose::VpcConfigurationDescription> | ||
| 126 | |||
| 127 | The details of the VPC of the Amazon ES destination. | ||
| 128 | |||
| 129 | |||
| 130 | |||
| 131 | =head1 SEE ALSO | ||
| 132 | |||
| 133 | This class forms part of L<Paws>, describing an object used in L<Paws::Firehose> | ||
| 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 |