aws-sdk-elasticsearchservice 1.0.0.rc1 → 1.0.0.rc2

Sign up to get free protection for your applications and to get access to all the features.
@@ -1,23 +1,14 @@
1
1
  # WARNING ABOUT GENERATED CODE
2
2
  #
3
- # This file is generated. See the contributing for info on making contributions:
3
+ # This file is generated. See the contributing guide for more information:
4
4
  # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
5
  #
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
- module Aws
9
- module ElasticsearchService
10
- module Errors
8
+ module Aws::ElasticsearchService
9
+ module Errors
11
10
 
12
- extend Aws::Errors::DynamicErrors
11
+ extend Aws::Errors::DynamicErrors
13
12
 
14
- # Raised when calling #load or #data on a resource class that can not be
15
- # loaded. This can happen when:
16
- #
17
- # * A resource class has identifiers, but no data attributes.
18
- # * Resource data is only available when making an API call that
19
- # enumerates all resources of that type.
20
- class ResourceNotLoadable < RuntimeError; end
21
- end
22
13
  end
23
14
  end
@@ -1,25 +1,23 @@
1
1
  # WARNING ABOUT GENERATED CODE
2
2
  #
3
- # This file is generated. See the contributing for info on making contributions:
3
+ # This file is generated. See the contributing guide for more information:
4
4
  # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
5
  #
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
- module Aws
9
- module ElasticsearchService
10
- class Resource
8
+ module Aws::ElasticsearchService
9
+ class Resource
11
10
 
12
- # @param options ({})
13
- # @option options [Client] :client
14
- def initialize(options = {})
15
- @client = options[:client] || Client.new(options)
16
- end
17
-
18
- # @return [Client]
19
- def client
20
- @client
21
- end
11
+ # @param options ({})
12
+ # @option options [Client] :client
13
+ def initialize(options = {})
14
+ @client = options[:client] || Client.new(options)
15
+ end
22
16
 
17
+ # @return [Client]
18
+ def client
19
+ @client
23
20
  end
21
+
24
22
  end
25
23
  end
@@ -1,818 +1,1187 @@
1
1
  # WARNING ABOUT GENERATED CODE
2
2
  #
3
- # This file is generated. See the contributing for info on making contributions:
3
+ # This file is generated. See the contributing guide for more information:
4
4
  # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
