« blib/lib/Paws/Firehose/ElasticsearchDestinationDescription.pm
↑ Summary
blib/lib/Paws/Firehose/ElasticsearchRetryOptions.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Firehose::ElasticsearchDestinationUpdate; | ||
| 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 S3Update => (is => 'ro', isa => 'Paws::Firehose::S3DestinationUpdate'); | ||
| 14 | has TypeName => (is => 'ro', isa => 'Str'); | ||
| 15 | |||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::Firehose::ElasticsearchDestinationUpdate | ||
| 23 | |||
| 24 | =head1 USAGE | ||
| 25 | |||
| 26 | This class represents one of two things: | ||
| 27 | |||
| 28 | =head3 Arguments in a call to a service | ||
| 29 | |||
| 30 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 31 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 32 | |||
| 33 | As an example, if Att1 is expected to be a Paws::Firehose::ElasticsearchDestinationUpdate object: | ||
| 34 | |||
| 35 | $service_obj->Method(Att1 => { BufferingHints => $value, ..., TypeName => $value }); | ||
| 36 | |||
| 37 | =head3 Results returned from an API call | ||
| 38 | |||
| 39 | Use accessors for each attribute. If Att1 is expected to be an Paws::Firehose::ElasticsearchDestinationUpdate object: | ||
| 40 | |||
| 41 | $result = $service_obj->Method(...); | ||
| 42 | $result->Att1->BufferingHints | ||
| 43 | |||
| 44 | =head1 DESCRIPTION | ||
| 45 | |||
| 46 | Describes an update for a destination in Amazon ES. | ||
| 47 | |||
| 48 | =head1 ATTRIBUTES | ||
| 49 | |||
| 50 | |||
| 51 | =head2 BufferingHints => L<Paws::Firehose::ElasticsearchBufferingHints> | ||
| 52 | |||
| 53 | The buffering options. If no value is specified, | ||
| 54 | C<ElasticsearchBufferingHints> object default values are used. | ||
| 55 | |||
| 56 | |||
| 57 | =head2 CloudWatchLoggingOptions => L<Paws::Firehose::CloudWatchLoggingOptions> | ||
| 58 | |||
| 59 | The CloudWatch logging options for your delivery stream. | ||
| 60 | |||
| 61 | |||
| 62 | =head2 ClusterEndpoint => Str | ||
| 63 | |||
| 64 | The endpoint to use when communicating with the cluster. Specify either | ||
| 65 | this C<ClusterEndpoint> or the C<DomainARN> field. | ||
| 66 | |||
| 67 | |||
| 68 | =head2 DomainARN => Str | ||
| 69 | |||
| 70 | The ARN of the Amazon ES domain. The IAM role must have permissions for | ||
| 71 | C<DescribeElasticsearchDomain>, C<DescribeElasticsearchDomains>, and | ||
| 72 | C<DescribeElasticsearchDomainConfig> after assuming the IAM role | ||
| 73 | specified in C<RoleARN>. For more information, see Amazon Resource | ||
| 74 | Names (ARNs) and AWS Service Namespaces | ||
| 75 | (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). | ||
| 76 | |||
| 77 | Specify either C<ClusterEndpoint> or C<DomainARN>. | ||
| 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. Index rotation appends a | ||
| 88 | timestamp to C<IndexName> to facilitate the expiration of old data. For | ||
| 89 | more information, see Index Rotation for the Amazon ES Destination | ||
| 90 | (https://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-index-rotation). | ||
| 91 | Default value is C<OneDay>. | ||
| 92 | |||
| 93 | |||
| 94 | =head2 ProcessingConfiguration => L<Paws::Firehose::ProcessingConfiguration> | ||
| 95 | |||
| 96 | The data processing configuration. | ||
| 97 | |||
| 98 | |||
| 99 | =head2 RetryOptions => L<Paws::Firehose::ElasticsearchRetryOptions> | ||
| 100 | |||
| 101 | The retry behavior in case Kinesis Data Firehose is unable to deliver | ||
| 102 | documents to Amazon ES. The default value is 300 (5 minutes). | ||
| 103 | |||
| 104 | |||
| 105 | =head2 RoleARN => Str | ||
| 106 | |||
| 107 | The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis | ||
| 108 | Data Firehose for calling the Amazon ES Configuration API and for | ||
| 109 | indexing documents. For more information, see Grant Kinesis Data | ||
| 110 | Firehose Access to an Amazon S3 Destination | ||
| 111 | (https://docs.aws.amazon.com/firehose/latest/dev/controlling-access.html#using-iam-s3) | ||
| 112 | and Amazon Resource Names (ARNs) and AWS Service Namespaces | ||
| 113 | (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html). | ||
| 114 | |||
| 115 | |||
| 116 | =head2 S3Update => L<Paws::Firehose::S3DestinationUpdate> | ||
| 117 | |||
| 118 | The Amazon S3 destination. | ||
| 119 | |||
| 120 | |||
| 121 | =head2 TypeName => Str | ||
| 122 | |||
| 123 | The Elasticsearch type name. For Elasticsearch 6.x, there can be only | ||
| 124 | one type per index. If you try to specify a new type for an existing | ||
| 125 | index that already has another type, Kinesis Data Firehose returns an | ||
| 126 | error during runtime. | ||
| 127 | |||
| 128 | If you upgrade Elasticsearch from 6.x to 7.x and donE<rsquo>t update | ||
| 129 | your delivery stream, Kinesis Data Firehose still delivers data to | ||
| 130 | Elasticsearch with the old index name and type name. If you want to | ||
| 131 | update your delivery stream with a new index name, provide an empty | ||
| 132 | string for C<TypeName>. | ||
| 133 | |||
| 134 | |||
| 135 | |||
| 136 | =head1 SEE ALSO | ||
| 137 | |||
| 138 | This class forms part of L<Paws>, describing an object used in L<Paws::Firehose> | ||
| 139 | |||
| 140 | =head1 BUGS and CONTRIBUTIONS | ||
| 141 | |||
| 142 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 143 | |||
| 144 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 145 | |||
| 146 | =cut | ||
| 147 |