5
  #
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
- module Aws
9
- module ElasticsearchService
10
- module Types
11
-
12
- # The configured access rules for the domain's document and search
13
- # endpoints, and the current status of those rules.
14
- # @!attribute [rw] options
15
- # The access policy configured for the Elasticsearch domain. Access
16
- # policies may be resource-based, IP-based, or IAM-based. See [
17
- # Configuring Access Policies][1]for more information.
18
- #
19
- #
20
- #
21
- # [1]: http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-access-policies
22
- # @return [String]
23
- #
24
- # @!attribute [rw] status
25
- # The status of the access policy for the Elasticsearch domain. See
26
- # `OptionStatus` for the status information that's included.
27
- # @return [Types::OptionStatus]
28
- class AccessPoliciesStatus < Struct.new(
29
- :options,
30
- :status)
31
- include Aws::Structure
32
- end
33
-
34
- # Container for the parameters to the `AddTags` operation. Specify the
35
- # tags that you want to attach to the Elasticsearch domain.
36
- # @note When making an API call, pass AddTagsRequest
37
- # data as a hash:
38
- #
39
- # {
40
- # arn: "ARN", # required
41
- # tag_list: [ # required
42
- # {
43
- # key: "TagKey", # required
44
- # value: "TagValue", # required
45
- # },
46
- # ],
47
- # }
48
- # @!attribute [rw] arn
49
- # Specify the `ARN` for which you want to add the tags.
50
- # @return [String]
51
- #
52
- # @!attribute [rw] tag_list
53
- # List of `Tag` that need to be added for the Elasticsearch domain.
54
- # @return [Array<Types::Tag>]
55
- class AddTagsRequest < Struct.new(
56
- :arn,
57
- :tag_list)
58
- include Aws::Structure
59
- end
60
-
61
- # Status of the advanced options for the specified Elasticsearch domain.
62
- # Currently, the following advanced options are available:
63
- #
64
- # * Option to allow references to indices in an HTTP request body. Must
65
- # be `false` when configuring access to individual sub-resources. By
66
- # default, the value is `true`. See [Configuration Advanced
67
- # Options][1] for more information.
68
- # * Option to specify the percentage of heap space that is allocated to
69
- # field data. By default, this setting is unbounded.
70
- #
71
- # For more information, see [Configuring Advanced Options][1].
72
- #
73
- #
74
- #
75
- # [1]: http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options
76
- # @!attribute [rw] options
77
- # Specifies the status of advanced options for the specified
78
- # Elasticsearch domain.
79
- # @return [Hash<String,String>]
80
- #
81
- # @!attribute [rw] status
82
- # Specifies the status of `OptionStatus` for advanced options for the
83
- # specified Elasticsearch domain.
84
- # @return [Types::OptionStatus]
85
- class AdvancedOptionsStatus < Struct.new(
86
- :options,
87
- :status)
88
- include Aws::Structure
89
- end
90
-
91
- # @note When making an API call, pass CreateElasticsearchDomainRequest
92
- # data as a hash:
93
- #
94
- # {
95
- # domain_name: "DomainName", # required
96
- # elasticsearch_version: "ElasticsearchVersionString",
97
- # elasticsearch_cluster_config: {
98
- # instance_type: "m3.medium.elasticsearch", # accepts m3.medium.elasticsearch, m3.large.elasticsearch, m3.xlarge.elasticsearch, m3.2xlarge.elasticsearch, m4.large.elasticsearch, m4.xlarge.elasticsearch, m4.2xlarge.elasticsearch, m4.4xlarge.elasticsearch, m4.10xlarge.elasticsearch, t2.micro.elasticsearch, t2.small.elasticsearch, t2.medium.elasticsearch, r3.large.elasticsearch, r3.xlarge.elasticsearch, r3.2xlarge.elasticsearch, r3.4xlarge.elasticsearch, r3.8xlarge.elasticsearch, i2.xlarge.elasticsearch, i2.2xlarge.elasticsearch
99
- # instance_count: 1,
100
- # dedicated_master_enabled: false,
101
- # zone_awareness_enabled: false,
102
- # dedicated_master_type: "m3.medium.elasticsearch", # accepts m3.medium.elasticsearch, m3.large.elasticsearch, m3.xlarge.elasticsearch, m3.2xlarge.elasticsearch, m4.large.elasticsearch, m4.xlarge.elasticsearch, m4.2xlarge.elasticsearch, m4.4xlarge.elasticsearch, m4.10xlarge.elasticsearch, t2.micro.elasticsearch, t2.small.elasticsearch, t2.medium.elasticsearch, r3.large.elasticsearch, r3.xlarge.elasticsearch, r3.2xlarge.elasticsearch, r3.4xlarge.elasticsearch, r3.8xlarge.elasticsearch, i2.xlarge.elasticsearch, i2.2xlarge.elasticsearch
103
- # dedicated_master_count: 1,
104
- # },
105
- # ebs_options: {
106
- # ebs_enabled: false,
107
- # volume_type: "standard", # accepts standard, gp2, io1
108
- # volume_size: 1,
109
- # iops: 1,
110
- # },
111
- # access_policies: "PolicyDocument",
112
- # snapshot_options: {
113
- # automated_snapshot_start_hour: 1,
114
- # },
115
- # advanced_options: {
116
- # "String" => "String",
117
- # },
118
- # }
119
- # @!attribute [rw] domain_name
120
- # The name of the Elasticsearch domain that you are creating. Domain
121
- # names are unique across the domains owned by an account within an
122
- # AWS region. Domain names must start with a letter or number and can
123
- # contain the following characters: a-z (lowercase), 0-9, and -
124
- # (hyphen).
125
- # @return [String]
126
- #
127
- # @!attribute [rw] elasticsearch_version
128
- # String of format X.Y to specify version for the Elasticsearch domain
129
- # eg. "1.5" or "2.3". For more information, see [Creating
130
- # Elasticsearch Domains][1] in the *Amazon Elasticsearch Service
131
- # Developer Guide*.
132
- #
133
- #
134
- #
135
- # [1]: http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomains
136
- # @return [String]
137
- #
138
- # @!attribute [rw] elasticsearch_cluster_config
139
- # Configuration options for an Elasticsearch domain. Specifies the
140
- # instance type and number of instances in the domain cluster.
141
- # @return [Types::ElasticsearchClusterConfig]
142
- #
143
- # @!attribute [rw] ebs_options
144
- # Options to enable, disable and specify the type and size of EBS
145
- # storage volumes.
146
- # @return [Types::EBSOptions]
147
- #
148
- # @!attribute [rw] access_policies
149
- # IAM access policy as a JSON-formatted string.
150
- # @return [String]
151
- #
152
- # @!attribute [rw] snapshot_options
153
- # Option to set time, in UTC format, of the daily automated snapshot.
154
- # Default value is 0 hours.
155
- # @return [Types::SnapshotOptions]
156
- #
157
- # @!attribute [rw] advanced_options
158
- # Option to allow references to indices in an HTTP request body. Must
159
- # be `false` when configuring access to individual sub-resources. By
160
- # default, the value is `true`. See [Configuration Advanced
161
- # Options][1] for more information.
162
- #
163
- #
164
- #
165
- # [1]: http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options
166
- # @return [Hash<String,String>]
167
- class CreateElasticsearchDomainRequest < Struct.new(
168
- :domain_name,
169
- :elasticsearch_version,
170
- :elasticsearch_cluster_config,
171
- :ebs_options,
172
- :access_policies,
173
- :snapshot_options,
174
- :advanced_options)
175
- include Aws::Structure
176
- end
177
-
178
- # The result of a `CreateElasticsearchDomain` operation. Contains the
179
- # status of the newly created Elasticsearch domain.
180
- # @!attribute [rw] domain_status
181
- # The status of the newly created Elasticsearch domain.
182
- # @return [Types::ElasticsearchDomainStatus]
183
- class CreateElasticsearchDomainResponse < Struct.new(
184
- :domain_status)
185
- include Aws::Structure
186
- end
187
-
188
- # Container for the parameters to the `DeleteElasticsearchDomain`
189
- # operation. Specifies the name of the Elasticsearch domain that you
190
- # want to delete.
191
- # @note When making an API call, pass DeleteElasticsearchDomainRequest
192
- # data as a hash:
193
- #
194
- # {
195
- # domain_name: "DomainName", # required
196
- # }
197
- # @!attribute [rw] domain_name
198
- # The name of the Elasticsearch domain that you want to permanently
199
- # delete.
200
- # @return [String]
201
- class DeleteElasticsearchDomainRequest < Struct.new(
202
- :domain_name)
203
- include Aws::Structure
204
- end
205
-
206
- # The result of a `DeleteElasticsearchDomain` request. Contains the
207
- # status of the pending deletion, or no status if the domain and all of
208
- # its resources have been deleted.
209
- # @!attribute [rw] domain_status
210
- # The status of the Elasticsearch domain being deleted.
211
- # @return [Types::ElasticsearchDomainStatus]
212
- class DeleteElasticsearchDomainResponse < Struct.new(
213
- :domain_status)
214
- include Aws::Structure
215
- end
216
-
217
- # Container for the parameters to the
218
- # `DescribeElasticsearchDomainConfig` operation. Specifies the domain
219
- # name for which you want configuration information.
220
- # @note When making an API call, pass DescribeElasticsearchDomainConfigRequest
221
- # data as a hash:
222
- #
223
- # {
224
- # domain_name: "DomainName", # required
225
- # }
226
- # @!attribute [rw] domain_name
227
- # The Elasticsearch domain that you want to get information about.
228
- # @return [String]
229
- class DescribeElasticsearchDomainConfigRequest < Struct.new(
230
- :domain_name)
231
- include Aws::Structure
232
- end
233
-
234
- # The result of a `DescribeElasticsearchDomainConfig` request. Contains
235
- # the configuration information of the requested domain.
236
- # @!attribute [rw] domain_config
237
- # The configuration information of the domain requested in the
238
- # `DescribeElasticsearchDomainConfig` request.
239
- # @return [Types::ElasticsearchDomainConfig]
240
- class DescribeElasticsearchDomainConfigResponse < Struct.new(
241
- :domain_config)
242
- include Aws::Structure
243
- end
244
-
245
- # Container for the parameters to the `DescribeElasticsearchDomain`
246
- # operation.
247
- # @note When making an API call, pass DescribeElasticsearchDomainRequest
248
- # data as a hash:
249
- #
250
- # {
251
- # domain_name: "DomainName", # required
252
- # }
253
- # @!attribute [rw] domain_name
254
- # The name of the Elasticsearch domain for which you want information.
255
- # @return [String]
256
- class DescribeElasticsearchDomainRequest < Struct.new(
257
- :domain_name)
258
- include Aws::Structure
259
- end
260
-
261
- # The result of a `DescribeElasticsearchDomain` request. Contains the
262
- # status of the domain specified in the request.
263
- # @!attribute [rw] domain_status
264
- # The current status of the Elasticsearch domain.
265
- # @return [Types::ElasticsearchDomainStatus]
266
- class DescribeElasticsearchDomainResponse < Struct.new(
267
- :domain_status)
268
- include Aws::Structure
269
- end
270
-
271
- # Container for the parameters to the `DescribeElasticsearchDomains`
272
- # operation. By default, the API returns the status of all Elasticsearch
273
- # domains.
274
- # @note When making an API call, pass DescribeElasticsearchDomainsRequest
275
- # data as a hash:
276
- #
277
- # {
278
- # domain_names: ["DomainName"], # required
279
- # }
280
- # @!attribute [rw] domain_names
281
- # The Elasticsearch domains for which you want information.
282
- # @return [Array<String>]
283
- class DescribeElasticsearchDomainsRequest < Struct.new(
284
- :domain_names)
285
- include Aws::Structure
286
- end
287
-
288
- # The result of a `DescribeElasticsearchDomains` request. Contains the
289
- # status of the specified domains or all domains owned by the account.
290
- # @!attribute [rw] domain_status_list
291
- # The status of the domains requested in the
292
- # `DescribeElasticsearchDomains` request.
293
- # @return [Array<Types::ElasticsearchDomainStatus>]
294
- class DescribeElasticsearchDomainsResponse < Struct.new(
295
- :domain_status_list)
296
- include Aws::Structure
297
- end
298
-
299
- # @!attribute [rw] domain_name
300
- # Specifies the `DomainName`.
301
- # @return [String]
302
- class DomainInfo < Struct.new(
303
- :domain_name)
304
- include Aws::Structure
305
- end
306
-
307
- # Options to enable, disable, and specify the properties of EBS storage
308
- # volumes. For more information, see [ Configuring EBS-based
309
- # Storage][1].
310
- #
311
- #
312
- #
313
- # [1]: http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs
314
- # @note When making an API call, pass EBSOptions
315
- # data as a hash:
316
- #
317
- # {
318
- # ebs_enabled: false,
319
- # volume_type: "standard", # accepts standard, gp2, io1
320
- # volume_size: 1,
321
- # iops: 1,
322
- # }
323
- # @!attribute [rw] ebs_enabled
324
- # Specifies whether EBS-based storage is enabled.
325
- # @return [Boolean]
326
- #
327
- # @!attribute [rw] volume_type
328
- # Specifies the volume type for EBS-based storage.
329
- # @return [String]
330
- #
331
- # @!attribute [rw] volume_size
332
- # Integer to specify the size of an EBS volume.
333
- # @return [Integer]
334
- #
335
- # @!attribute [rw] iops
336
- # Specifies the IOPD for a Provisioned IOPS EBS volume (SSD).
337
- # @return [Integer]
338
- class EBSOptions < Struct.new(
339
- :ebs_enabled,
340
- :volume_type,
341
- :volume_size,
342
- :iops)
343
- include Aws::Structure
344
- end
345
-
346
- # Status of the EBS options for the specified Elasticsearch domain.
347
- # @!attribute [rw] options
348
- # Specifies the EBS options for the specified Elasticsearch domain.
349
- # @return [Types::EBSOptions]
350
- #
351
- # @!attribute [rw] status
352
- # Specifies the status of the EBS options for the specified
353
- # Elasticsearch domain.
354
- # @return [Types::OptionStatus]
355
- class EBSOptionsStatus < Struct.new(
356
- :options,
357
- :status)
358
- include Aws::Structure
359
- end
360
-
361
- # Specifies the configuration for the domain cluster, such as the type
362
- # and number of instances.
363
- # @note When making an API call, pass ElasticsearchClusterConfig
364
- # data as a hash:
365
- #
366
- # {
367
- # instance_type: "m3.medium.elasticsearch", # accepts m3.medium.elasticsearch, m3.large.elasticsearch, m3.xlarge.elasticsearch, m3.2xlarge.elasticsearch, m4.large.elasticsearch, m4.xlarge.elasticsearch, m4.2xlarge.elasticsearch, m4.4xlarge.elasticsearch, m4.10xlarge.elasticsearch, t2.micro.elasticsearch, t2.small.elasticsearch, t2.medium.elasticsearch, r3.large.elasticsearch, r3.xlarge.elasticsearch, r3.2xlarge.elasticsearch, r3.4xlarge.elasticsearch, r3.8xlarge.elasticsearch, i2.xlarge.elasticsearch, i2.2xlarge.elasticsearch
368
- # instance_count: 1,
369
- # dedicated_master_enabled: false,
370
- # zone_awareness_enabled: false,
371
- # dedicated_master_type: "m3.medium.elasticsearch", # accepts m3.medium.elasticsearch, m3.large.elasticsearch, m3.xlarge.elasticsearch, m3.2xlarge.elasticsearch, m4.large.elasticsearch, m4.xlarge.elasticsearch, m4.2xlarge.elasticsearch, m4.4xlarge.elasticsearch, m4.10xlarge.elasticsearch, t2.micro.elasticsearch, t2.small.elasticsearch, t2.medium.elasticsearch, r3.large.elasticsearch, r3.xlarge.elasticsearch, r3.2xlarge.elasticsearch, r3.4xlarge.elasticsearch, r3.8xlarge.elasticsearch, i2.xlarge.elasticsearch, i2.2xlarge.elasticsearch
372
- # dedicated_master_count: 1,
373
- # }
374
- # @!attribute [rw] instance_type
375
- # The instance type for an Elasticsearch cluster.
376
- # @return [String]
377
- #
378
- # @!attribute [rw] instance_count
379
- # The number of instances in the specified domain cluster.
380
- # @return [Integer]
381
- #
382
- # @!attribute [rw] dedicated_master_enabled
383
- # A boolean value to indicate whether a dedicated master node is
384
- # enabled. See [About Dedicated Master Nodes][1] for more information.
385
- #
386
- #
387
- #
388
- # [1]: http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-managedomains.html#es-managedomains-dedicatedmasternodes
389
- # @return [Boolean]
390
- #
391
- # @!attribute [rw] zone_awareness_enabled
392
- # A boolean value to indicate whether zone awareness is enabled. See
393
- # [About Zone Awareness][1] for more information.
394
- #
395
- #
396
- #
397
- # [1]: http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-managedomains.html#es-managedomains-zoneawareness
398
- # @return [Boolean]
399
- #
400
- # @!attribute [rw] dedicated_master_type
401
- # The instance type for a dedicated master node.
402
- # @return [String]
403
- #
404
- # @!attribute [rw] dedicated_master_count
405
- # Total number of dedicated master nodes, active and on standby, for
406
- # the cluster.
407
- # @return [Integer]
408
- class ElasticsearchClusterConfig < Struct.new(
409
- :instance_type,
410
- :instance_count,
411
- :dedicated_master_enabled,
412
- :zone_awareness_enabled,
413
- :dedicated_master_type,
414
- :dedicated_master_count)
415
- include Aws::Structure
416
- end
417
-
418
- # Specifies the configuration status for the specified Elasticsearch
419
- # domain.
420
- # @!attribute [rw] options
421
- # Specifies the cluster configuration for the specified Elasticsearch
422
- # domain.
423
- # @return [Types::ElasticsearchClusterConfig]
424
- #
425
- # @!attribute [rw] status
426
- # Specifies the status of the configuration for the specified
427
- # Elasticsearch domain.
428
- # @return [Types::OptionStatus]
429
- class ElasticsearchClusterConfigStatus < Struct.new(
430
- :options,
431
- :status)
432
- include Aws::Structure
433
- end
434
-
435
- # The configuration of an Elasticsearch domain.
436
- # @!attribute [rw] elasticsearch_version
437
- # String of format X.Y to specify version for the Elasticsearch
438
- # domain.
439
- # @return [Types::ElasticsearchVersionStatus]
440
- #
441
- # @!attribute [rw] elasticsearch_cluster_config
442
- # Specifies the `ElasticsearchClusterConfig` for the Elasticsearch
443
- # domain.
444
- # @return [Types::ElasticsearchClusterConfigStatus]
445
- #
446
- # @!attribute [rw] ebs_options
447
- # Specifies the `EBSOptions` for the Elasticsearch domain.
448
- # @return [Types::EBSOptionsStatus]
449
- #
450
- # @!attribute [rw] access_policies
451
- # IAM access policy as a JSON-formatted string.
452
- # @return [Types::AccessPoliciesStatus]
453
- #
454
- # @!attribute [rw] snapshot_options
455
- # Specifies the `SnapshotOptions` for the Elasticsearch domain.
456
- # @return [Types::SnapshotOptionsStatus]
457
- #
458
- # @!attribute [rw] advanced_options
459
- # Specifies the `AdvancedOptions` for the domain. See [Configuring
460
- # Advanced Options][1] for more information.
461
- #
462
- #
463
- #
464
- # [1]: http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options
465
- # @return [Types::AdvancedOptionsStatus]
466
- class ElasticsearchDomainConfig < Struct.new(
467
- :elasticsearch_version,
468
- :elasticsearch_cluster_config,
469
- :ebs_options,
470
- :access_policies,
471
- :snapshot_options,
472
- :advanced_options)
473
- include Aws::Structure
474
- end
475
-
476
- # The current status of an Elasticsearch domain.
477
- # @!attribute [rw] domain_id
478
- # The unique identifier for the specified Elasticsearch domain.
479
- # @return [String]
480
- #
481
- # @!attribute [rw] domain_name
482
- # The name of an Elasticsearch domain. Domain names are unique across
483
- # the domains owned by an account within an AWS region. Domain names
484
- # start with a letter or number and can contain the following
485
- # characters: a-z (lowercase), 0-9, and - (hyphen).
486
- # @return [String]
487
- #
488
- # @!attribute [rw] arn
489
- # The Amazon resource name (ARN) of an Elasticsearch domain. See
490
- # [Identifiers for IAM Entities][1] in *Using AWS Identity and Access
491
- # Management* for more information.
492
- #
493
- #
494
- #
495
- # [1]: http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html
496
- # @return [String]
497
- #
498
- # @!attribute [rw] created
499
- # The domain creation status. `True` if the creation of an
500
- # Elasticsearch domain is complete. `False` if domain creation is
501
- # still in progress.
502
- # @return [Boolean]
503
- #
504
- # @!attribute [rw] deleted
505
- # The domain deletion status. `True` if a delete request has been
506
- # received for the domain but resource cleanup is still in progress.
507
- # `False` if the domain has not been deleted. Once domain deletion is
508
- # complete, the status of the domain is no longer returned.
509
- # @return [Boolean]
510
- #
511
- # @!attribute [rw] endpoint
512
- # The Elasticsearch domain endpoint that you use to submit index and
513
- # search requests.
514
- # @return [String]
515
- #
516
- # @!attribute [rw] processing
517
- # The status of the Elasticsearch domain configuration. `True` if
518
- # Amazon Elasticsearch Service is processing configuration changes.
519
- # `False` if the configuration is active.
520
- # @return [Boolean]
521
- #
522
- # @!attribute [rw] elasticsearch_version
523
- # @return [String]
524
- #
525
- # @!attribute [rw] elasticsearch_cluster_config
526
- # The type and number of instances in the domain cluster.
527
- # @return [Types::ElasticsearchClusterConfig]
528
- #
529
- # @!attribute [rw] ebs_options
530
- # The `EBSOptions` for the specified domain. See [Configuring
531
- # EBS-based Storage][1] for more information.
532
- #
533
- #
534
- #
535
- # [1]: http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs
536
- # @return [Types::EBSOptions]
537
- #
538
- # @!attribute [rw] access_policies
539
- # IAM access policy as a JSON-formatted string.
540
- # @return [String]
541
- #
542
- # @!attribute [rw] snapshot_options
543
- # Specifies the status of the `SnapshotOptions`
544
- # @return [Types::SnapshotOptions]
545
- #
546
- # @!attribute [rw] advanced_options
547
- # Specifies the status of the `AdvancedOptions`
548
- # @return [Hash<String,String>]
549
- class ElasticsearchDomainStatus < Struct.new(
550
- :domain_id,
551
- :domain_name,
552
- :arn,
553
- :created,
554
- :deleted,
555
- :endpoint,
556
- :processing,
557
- :elasticsearch_version,
558
- :elasticsearch_cluster_config,
559
- :ebs_options,
560
- :access_policies,
561
- :snapshot_options,
562
- :advanced_options)
563
- include Aws::Structure
564
- end
565
-
566
- # Status of the Elasticsearch version options for the specified
567
- # Elasticsearch domain.
568
- # @!attribute [rw] options
569
- # Specifies the Elasticsearch version for the specified Elasticsearch
570
- # domain.
571
- # @return [String]
572
- #
573
- # @!attribute [rw] status
574
- # Specifies the status of the Elasticsearch version options for the
575
- # specified Elasticsearch domain.
576
- # @return [Types::OptionStatus]
577
- class ElasticsearchVersionStatus < Struct.new(
578
- :options,
579
- :status)
580
- include Aws::Structure
581
- end
582
-
583
- # The result of a `ListDomainNames` operation. Contains the names of all
584
- # Elasticsearch domains owned by this account.
585
- # @!attribute [rw] domain_names
586
- # List of Elasticsearch domain names.
587
- # @return [Array<Types::DomainInfo>]
588
- class ListDomainNamesResponse < Struct.new(
589
- :domain_names)
590
- include Aws::Structure
591
- end
592
-
593
- # Container for the parameters to the `ListTags` operation. Specify the
594
- # `ARN` for the Elasticsearch domain to which the tags are attached that
595
- # you want to view are attached.
596
- # @note When making an API call, pass ListTagsRequest
597
- # data as a hash:
598
- #
599
- # {
600
- # arn: "ARN", # required
601
- # }
602
- # @!attribute [rw] arn
603
- # Specify the `ARN` for the Elasticsearch domain to which the tags are
604
- # attached that you want to view.
605
- # @return [String]
606
- class ListTagsRequest < Struct.new(
607
- :arn)
608
- include Aws::Structure
609
- end
610
-
611
- # The result of a `ListTags` operation. Contains tags for all requested
612
- # Elasticsearch domains.
613
- # @!attribute [rw] tag_list
614
- # List of `Tag` for the requested Elasticsearch domain.
615
- # @return [Array<Types::Tag>]
616
- class ListTagsResponse < Struct.new(
617
- :tag_list)
618
- include Aws::Structure
619
- end
620
-
621
- # Provides the current status of the entity.
622
- # @!attribute [rw] creation_date
623
- # Timestamp which tells the creation date for the entity.
624
- # @return [Time]
625
- #
626
- # @!attribute [rw] update_date
627
- # Timestamp which tells the last updated time for the entity.
628
- # @return [Time]
629
- #
630
- # @!attribute [rw] update_version
631
- # Specifies the latest version for the entity.
632
- # @return [Integer]
633
- #
634
- # @!attribute [rw] state
635
- # Provides the `OptionState` for the Elasticsearch domain.
636
- # @return [String]
637
- #
638
- # @!attribute [rw] pending_deletion
639
- # Indicates whether the Elasticsearch domain is being deleted.
640
- # @return [Boolean]
641
- class OptionStatus < Struct.new(
642
- :creation_date,
643
- :update_date,
644
- :update_version,
645
- :state,
646
- :pending_deletion)
647
- include Aws::Structure
648
- end
649
-
650
- # Container for the parameters to the `RemoveTags` operation. Specify
651
- # the `ARN` for the Elasticsearch domain from which you want to remove
652
- # the specified `TagKey`.
653
- # @note When making an API call, pass RemoveTagsRequest
654
- # data as a hash:
655
- #
656
- # {
657
- # arn: "ARN", # required
658
- # tag_keys: ["String"], # required
659
- # }
660
- # @!attribute [rw] arn
661
- # Specifies the `ARN` for the Elasticsearch domain from which you want
662
- # to delete the specified tags.
663
- # @return [String]
664
- #
665
- # @!attribute [rw] tag_keys
666
- # Specifies the `TagKey` list which you want to remove from the
667
- # Elasticsearch domain.
668
- # @return [Array<String>]
669
- class RemoveTagsRequest < Struct.new(
670
- :arn,
671
- :tag_keys)
672
- include Aws::Structure
673
- end
674
-
675
- # Specifies the time, in UTC format, when the service takes a daily
676
- # automated snapshot of the specified Elasticsearch domain. Default
677
- # value is `0` hours.
678
- # @note When making an API call, pass SnapshotOptions
679
- # data as a hash:
680
- #
681
- # {
682
- # automated_snapshot_start_hour: 1,
683
- # }
684
- # @!attribute [rw] automated_snapshot_start_hour
685
- # Specifies the time, in UTC format, when the service takes a daily
686
- # automated snapshot of the specified Elasticsearch domain. Default
687
- # value is `0` hours.
688
- # @return [Integer]
689
- class SnapshotOptions < Struct.new(
690
- :automated_snapshot_start_hour)
691
- include Aws::Structure
692
- end
693
-
694
- # Status of a daily automated snapshot.
695
- # @!attribute [rw] options
696
- # Specifies the daily snapshot options specified for the Elasticsearch
697
- # domain.
698
- # @return [Types::SnapshotOptions]
699
- #
700
- # @!attribute [rw] status
701
- # Specifies the status of a daily automated snapshot.
702
- # @return [Types::OptionStatus]
703
- class SnapshotOptionsStatus < Struct.new(
704
- :options,
705
- :status)
706
- include Aws::Structure
707
- end
708
-
709
- # Specifies a key value pair for a resource tag.
710
- # @note When making an API call, pass Tag
711
- # data as a hash:
712
- #
713
- # {
714
- # key: "TagKey", # required
715
- # value: "TagValue", # required
716
- # }
717
- # @!attribute [rw] key
718
- # Specifies the `TagKey`, the name of the tag. Tag keys must be unique
719
- # for the Elasticsearch domain to which they are attached.
720
- # @return [String]
721
- #
722
- # @!attribute [rw] value
723
- # Specifies the `TagValue`, the value assigned to the corresponding
724
- # tag key. Tag values can be null and do not have to be unique in a
725
- # tag set. For example, you can have a key value pair in a tag set of
726
- # `project : Trinity` and `cost-center : Trinity`
727
- # @return [String]
728
- class Tag < Struct.new(
729
- :key,
730
- :value)
731
- include Aws::Structure
732
- end
733
-
734
- # Container for the parameters to the `UpdateElasticsearchDomain`
735
- # operation. Specifies the type and number of instances in the domain
736
- # cluster.
737
- # @note When making an API call, pass UpdateElasticsearchDomainConfigRequest
738
- # data as a hash:
739
- #
740
- # {
741
- # domain_name: "DomainName", # required
742
- # elasticsearch_cluster_config: {
743
- # instance_type: "m3.medium.elasticsearch", # accepts m3.medium.elasticsearch, m3.large.elasticsearch, m3.xlarge.elasticsearch, m3.2xlarge.elasticsearch, m4.large.elasticsearch, m4.xlarge.elasticsearch, m4.2xlarge.elasticsearch, m4.4xlarge.elasticsearch, m4.10xlarge.elasticsearch, t2.micro.elasticsearch, t2.small.elasticsearch, t2.medium.elasticsearch, r3.large.elasticsearch, r3.xlarge.elasticsearch, r3.2xlarge.elasticsearch, r3.4xlarge.elasticsearch, r3.8xlarge.elasticsearch, i2.xlarge.elasticsearch, i2.2xlarge.elasticsearch
744
- # instance_count: 1,
745
- # dedicated_master_enabled: false,
746
- # zone_awareness_enabled: false,
747
- # dedicated_master_type: "m3.medium.elasticsearch", # accepts m3.medium.elasticsearch, m3.large.elasticsearch, m3.xlarge.elasticsearch, m3.2xlarge.elasticsearch, m4.large.elasticsearch, m4.xlarge.elasticsearch, m4.2xlarge.elasticsearch, m4.4xlarge.elasticsearch, m4.10xlarge.elasticsearch, t2.micro.elasticsearch, t2.small.elasticsearch, t2.medium.elasticsearch, r3.large.elasticsearch, r3.xlarge.elasticsearch, r3.2xlarge.elasticsearch, r3.4xlarge.elasticsearch, r3.8xlarge.elasticsearch, i2.xlarge.elasticsearch, i2.2xlarge.elasticsearch
748
- # dedicated_master_count: 1,
749
- # },
750
- # ebs_options: {
751
- # ebs_enabled: false,
752
- # volume_type: "standard", # accepts standard, gp2, io1
753
- # volume_size: 1,
754
- # iops: 1,
755
- # },
756
- # snapshot_options: {
757
- # automated_snapshot_start_hour: 1,
758
- # },
759
- # advanced_options: {
760
- # "String" => "String",
761
- # },
762
- # access_policies: "PolicyDocument",
763
- # }
764
- # @!attribute [rw] domain_name
765
- # The name of the Elasticsearch domain that you are updating.
766
- # @return [String]
767
- #
768
- # @!attribute [rw] elasticsearch_cluster_config
769
- # The type and number of instances to instantiate for the domain
770
- # cluster.
771
- # @return [Types::ElasticsearchClusterConfig]
772
- #
773
- # @!attribute [rw] ebs_options
774
- # Specify the type and size of the EBS volume that you want to use.
775
- # @return [Types::EBSOptions]
776
- #
777
- # @!attribute [rw] snapshot_options
778
- # Option to set the time, in UTC format, for the daily automated
779
- # snapshot. Default value is `0` hours.
780
- # @return [Types::SnapshotOptions]
781
- #
782
- # @!attribute [rw] advanced_options
783
- # Modifies the advanced option to allow references to indices in an
784
- # HTTP request body. Must be `false` when configuring access to
785
- # individual sub-resources. By default, the value is `true`. See
786
- # [Configuration Advanced Options][1] for more information.
787
- #
788
- #
789
- #
790
- # [1]: http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options
791
- # @return [Hash<String,String>]
792
- #
793
- # @!attribute [rw] access_policies
794
- # IAM access policy as a JSON-formatted string.
795
- # @return [String]
796
- class UpdateElasticsearchDomainConfigRequest < Struct.new(
797
- :domain_name,
798
- :elasticsearch_cluster_config,
799
- :ebs_options,
800
- :snapshot_options,
801
- :advanced_options,
802
- :access_policies)
803
- include Aws::Structure
804
- end
805
-
806
- # The result of an `UpdateElasticsearchDomain` request. Contains the
807
- # status of the Elasticsearch domain being updated.
808
- # @!attribute [rw] domain_config
809
- # The status of the updated Elasticsearch domain.
810
- # @return [Types::ElasticsearchDomainConfig]
811
- class UpdateElasticsearchDomainConfigResponse < Struct.new(
812
- :domain_config)
813
- include Aws::Structure
814
- end
8
+ module Aws::ElasticsearchService
9
+ module Types
815
10
 
11
+ # The configured access rules for the domain's document and search
12
+ # endpoints, and the current status of those rules.
13
+ #
14
+ # @!attribute [rw] options
15
+ # The access policy configured for the Elasticsearch domain. Access
16
+ # policies may be resource-based, IP-based, or IAM-based. See [
17
+ # Configuring Access Policies][1]for more information.
18
+ #
19
+ #
20
+ #
21
+ # [1]: http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-access-policies
22
+ # @return [String]
23
+ #
24
+ # @!attribute [rw] status
25
+ # The status of the access policy for the Elasticsearch domain. See
26
+ # `OptionStatus` for the status information that's included.
27
+ # @return [Types::OptionStatus]
28
+ #
29
+ class AccessPoliciesStatus < Struct.new(
30
+ :options,
31
+ :status)
32
+ include Aws::Structure
816
33
  end
34
+
35
+ # Container for the parameters to the `AddTags` operation. Specify the
36
+ # tags that you want to attach to the Elasticsearch domain.
37
+ #
38
+ # @note When making an API call, you may pass AddTagsRequest
39
+ # data as a hash:
40
+ #
41
+ # {
42
+ # arn: "ARN", # required
43
+ # tag_list: [ # required
44
+ # {
45
+ # key: "TagKey", # required
46
+ # value: "TagValue", # required
47
+ # },
48
+ # ],
49
+ # }
50
+ #
51
+ # @!attribute [rw] arn
52
+ # Specify the `ARN` for which you want to add the tags.
53
+ # @return [String]
54
+ #
55
+ # @!attribute [rw] tag_list
56
+ # List of `Tag` that need to be added for the Elasticsearch domain.
57
+ # @return [Array<Types::Tag>]
58
+ #
59
+ class AddTagsRequest < Struct.new(
60
+ :arn,
61
+ :tag_list)
62
+ include Aws::Structure
63
+ end
64
+
65
+ # List of limits that are specific to a given InstanceType and for each
66
+ # of it's ` InstanceRole ` .
67
+ #
68
+ # @!attribute [rw] limit_name
69
+ # Name of Additional Limit is specific to a given InstanceType and for
70
+ # each of it's ` InstanceRole ` etc.
71
+ # Attributes and their details:
72
+ # * MaximumNumberOfDataNodesSupported
73
+ # ` ESPartitionInstanceType `*
74
+ # MaximumNumberOfDataNodesWithoutMasterNode
75
+ # ` ESPartitionInstanceType `
76
+ # @return [String]
77
+ #
78
+ # @!attribute [rw] limit_values
79
+ # Value for given ` AdditionalLimit$LimitName ` .
80
+ # @return [Array<String>]
81
+ #
82
+ class AdditionalLimit < Struct.new(
83
+ :limit_name,
84
+ :limit_values)
85
+ include Aws::Structure
86
+ end
87
+
88
+ # Status of the advanced options for the specified Elasticsearch domain.
89
+ # Currently, the following advanced options are available:
90
+ #
91
+ # * Option to allow references to indices in an HTTP request body. Must
92
+ # be `false` when configuring access to individual sub-resources. By
93
+ # default, the value is `true`. See [Configuration Advanced
94
+ # Options][1] for more information.
95
+ # * Option to specify the percentage of heap space that is allocated to
96
+ # field data. By default, this setting is unbounded.
97
+ #
98
+ # For more information, see [Configuring Advanced Options][1].
99
+ #
100
+ #
101
+ #
102
+ # [1]: http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options
103
+ #
104
+ # @!attribute [rw] options
105
+ # Specifies the status of advanced options for the specified
106
+ # Elasticsearch domain.
107
+ # @return [Hash<String,String>]
108
+ #
109
+ # @!attribute [rw] status
110
+ # Specifies the status of `OptionStatus` for advanced options for the
111
+ # specified Elasticsearch domain.
112
+ # @return [Types::OptionStatus]
113
+ #
114
+ class AdvancedOptionsStatus < Struct.new(
115
+ :options,
116
+ :status)
117
+ include Aws::Structure
118
+ end
119
+
120
+ # @note When making an API call, you may pass CreateElasticsearchDomainRequest
121
+ # data as a hash:
122
+ #
123
+ # {
124
+ # domain_name: "DomainName", # required
125
+ # elasticsearch_version: "ElasticsearchVersionString",
126
+ # elasticsearch_cluster_config: {
127
+ # instance_type: "m3.medium.elasticsearch", # accepts m3.medium.elasticsearch, m3.large.elasticsearch, m3.xlarge.elasticsearch, m3.2xlarge.elasticsearch, m4.large.elasticsearch, m4.xlarge.elasticsearch, m4.2xlarge.elasticsearch, m4.4xlarge.elasticsearch, m4.10xlarge.elasticsearch, t2.micro.elasticsearch, t2.small.elasticsearch, t2.medium.elasticsearch, r3.large.elasticsearch, r3.xlarge.elasticsearch, r3.2xlarge.elasticsearch, r3.4xlarge.elasticsearch, r3.8xlarge.elasticsearch, i2.xlarge.elasticsearch, i2.2xlarge.elasticsearch, d2.xlarge.elasticsearch, d2.2xlarge.elasticsearch, d2.4xlarge.elasticsearch, d2.8xlarge.elasticsearch, c4.large.elasticsearch, c4.xlarge.elasticsearch, c4.2xlarge.elasticsearch, c4.4xlarge.elasticsearch, c4.8xlarge.elasticsearch, r4.large.elasticsearch, r4.xlarge.elasticsearch, r4.2xlarge.elasticsearch, r4.4xlarge.elasticsearch, r4.8xlarge.elasticsearch, r4.16xlarge.elasticsearch
128
+ # instance_count: 1,
129
+ # dedicated_master_enabled: false,
130
+ # zone_awareness_enabled: false,
131
+ # dedicated_master_type: "m3.medium.elasticsearch", # accepts m3.medium.elasticsearch, m3.large.elasticsearch, m3.xlarge.elasticsearch, m3.2xlarge.elasticsearch, m4.large.elasticsearch, m4.xlarge.elasticsearch, m4.2xlarge.elasticsearch, m4.4xlarge.elasticsearch, m4.10xlarge.elasticsearch, t2.micro.elasticsearch, t2.small.elasticsearch, t2.medium.elasticsearch, r3.large.elasticsearch, r3.xlarge.elasticsearch, r3.2xlarge.elasticsearch, r3.4xlarge.elasticsearch, r3.8xlarge.elasticsearch, i2.xlarge.elasticsearch, i2.2xlarge.elasticsearch, d2.xlarge.elasticsearch, d2.2xlarge.elasticsearch, d2.4xlarge.elasticsearch, d2.8xlarge.elasticsearch, c4.large.elasticsearch, c4.xlarge.elasticsearch, c4.2xlarge.elasticsearch, c4.4xlarge.elasticsearch, c4.8xlarge.elasticsearch, r4.large.elasticsearch, r4.xlarge.elasticsearch, r4.2xlarge.elasticsearch, r4.4xlarge.elasticsearch, r4.8xlarge.elasticsearch, r4.16xlarge.elasticsearch
132
+ # dedicated_master_count: 1,
133
+ # },
134
+ # ebs_options: {
135
+ # ebs_enabled: false,
136
+ # volume_type: "standard", # accepts standard, gp2, io1
137
+ # volume_size: 1,
138
+ # iops: 1,
139
+ # },
140
+ # access_policies: "PolicyDocument",
141
+ # snapshot_options: {
142
+ # automated_snapshot_start_hour: 1,
143
+ # },
144
+ # advanced_options: {
145
+ # "String" => "String",
146
+ # },
147
+ # }
148
+ #
149
+ # @!attribute [rw] domain_name
150
+ # The name of the Elasticsearch domain that you are creating. Domain
151
+ # names are unique across the domains owned by an account within an
152
+ # AWS region. Domain names must start with a letter or number and can
153
+ # contain the following characters: a-z (lowercase), 0-9, and -
154
+ # (hyphen).
155
+ # @return [String]
156
+ #
157
+ # @!attribute [rw] elasticsearch_version
158
+ # String of format X.Y to specify version for the Elasticsearch domain
159
+ # eg. "1.5" or "2.3". For more information, see [Creating
160
+ # Elasticsearch Domains][1] in the *Amazon Elasticsearch Service
161
+ # Developer Guide*.
162
+ #
163
+ #
164
+ #
165
+ # [1]: http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomains
166
+ # @return [String]
167
+ #
168
+ # @!attribute [rw] elasticsearch_cluster_config
169
+ # Configuration options for an Elasticsearch domain. Specifies the
170
+ # instance type and number of instances in the domain cluster.
171
+ # @return [Types::ElasticsearchClusterConfig]
172
+ #
173
+ # @!attribute [rw] ebs_options
174
+ # Options to enable, disable and specify the type and size of EBS
175
+ # storage volumes.
176
+ # @return [Types::EBSOptions]
177
+ #
178
+ # @!attribute [rw] access_policies
179
+ # IAM access policy as a JSON-formatted string.
180
+ # @return [String]
181
+ #
182
+ # @!attribute [rw] snapshot_options
183
+ # Option to set time, in UTC format, of the daily automated snapshot.
184
+ # Default value is 0 hours.
185
+ # @return [Types::SnapshotOptions]
186
+ #
187
+ # @!attribute [rw] advanced_options
188
+ # Option to allow references to indices in an HTTP request body. Must
189
+ # be `false` when configuring access to individual sub-resources. By
190
+ # default, the value is `true`. See [Configuration Advanced
191
+ # Options][1] for more information.
192
+ #
193
+ #
194
+ #
195
+ # [1]: http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options
196
+ # @return [Hash<String,String>]
197
+ #
198
+ class CreateElasticsearchDomainRequest < Struct.new(
199
+ :domain_name,
200
+ :elasticsearch_version,
201
+ :elasticsearch_cluster_config,
202
+ :ebs_options,
203
+ :access_policies,
204
+ :snapshot_options,
205
+ :advanced_options)
206
+ include Aws::Structure
207
+ end
208
+
209
+ # The result of a `CreateElasticsearchDomain` operation. Contains the
210
+ # status of the newly created Elasticsearch domain.
211
+ #
212
+ # @!attribute [rw] domain_status
213
+ # The status of the newly created Elasticsearch domain.
214
+ # @return [Types::ElasticsearchDomainStatus]
215
+ #
216
+ class CreateElasticsearchDomainResponse < Struct.new(
217
+ :domain_status)
218
+ include Aws::Structure
219
+ end
220
+
221
+ # Container for the parameters to the `DeleteElasticsearchDomain`
222
+ # operation. Specifies the name of the Elasticsearch domain that you
223
+ # want to delete.
224
+ #
225
+ # @note When making an API call, you may pass DeleteElasticsearchDomainRequest
226
+ # data as a hash:
227
+ #
228
+ # {
229
+ # domain_name: "DomainName", # required
230
+ # }
231
+ #
232
+ # @!attribute [rw] domain_name
233
+ # The name of the Elasticsearch domain that you want to permanently
234
+ # delete.
235
+ # @return [String]
236
+ #
237
+ class DeleteElasticsearchDomainRequest < Struct.new(
238
+ :domain_name)
239
+ include Aws::Structure
240
+ end
241
+
242
+ # The result of a `DeleteElasticsearchDomain` request. Contains the
243
+ # status of the pending deletion, or no status if the domain and all of
244
+ # its resources have been deleted.
245
+ #
246
+ # @!attribute [rw] domain_status
247
+ # The status of the Elasticsearch domain being deleted.
248
+ # @return [Types::ElasticsearchDomainStatus]
249
+ #
250
+ class DeleteElasticsearchDomainResponse < Struct.new(
251
+ :domain_status)
252
+ include Aws::Structure
253
+ end
254
+
255
+ # Container for the parameters to the
256
+ # `DescribeElasticsearchDomainConfig` operation. Specifies the domain
257
+ # name for which you want configuration information.
258
+ #
259
+ # @note When making an API call, you may pass DescribeElasticsearchDomainConfigRequest
260
+ # data as a hash:
261
+ #
262
+ # {
263
+ # domain_name: "DomainName", # required
264
+ # }
265
+ #
266
+ # @!attribute [rw] domain_name
267
+ # The Elasticsearch domain that you want to get information about.
268
+ # @return [String]
269
+ #
270
+ class DescribeElasticsearchDomainConfigRequest < Struct.new(
271
+ :domain_name)
272
+ include Aws::Structure
273
+ end
274
+
275
+ # The result of a `DescribeElasticsearchDomainConfig` request. Contains
276
+ # the configuration information of the requested domain.
277
+ #
278
+ # @!attribute [rw] domain_config
279
+ # The configuration information of the domain requested in the
280
+ # `DescribeElasticsearchDomainConfig` request.
281
+ # @return [Types::ElasticsearchDomainConfig]
282
+ #
283
+ class DescribeElasticsearchDomainConfigResponse < Struct.new(
284
+ :domain_config)
285
+ include Aws::Structure
286
+ end
287
+
288
+ # Container for the parameters to the `DescribeElasticsearchDomain`
289
+ # operation.
290
+ #
291
+ # @note When making an API call, you may pass DescribeElasticsearchDomainRequest
292
+ # data as a hash:
293
+ #
294
+ # {
295
+ # domain_name: "DomainName", # required
296
+ # }
297
+ #
298
+ # @!attribute [rw] domain_name
299
+ # The name of the Elasticsearch domain for which you want information.
300
+ # @return [String]
301
+ #
302
+ class DescribeElasticsearchDomainRequest < Struct.new(
303
+ :domain_name)
304
+ include Aws::Structure
305
+ end
306
+
307
+ # The result of a `DescribeElasticsearchDomain` request. Contains the
308
+ # status of the domain specified in the request.
309
+ #
310
+ # @!attribute [rw] domain_status
311
+ # The current status of the Elasticsearch domain.
312
+ # @return [Types::ElasticsearchDomainStatus]
313
+ #
314
+ class DescribeElasticsearchDomainResponse < Struct.new(
315
+ :domain_status)
316
+ include Aws::Structure
317
+ end
318
+
319
+ # Container for the parameters to the `DescribeElasticsearchDomains`
320
+ # operation. By default, the API returns the status of all Elasticsearch
321
+ # domains.
322
+ #
323
+ # @note When making an API call, you may pass DescribeElasticsearchDomainsRequest
324
+ # data as a hash:
325
+ #
326
+ # {
327
+ # domain_names: ["DomainName"], # required
328
+ # }
329
+ #
330
+ # @!attribute [rw] domain_names
331
+ # The Elasticsearch domains for which you want information.
332
+ # @return [Array<String>]
333
+ #
334
+ class DescribeElasticsearchDomainsRequest < Struct.new(
335
+ :domain_names)
336
+ include Aws::Structure
337
+ end
338
+
339
+ # The result of a `DescribeElasticsearchDomains` request. Contains the
340
+ # status of the specified domains or all domains owned by the account.
341
+ #
342
+ # @!attribute [rw] domain_status_list
343
+ # The status of the domains requested in the
344
+ # `DescribeElasticsearchDomains` request.
345
+ # @return [Array<Types::ElasticsearchDomainStatus>]
346
+ #
347
+ class DescribeElasticsearchDomainsResponse < Struct.new(
348
+ :domain_status_list)
349
+ include Aws::Structure
350
+ end
351
+
352
+ # Container for the parameters to `
353
+ # DescribeElasticsearchInstanceTypeLimits ` operation.
354
+ #
355
+ # @note When making an API call, you may pass DescribeElasticsearchInstanceTypeLimitsRequest
356
+ # data as a hash:
357
+ #
358
+ # {
359
+ # domain_name: "DomainName",
360
+ # instance_type: "m3.medium.elasticsearch", # required, accepts m3.medium.elasticsearch, m3.large.elasticsearch, m3.xlarge.elasticsearch, m3.2xlarge.elasticsearch, m4.large.elasticsearch, m4.xlarge.elasticsearch, m4.2xlarge.elasticsearch, m4.4xlarge.elasticsearch, m4.10xlarge.elasticsearch, t2.micro.elasticsearch, t2.small.elasticsearch, t2.medium.elasticsearch, r3.large.elasticsearch, r3.xlarge.elasticsearch, r3.2xlarge.elasticsearch, r3.4xlarge.elasticsearch, r3.8xlarge.elasticsearch, i2.xlarge.elasticsearch, i2.2xlarge.elasticsearch, d2.xlarge.elasticsearch, d2.2xlarge.elasticsearch, d2.4xlarge.elasticsearch, d2.8xlarge.elasticsearch, c4.large.elasticsearch, c4.xlarge.elasticsearch, c4.2xlarge.elasticsearch, c4.4xlarge.elasticsearch, c4.8xlarge.elasticsearch, r4.large.elasticsearch, r4.xlarge.elasticsearch, r4.2xlarge.elasticsearch, r4.4xlarge.elasticsearch, r4.8xlarge.elasticsearch, r4.16xlarge.elasticsearch
361
+ # elasticsearch_version: "ElasticsearchVersionString", # required
362
+ # }
363
+ #
364
+ # @!attribute [rw] domain_name
365
+ # DomainName represents the name of the Domain that we are trying to
366
+ # modify. This should be present only if we are querying for
367
+ # Elasticsearch ` Limits ` for existing domain.
368
+ # @return [String]
369
+ #
370
+ # @!attribute [rw] instance_type
371
+ # The instance type for an Elasticsearch cluster for which
372
+ # Elasticsearch ` Limits ` are needed.
373
+ # @return [String]
374
+ #
375
+ # @!attribute [rw] elasticsearch_version
376
+ # Version of Elasticsearch for which ` Limits ` are needed.
377
+ # @return [String]
378
+ #
379
+ class DescribeElasticsearchInstanceTypeLimitsRequest < Struct.new(
380
+ :domain_name,
381
+ :instance_type,
382
+ :elasticsearch_version)
383
+ include Aws::Structure
384
+ end
385
+
386
+ # Container for the parameters received from `
387
+ # DescribeElasticsearchInstanceTypeLimits ` operation.
388
+ #
389
+ # @!attribute [rw] limits_by_role
390
+ # Map of Role of the Instance and Limits that are applicable. Role
391
+ # performed by given Instance in Elasticsearch can be one of the
392
+ # following: * Data: If the given InstanceType is used as Data node
393
+ # * Master: If the given InstanceType is used as Master node
394
+ # @return [Hash<String,Types::Limits>]
395
+ #
396
+ class DescribeElasticsearchInstanceTypeLimitsResponse < Struct.new(
397
+ :limits_by_role)
398
+ include Aws::Structure
399
+ end
400
+
401
+ # @!attribute [rw] domain_name
402
+ # Specifies the `DomainName`.
403
+ # @return [String]
404
+ #
405
+ class DomainInfo < Struct.new(
406
+ :domain_name)
407
+ include Aws::Structure
408
+ end
409
+
410
+ # Options to enable, disable, and specify the properties of EBS storage
411
+ # volumes. For more information, see [ Configuring EBS-based
412
+ # Storage][1].
413
+ #
414
+ #
415
+ #
416
+ # [1]: http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs
417
+ #
418
+ # @note When making an API call, you may pass EBSOptions
419
+ # data as a hash:
420
+ #
421
+ # {
422
+ # ebs_enabled: false,
423
+ # volume_type: "standard", # accepts standard, gp2, io1
424
+ # volume_size: 1,
425
+ # iops: 1,
426
+ # }
427
+ #
428
+ # @!attribute [rw] ebs_enabled
429
+ # Specifies whether EBS-based storage is enabled.
430
+ # @return [Boolean]
431
+ #
432
+ # @!attribute [rw] volume_type
433
+ # Specifies the volume type for EBS-based storage.
434
+ # @return [String]
435
+ #
436
+ # @!attribute [rw] volume_size
437
+ # Integer to specify the size of an EBS volume.
438
+ # @return [Integer]
439
+ #
440
+ # @!attribute [rw] iops
441
+ # Specifies the IOPD for a Provisioned IOPS EBS volume (SSD).
442
+ # @return [Integer]
443
+ #
444
+ class EBSOptions < Struct.new(
445
+ :ebs_enabled,
446
+ :volume_type,
447
+ :volume_size,
448
+ :iops)
449
+ include Aws::Structure
450
+ end
451
+
452
+ # Status of the EBS options for the specified Elasticsearch domain.
453
+ #
454
+ # @!attribute [rw] options
455
+ # Specifies the EBS options for the specified Elasticsearch domain.
456
+ # @return [Types::EBSOptions]
457
+ #
458
+ # @!attribute [rw] status
459
+ # Specifies the status of the EBS options for the specified
460
+ # Elasticsearch domain.
461
+ # @return [Types::OptionStatus]
462
+ #
463
+ class EBSOptionsStatus < Struct.new(
464
+ :options,
465
+ :status)
466
+ include Aws::Structure
467
+ end
468
+
469
+ # Specifies the configuration for the domain cluster, such as the type
470
+ # and number of instances.
471
+ #
472
+ # @note When making an API call, you may pass ElasticsearchClusterConfig
473
+ # data as a hash:
474
+ #
475
+ # {
476
+ # instance_type: "m3.medium.elasticsearch", # accepts m3.medium.elasticsearch, m3.large.elasticsearch, m3.xlarge.elasticsearch, m3.2xlarge.elasticsearch, m4.large.elasticsearch, m4.xlarge.elasticsearch, m4.2xlarge.elasticsearch, m4.4xlarge.elasticsearch, m4.10xlarge.elasticsearch, t2.micro.elasticsearch, t2.small.elasticsearch, t2.medium.elasticsearch, r3.large.elasticsearch, r3.xlarge.elasticsearch, r3.2xlarge.elasticsearch, r3.4xlarge.elasticsearch, r3.8xlarge.elasticsearch, i2.xlarge.elasticsearch, i2.2xlarge.elasticsearch, d2.xlarge.elasticsearch, d2.2xlarge.elasticsearch, d2.4xlarge.elasticsearch, d2.8xlarge.elasticsearch, c4.large.elasticsearch, c4.xlarge.elasticsearch, c4.2xlarge.elasticsearch, c4.4xlarge.elasticsearch, c4.8xlarge.elasticsearch, r4.large.elasticsearch, r4.xlarge.elasticsearch, r4.2xlarge.elasticsearch, r4.4xlarge.elasticsearch, r4.8xlarge.elasticsearch, r4.16xlarge.elasticsearch
477
+ # instance_count: 1,
478
+ # dedicated_master_enabled: false,
479
+ # zone_awareness_enabled: false,
480
+ # dedicated_master_type: "m3.medium.elasticsearch", # accepts m3.medium.elasticsearch, m3.large.elasticsearch, m3.xlarge.elasticsearch, m3.2xlarge.elasticsearch, m4.large.elasticsearch, m4.xlarge.elasticsearch, m4.2xlarge.elasticsearch, m4.4xlarge.elasticsearch, m4.10xlarge.elasticsearch, t2.micro.elasticsearch, t2.small.elasticsearch, t2.medium.elasticsearch, r3.large.elasticsearch, r3.xlarge.elasticsearch, r3.2xlarge.elasticsearch, r3.4xlarge.elasticsearch, r3.8xlarge.elasticsearch, i2.xlarge.elasticsearch, i2.2xlarge.elasticsearch, d2.xlarge.elasticsearch, d2.2xlarge.elasticsearch, d2.4xlarge.elasticsearch, d2.8xlarge.elasticsearch, c4.large.elasticsearch, c4.xlarge.elasticsearch, c4.2xlarge.elasticsearch, c4.4xlarge.elasticsearch, c4.8xlarge.elasticsearch, r4.large.elasticsearch, r4.xlarge.elasticsearch, r4.2xlarge.elasticsearch, r4.4xlarge.elasticsearch, r4.8xlarge.elasticsearch, r4.16xlarge.elasticsearch
481
+ # dedicated_master_count: 1,
482
+ # }
483
+ #
484
+ # @!attribute [rw] instance_type
485
+ # The instance type for an Elasticsearch cluster.
486
+ # @return [String]
487
+ #
488
+ # @!attribute [rw] instance_count
489
+ # The number of instances in the specified domain cluster.
490
+ # @return [Integer]
491
+ #
492
+ # @!attribute [rw] dedicated_master_enabled
493
+ # A boolean value to indicate whether a dedicated master node is
494
+ # enabled. See [About Dedicated Master Nodes][1] for more information.
495
+ #
496
+ #
497
+ #
498
+ # [1]: http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-managedomains.html#es-managedomains-dedicatedmasternodes
499
+ # @return [Boolean]
500
+ #
501
+ # @!attribute [rw] zone_awareness_enabled
502
+ # A boolean value to indicate whether zone awareness is enabled. See
503
+ # [About Zone Awareness][1] for more information.
504
+ #
505
+ #
506
+ #
507
+ # [1]: http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-managedomains.html#es-managedomains-zoneawareness
508
+ # @return [Boolean]
509
+ #
510
+ # @!attribute [rw] dedicated_master_type
511
+ # The instance type for a dedicated master node.
512
+ # @return [String]
513
+ #
514
+ # @!attribute [rw] dedicated_master_count
515
+ # Total number of dedicated master nodes, active and on standby, for
516
+ # the cluster.
517
+ # @return [Integer]
518
+ #
519
+ class ElasticsearchClusterConfig < Struct.new(
520
+ :instance_type,
521
+ :instance_count,
522
+ :dedicated_master_enabled,
523
+ :zone_awareness_enabled,
524
+ :dedicated_master_type,
525
+ :dedicated_master_count)
526
+ include Aws::Structure
527
+ end
528
+
529
+ # Specifies the configuration status for the specified Elasticsearch
530
+ # domain.
531
+ #
532
+ # @!attribute [rw] options
533
+ # Specifies the cluster configuration for the specified Elasticsearch
534
+ # domain.
535
+ # @return [Types::ElasticsearchClusterConfig]
536
+ #
537
+ # @!attribute [rw] status
538
+ # Specifies the status of the configuration for the specified
539
+ # Elasticsearch domain.
540
+ # @return [Types::OptionStatus]
541
+ #
542
+ class ElasticsearchClusterConfigStatus < Struct.new(
543
+ :options,
544
+ :status)
545
+ include Aws::Structure
546
+ end
547
+
548
+ # The configuration of an Elasticsearch domain.
549
+ #
550
+ # @!attribute [rw] elasticsearch_version
551
+ # String of format X.Y to specify version for the Elasticsearch
552
+ # domain.
553
+ # @return [Types::ElasticsearchVersionStatus]
554
+ #
555
+ # @!attribute [rw] elasticsearch_cluster_config
556
+ # Specifies the `ElasticsearchClusterConfig` for the Elasticsearch
557
+ # domain.
558
+ # @return [Types::ElasticsearchClusterConfigStatus]
559
+ #
560
+ # @!attribute [rw] ebs_options
561
+ # Specifies the `EBSOptions` for the Elasticsearch domain.
562
+ # @return [Types::EBSOptionsStatus]
563
+ #
564
+ # @!attribute [rw] access_policies
565
+ # IAM access policy as a JSON-formatted string.
566
+ # @return [Types::AccessPoliciesStatus]
567
+ #
568
+ # @!attribute [rw] snapshot_options
569
+ # Specifies the `SnapshotOptions` for the Elasticsearch domain.
570
+ # @return [Types::SnapshotOptionsStatus]
571
+ #
572
+ # @!attribute [rw] advanced_options
573
+ # Specifies the `AdvancedOptions` for the domain. See [Configuring
574
+ # Advanced Options][1] for more information.
575
+ #
576
+ #
577
+ #
578
+ # [1]: http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options
579
+ # @return [Types::AdvancedOptionsStatus]
580
+ #
581
+ class ElasticsearchDomainConfig < Struct.new(
582
+ :elasticsearch_version,
583
+ :elasticsearch_cluster_config,
584
+ :ebs_options,
585
+ :access_policies,
586
+ :snapshot_options,
587
+ :advanced_options)
588
+ include Aws::Structure
589
+ end
590
+
591
+ # The current status of an Elasticsearch domain.
592
+ #
593
+ # @!attribute [rw] domain_id
594
+ # The unique identifier for the specified Elasticsearch domain.
595
+ # @return [String]
596
+ #
597
+ # @!attribute [rw] domain_name
598
+ # The name of an Elasticsearch domain. Domain names are unique across
599
+ # the domains owned by an account within an AWS region. Domain names
600
+ # start with a letter or number and can contain the following
601
+ # characters: a-z (lowercase), 0-9, and - (hyphen).
602
+ # @return [String]
603
+ #
604
+ # @!attribute [rw] arn
605
+ # The Amazon resource name (ARN) of an Elasticsearch domain. See
606
+ # [Identifiers for IAM Entities][1] in *Using AWS Identity and Access
607
+ # Management* for more information.
608
+ #
609
+ #
610
+ #
611
+ # [1]: http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html
612
+ # @return [String]
613
+ #
614
+ # @!attribute [rw] created
615
+ # The domain creation status. `True` if the creation of an
616
+ # Elasticsearch domain is complete. `False` if domain creation is
617
+ # still in progress.
618
+ # @return [Boolean]
619
+ #
620
+ # @!attribute [rw] deleted
621
+ # The domain deletion status. `True` if a delete request has been
622
+ # received for the domain but resource cleanup is still in progress.
623
+ # `False` if the domain has not been deleted. Once domain deletion is
624
+ # complete, the status of the domain is no longer returned.
625
+ # @return [Boolean]
626
+ #
627
+ # @!attribute [rw] endpoint
628
+ # The Elasticsearch domain endpoint that you use to submit index and
629
+ # search requests.
630
+ # @return [String]
631
+ #
632
+ # @!attribute [rw] processing
633
+ # The status of the Elasticsearch domain configuration. `True` if
634
+ # Amazon Elasticsearch Service is processing configuration changes.
635
+ # `False` if the configuration is active.
636
+ # @return [Boolean]
637
+ #
638
+ # @!attribute [rw] elasticsearch_version
639
+ # @return [String]
640
+ #
641
+ # @!attribute [rw] elasticsearch_cluster_config
642
+ # The type and number of instances in the domain cluster.
643
+ # @return [Types::ElasticsearchClusterConfig]
644
+ #
645
+ # @!attribute [rw] ebs_options
646
+ # The `EBSOptions` for the specified domain. See [Configuring
647
+ # EBS-based Storage][1] for more information.
648
+ #
649
+ #
650
+ #
651
+ # [1]: http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-ebs
652
+ # @return [Types::EBSOptions]
653
+ #
654
+ # @!attribute [rw] access_policies
655
+ # IAM access policy as a JSON-formatted string.
656
+ # @return [String]
657
+ #
658
+ # @!attribute [rw] snapshot_options
659
+ # Specifies the status of the `SnapshotOptions`
660
+ # @return [Types::SnapshotOptions]
661
+ #
662
+ # @!attribute [rw] advanced_options
663
+ # Specifies the status of the `AdvancedOptions`
664
+ # @return [Hash<String,String>]
665
+ #
666
+ class ElasticsearchDomainStatus < Struct.new(
667
+ :domain_id,
668
+ :domain_name,
669
+ :arn,
670
+ :created,
671
+ :deleted,
672
+ :endpoint,
673
+ :processing,
674
+ :elasticsearch_version,
675
+ :elasticsearch_cluster_config,
676
+ :ebs_options,
677
+ :access_policies,
678
+ :snapshot_options,
679
+ :advanced_options)
680
+ include Aws::Structure
681
+ end
682
+
683
+ # Status of the Elasticsearch version options for the specified
684
+ # Elasticsearch domain.
685
+ #
686
+ # @!attribute [rw] options
687
+ # Specifies the Elasticsearch version for the specified Elasticsearch
688
+ # domain.
689
+ # @return [String]
690
+ #
691
+ # @!attribute [rw] status
692
+ # Specifies the status of the Elasticsearch version options for the
693
+ # specified Elasticsearch domain.
694
+ # @return [Types::OptionStatus]
695
+ #
696
+ class ElasticsearchVersionStatus < Struct.new(
697
+ :options,
698
+ :status)
699
+ include Aws::Structure
700
+ end
701
+
702
+ # InstanceCountLimits represents the limits on number of instances that
703
+ # be created in Amazon Elasticsearch for given InstanceType.
704
+ #
705
+ # @!attribute [rw] minimum_instance_count
706
+ # Minimum number of Instances that can be instantiated for given
707
+ # InstanceType.
708
+ # @return [Integer]
709
+ #
710
+ # @!attribute [rw] maximum_instance_count
711
+ # Maximum number of Instances that can be instantiated for given
712
+ # InstanceType.
713
+ # @return [Integer]
714
+ #
715
+ class InstanceCountLimits < Struct.new(
716
+ :minimum_instance_count,
717
+ :maximum_instance_count)
718
+ include Aws::Structure
719
+ end
720
+
721
+ # InstanceLimits represents the list of instance related attributes that
722
+ # are available for given InstanceType.
723
+ #
724
+ # @!attribute [rw] instance_count_limits
725
+ # InstanceCountLimits represents the limits on number of instances
726
+ # that be created in Amazon Elasticsearch for given InstanceType.
727
+ # @return [Types::InstanceCountLimits]
728
+ #
729
+ class InstanceLimits < Struct.new(
730
+ :instance_count_limits)
731
+ include Aws::Structure
732
+ end
733
+
734
+ # Limits for given InstanceType and for each of it's role.
735
+ # Limits contains following ` StorageTypes, ` ` InstanceLimits ` and `
736
+ # AdditionalLimits `
737
+ #
738
+ # @!attribute [rw] storage_types
739
+ # StorageType represents the list of storage related types and
740
+ # attributes that are available for given InstanceType.
741
+ # @return [Array<Types::StorageType>]
742
+ #
743
+ # @!attribute [rw] instance_limits
744
+ # InstanceLimits represents the list of instance related attributes
745
+ # that are available for given InstanceType.
746
+ # @return [Types::InstanceLimits]
747
+ #
748
+ # @!attribute [rw] additional_limits
749
+ # List of additional limits that are specific to a given InstanceType
750
+ # and for each of it's ` InstanceRole ` .
751
+ # @return [Array<Types::AdditionalLimit>]
752
+ #
753
+ class Limits < Struct.new(
754
+ :storage_types,
755
+ :instance_limits,
756
+ :additional_limits)
757
+ include Aws::Structure
758
+ end
759
+
760
+ # The result of a `ListDomainNames` operation. Contains the names of all
761
+ # Elasticsearch domains owned by this account.
762
+ #
763
+ # @!attribute [rw] domain_names
764
+ # List of Elasticsearch domain names.
765
+ # @return [Array<Types::DomainInfo>]
766
+ #
767
+ class ListDomainNamesResponse < Struct.new(
768
+ :domain_names)
769
+ include Aws::Structure
770
+ end
771
+
772
+ # Container for the parameters to the ` ListElasticsearchInstanceTypes `
773
+ # operation.
774
+ #
775
+ # @note When making an API call, you may pass ListElasticsearchInstanceTypesRequest
776
+ # data as a hash:
777
+ #
778
+ # {
779
+ # elasticsearch_version: "ElasticsearchVersionString", # required
780
+ # domain_name: "DomainName",
781
+ # max_results: 1,
782
+ # next_token: "NextToken",
783
+ # }
784
+ #
785
+ # @!attribute [rw] elasticsearch_version
786
+ # Version of Elasticsearch for which list of supported elasticsearch
787
+ # instance types are needed.
788
+ # @return [String]
789
+ #
790
+ # @!attribute [rw] domain_name
791
+ # DomainName represents the name of the Domain that we are trying to
792
+ # modify. This should be present only if we are querying for list of
793
+ # available Elasticsearch instance types when modifying existing
794
+ # domain.
795
+ # @return [String]
796
+ #
797
+ # @!attribute [rw] max_results
798
+ # Set this value to limit the number of results returned. Value
799
+ # provided must be greater than 30 else it wont be honored.
800
+ # @return [Integer]
801
+ #
802
+ # @!attribute [rw] next_token
803
+ # NextToken should be sent in case if earlier API call produced result
804
+ # containing NextToken. It is used for pagination.
805
+ # @return [String]
806
+ #
807
+ class ListElasticsearchInstanceTypesRequest < Struct.new(
808
+ :elasticsearch_version,
809
+ :domain_name,
810
+ :max_results,
811
+ :next_token)
812
+ include Aws::Structure
813
+ end
814
+
815
+ # Container for the parameters returned by `
816
+ # ListElasticsearchInstanceTypes ` operation.
817
+ #
818
+ # @!attribute [rw] elasticsearch_instance_types
819
+ # List of instance types supported by Amazon Elasticsearch service for
820
+ # given ` ElasticsearchVersion `
821
+ # @return [Array<String>]
822
+ #
823
+ # @!attribute [rw] next_token
824
+ # In case if there are more results available NextToken would be
825
+ # present, make further request to the same API with received
826
+ # NextToken to paginate remaining results.
827
+ # @return [String]
828
+ #
829
+ class ListElasticsearchInstanceTypesResponse < Struct.new(
830
+ :elasticsearch_instance_types,
831
+ :next_token)
832
+ include Aws::Structure
833
+ end
834
+
835
+ # Container for the parameters to the ` ListElasticsearchVersions `
836
+ # operation. Use ` MaxResults ` to control the maximum number of results
837
+ # to
838
+ # retrieve in a single call.
839
+ #
840
+ # Use ` NextToken ` in response to retrieve more results. If the
841
+ # received response does not contain a NextToken, then there are no more
842
+ # results to retrieve.
843
+ #
844
+ # @note When making an API call, you may pass ListElasticsearchVersionsRequest
845
+ # data as a hash:
846
+ #
847
+ # {
848
+ # max_results: 1,
849
+ # next_token: "NextToken",
850
+ # }
851
+ #
852
+ # @!attribute [rw] max_results
853
+ # Set this value to limit the number of results returned. Value
854
+ # provided must be greater than 10 else it wont be honored.
855
+ # @return [Integer]
856
+ #
857
+ # @!attribute [rw] next_token
858
+ # Paginated APIs accepts NextToken input to returns next page results
859
+ # and provides a NextToken output in the response which can be used by
860
+ # the client to retrieve more results.
861
+ # @return [String]
862
+ #
863
+ class ListElasticsearchVersionsRequest < Struct.new(
864
+ :max_results,
865
+ :next_token)
866
+ include Aws::Structure
867
+ end
868
+
869
+ # Container for the parameters for response received from `
870
+ # ListElasticsearchVersions ` operation.
871
+ #
872
+ # @!attribute [rw] elasticsearch_versions
873
+ # List of supported elastic search versions.
874
+ # @return [Array<String>]
875
+ #
876
+ # @!attribute [rw] next_token
877
+ # Paginated APIs accepts NextToken input to returns next page results
878
+ # and provides a NextToken output in the response which can be used by
879
+ # the client to retrieve more results.
880
+ # @return [String]
881
+ #
882
+ class ListElasticsearchVersionsResponse < Struct.new(
883
+ :elasticsearch_versions,
884
+ :next_token)
885
+ include Aws::Structure
886
+ end
887
+
888
+ # Container for the parameters to the `ListTags` operation. Specify the
889
+ # `ARN` for the Elasticsearch domain to which the tags are attached that
890
+ # you want to view are attached.
891
+ #
892
+ # @note When making an API call, you may pass ListTagsRequest
893
+ # data as a hash:
894
+ #
895
+ # {
896
+ # arn: "ARN", # required
897
+ # }
898
+ #
899
+ # @!attribute [rw] arn
900
+ # Specify the `ARN` for the Elasticsearch domain to which the tags are
901
+ # attached that you want to view.
902
+ # @return [String]
903
+ #
904
+ class ListTagsRequest < Struct.new(
905
+ :arn)
906
+ include Aws::Structure
907
+ end
908
+
909
+ # The result of a `ListTags` operation. Contains tags for all requested
910
+ # Elasticsearch domains.
911
+ #
912
+ # @!attribute [rw] tag_list
913
+ # List of `Tag` for the requested Elasticsearch domain.
914
+ # @return [Array<Types::Tag>]
915
+ #
916
+ class ListTagsResponse < Struct.new(
917
+ :tag_list)
918
+ include Aws::Structure
919
+ end
920
+
921
+ # Provides the current status of the entity.
922
+ #
923
+ # @!attribute [rw] creation_date
924
+ # Timestamp which tells the creation date for the entity.
925
+ # @return [Time]
926
+ #
927
+ # @!attribute [rw] update_date
928
+ # Timestamp which tells the last updated time for the entity.
929
+ # @return [Time]
930
+ #
931
+ # @!attribute [rw] update_version
932
+ # Specifies the latest version for the entity.
933
+ # @return [Integer]
934
+ #
935
+ # @!attribute [rw] state
936
+ # Provides the `OptionState` for the Elasticsearch domain.
937
+ # @return [String]
938
+ #
939
+ # @!attribute [rw] pending_deletion
940
+ # Indicates whether the Elasticsearch domain is being deleted.
941
+ # @return [Boolean]
942
+ #
943
+ class OptionStatus < Struct.new(
944
+ :creation_date,
945
+ :update_date,
946
+ :update_version,
947
+ :state,
948
+ :pending_deletion)
949
+ include Aws::Structure
950
+ end
951
+
952
+ # Container for the parameters to the `RemoveTags` operation. Specify
953
+ # the `ARN` for the Elasticsearch domain from which you want to remove
954
+ # the specified `TagKey`.
955
+ #
956
+ # @note When making an API call, you may pass RemoveTagsRequest
957
+ # data as a hash:
958
+ #
959
+ # {
960
+ # arn: "ARN", # required
961
+ # tag_keys: ["String"], # required
962
+ # }
963
+ #
964
+ # @!attribute [rw] arn
965
+ # Specifies the `ARN` for the Elasticsearch domain from which you want
966
+ # to delete the specified tags.
967
+ # @return [String]
968
+ #
969
+ # @!attribute [rw] tag_keys
970
+ # Specifies the `TagKey` list which you want to remove from the
971
+ # Elasticsearch domain.
972
+ # @return [Array<String>]
973
+ #
974
+ class RemoveTagsRequest < Struct.new(
975
+ :arn,
976
+ :tag_keys)
977
+ include Aws::Structure
978
+ end
979
+
980
+ # Specifies the time, in UTC format, when the service takes a daily
981
+ # automated snapshot of the specified Elasticsearch domain. Default
982
+ # value is `0` hours.
983
+ #
984
+ # @note When making an API call, you may pass SnapshotOptions
985
+ # data as a hash:
986
+ #
987
+ # {
988
+ # automated_snapshot_start_hour: 1,
989
+ # }
990
+ #
991
+ # @!attribute [rw] automated_snapshot_start_hour
992
+ # Specifies the time, in UTC format, when the service takes a daily
993
+ # automated snapshot of the specified Elasticsearch domain. Default
994
+ # value is `0` hours.
995
+ # @return [Integer]
996
+ #
997
+ class SnapshotOptions < Struct.new(
998
+ :automated_snapshot_start_hour)
999
+ include Aws::Structure
1000
+ end
1001
+
1002
+ # Status of a daily automated snapshot.
1003
+ #
1004
+ # @!attribute [rw] options
1005
+ # Specifies the daily snapshot options specified for the Elasticsearch
1006
+ # domain.
1007
+ # @return [Types::SnapshotOptions]
1008
+ #
1009
+ # @!attribute [rw] status
1010
+ # Specifies the status of a daily automated snapshot.
1011
+ # @return [Types::OptionStatus]
1012
+ #
1013
+ class SnapshotOptionsStatus < Struct.new(
1014
+ :options,
1015
+ :status)
1016
+ include Aws::Structure
1017
+ end
1018
+
1019
+ # StorageTypes represents the list of storage related types and their
1020
+ # attributes that are available for given InstanceType.
1021
+ #
1022
+ # @!attribute [rw] storage_type_name
1023
+ # Type of the storage. List of available storage options: 1. instance
1024
+ # 2. ebs
1025
+ # @return [String]
1026
+ #
1027
+ # @!attribute [rw] storage_sub_type_name
1028
+ # SubType of the given storage type. List of available sub-storage
1029
+ # options: For "instance" storageType we wont have any
1030
+ # storageSubType, in case of "ebs" storageType we will have
1031
+ # following valid storageSubTypes 1. standard
1032
+ # 2. gp2
1033
+ # 3. io1
1034
+ #
1035
+ # Refer `VolumeType` for more information regarding above EBS storage
1036
+ # options.
1037
+ # @return [String]
1038
+ #
1039
+ # @!attribute [rw] storage_type_limits
1040
+ # List of limits that are applicable for given storage type.
1041
+ # @return [Array<Types::StorageTypeLimit>]
1042
+ #
1043
+ class StorageType < Struct.new(
1044
+ :storage_type_name,
1045
+ :storage_sub_type_name,
1046
+ :storage_type_limits)
1047
+ include Aws::Structure
1048
+ end
1049
+
1050
+ # Limits that are applicable for given storage type.
1051
+ #
1052
+ # @!attribute [rw] limit_name
1053
+ # Name of storage limits that are applicable for given storage type.
1054
+ # If ` StorageType ` is ebs, following storage options are applicable
1055
+ # 1. MinimumVolumeSize
1056
+ # 2. MaximumVolumeSize
1057
+ # 3. MaximumIops
1058
+ # 4. MinimumIops
1059
+ # @return [String]
1060
+ #
1061
+ # @!attribute [rw] limit_values
1062
+ # Values for the ` StorageTypeLimit$LimitName ` .
1063
+ # @return [Array<String>]
1064
+ #
1065
+ class StorageTypeLimit < Struct.new(
1066
+ :limit_name,
1067
+ :limit_values)
1068
+ include Aws::Structure
1069
+ end
1070
+
1071
+ # Specifies a key value pair for a resource tag.
1072
+ #
1073
+ # @note When making an API call, you may pass Tag
1074
+ # data as a hash:
1075
+ #
1076
+ # {
1077
+ # key: "TagKey", # required
1078
+ # value: "TagValue", # required
1079
+ # }
1080
+ #
1081
+ # @!attribute [rw] key
1082
+ # Specifies the `TagKey`, the name of the tag. Tag keys must be unique
1083
+ # for the Elasticsearch domain to which they are attached.
1084
+ # @return [String]
1085
+ #
1086
+ # @!attribute [rw] value
1087
+ # Specifies the `TagValue`, the value assigned to the corresponding
1088
+ # tag key. Tag values can be null and do not have to be unique in a
1089
+ # tag set. For example, you can have a key value pair in a tag set of
1090
+ # `project : Trinity` and `cost-center : Trinity`
1091
+ # @return [String]
1092
+ #
1093
+ class Tag < Struct.new(
1094
+ :key,
1095
+ :value)
1096
+ include Aws::Structure
1097
+ end
1098
+
1099
+ # Container for the parameters to the `UpdateElasticsearchDomain`
1100
+ # operation. Specifies the type and number of instances in the domain
1101
+ # cluster.
1102
+ #
1103
+ # @note When making an API call, you may pass UpdateElasticsearchDomainConfigRequest
1104
+ # data as a hash:
1105
+ #
1106
+ # {
1107
+ # domain_name: "DomainName", # required
1108
+ # elasticsearch_cluster_config: {
1109
+ # instance_type: "m3.medium.elasticsearch", # accepts m3.medium.elasticsearch, m3.large.elasticsearch, m3.xlarge.elasticsearch, m3.2xlarge.elasticsearch, m4.large.elasticsearch, m4.xlarge.elasticsearch, m4.2xlarge.elasticsearch, m4.4xlarge.elasticsearch, m4.10xlarge.elasticsearch, t2.micro.elasticsearch, t2.small.elasticsearch, t2.medium.elasticsearch, r3.large.elasticsearch, r3.xlarge.elasticsearch, r3.2xlarge.elasticsearch, r3.4xlarge.elasticsearch, r3.8xlarge.elasticsearch, i2.xlarge.elasticsearch, i2.2xlarge.elasticsearch, d2.xlarge.elasticsearch, d2.2xlarge.elasticsearch, d2.4xlarge.elasticsearch, d2.8xlarge.elasticsearch, c4.large.elasticsearch, c4.xlarge.elasticsearch, c4.2xlarge.elasticsearch, c4.4xlarge.elasticsearch, c4.8xlarge.elasticsearch, r4.large.elasticsearch, r4.xlarge.elasticsearch, r4.2xlarge.elasticsearch, r4.4xlarge.elasticsearch, r4.8xlarge.elasticsearch, r4.16xlarge.elasticsearch
1110
+ # instance_count: 1,
1111
+ # dedicated_master_enabled: false,
1112
+ # zone_awareness_enabled: false,
1113
+ # dedicated_master_type: "m3.medium.elasticsearch", # accepts m3.medium.elasticsearch, m3.large.elasticsearch, m3.xlarge.elasticsearch, m3.2xlarge.elasticsearch, m4.large.elasticsearch, m4.xlarge.elasticsearch, m4.2xlarge.elasticsearch, m4.4xlarge.elasticsearch, m4.10xlarge.elasticsearch, t2.micro.elasticsearch, t2.small.elasticsearch, t2.medium.elasticsearch, r3.large.elasticsearch, r3.xlarge.elasticsearch, r3.2xlarge.elasticsearch, r3.4xlarge.elasticsearch, r3.8xlarge.elasticsearch, i2.xlarge.elasticsearch, i2.2xlarge.elasticsearch, d2.xlarge.elasticsearch, d2.2xlarge.elasticsearch, d2.4xlarge.elasticsearch, d2.8xlarge.elasticsearch, c4.large.elasticsearch, c4.xlarge.elasticsearch, c4.2xlarge.elasticsearch, c4.4xlarge.elasticsearch, c4.8xlarge.elasticsearch, r4.large.elasticsearch, r4.xlarge.elasticsearch, r4.2xlarge.elasticsearch, r4.4xlarge.elasticsearch, r4.8xlarge.elasticsearch, r4.16xlarge.elasticsearch
1114
+ # dedicated_master_count: 1,
1115
+ # },
1116
+ # ebs_options: {
1117
+ # ebs_enabled: false,
1118
+ # volume_type: "standard", # accepts standard, gp2, io1
1119
+ # volume_size: 1,
1120
+ # iops: 1,
1121
+ # },
1122
+ # snapshot_options: {
1123
+ # automated_snapshot_start_hour: 1,
1124
+ # },
1125
+ # advanced_options: {
1126
+ # "String" => "String",
1127
+ # },
1128
+ # access_policies: "PolicyDocument",
1129
+ # }
1130
+ #
1131
+ # @!attribute [rw] domain_name
1132
+ # The name of the Elasticsearch domain that you are updating.
1133
+ # @return [String]
1134
+ #
1135
+ # @!attribute [rw] elasticsearch_cluster_config
1136
+ # The type and number of instances to instantiate for the domain
1137
+ # cluster.
1138
+ # @return [Types::ElasticsearchClusterConfig]
1139
+ #
1140
+ # @!attribute [rw] ebs_options
1141
+ # Specify the type and size of the EBS volume that you want to use.
1142
+ # @return [Types::EBSOptions]
1143
+ #
1144
+ # @!attribute [rw] snapshot_options
1145
+ # Option to set the time, in UTC format, for the daily automated
1146
+ # snapshot. Default value is `0` hours.
1147
+ # @return [Types::SnapshotOptions]
1148
+ #
1149
+ # @!attribute [rw] advanced_options
1150
+ # Modifies the advanced option to allow references to indices in an
1151
+ # HTTP request body. Must be `false` when configuring access to
1152
+ # individual sub-resources. By default, the value is `true`. See
1153
+ # [Configuration Advanced Options][1] for more information.
1154
+ #
1155
+ #
1156
+ #
1157
+ # [1]: http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-advanced-options
1158
+ # @return [Hash<String,String>]
1159
+ #
1160
+ # @!attribute [rw] access_policies
1161
+ # IAM access policy as a JSON-formatted string.
1162
+ # @return [String]
1163
+ #
1164
+ class UpdateElasticsearchDomainConfigRequest < Struct.new(
1165
+ :domain_name,
1166
+ :elasticsearch_cluster_config,
1167
+ :ebs_options,
1168
+ :snapshot_options,
1169
+ :advanced_options,
1170
+ :access_policies)
1171
+ include Aws::Structure
1172
+ end
1173
+
1174
+ # The result of an `UpdateElasticsearchDomain` request. Contains the
1175
+ # status of the Elasticsearch domain being updated.
1176
+ #
1177
+ # @!attribute [rw] domain_config
1178
+ # The status of the updated Elasticsearch domain.
1179
+ # @return [Types::ElasticsearchDomainConfig]
1180
+ #
1181
+ class UpdateElasticsearchDomainConfigResponse < Struct.new(
1182
+ :domain_config)
1183
+ include Aws::Structure
1184
+ end
1185
+
817
1186
  end
818
1187
  end